Skip to content
This repository was archived by the owner on Jun 4, 2026. It is now read-only.

Commit 527f788

Browse files
authored
Merge pull request #165 from contentstack/fix/DX-5352
DX - 5352 - Added Skill Files and dependency updates
2 parents 6181c29 + 4fc5f2f commit 527f788

10 files changed

Lines changed: 613 additions & 301 deletions

File tree

.cursor/rules/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Cursor (optional)
2+
3+
**Cursor** users: start at **[`AGENTS.md`](../../AGENTS.md)**. All conventions live in **`skills/*/SKILL.md`**.
4+
5+
This folder only points contributors to **`AGENTS.md`** so editor-specific config does not duplicate the canonical docs.
6+
7+
Path from this file to the repo root agent guide: **`../../AGENTS.md`** (two levels up from `.cursor/rules/`).

.talismanrc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
fileignoreconfig:
2-
- filename: package-lock.json
3-
checksum: 98330174c261d1793f7e44c1889aea8c6bc1f6dfaa9a5cb4f58ad2c402f4db06
2+
- filename: skills/dev-workflow/SKILL.md
3+
checksum: bbe23955b8865b7b44e8adaf414dce2b0127921ed1e35488adf470fdd833270f
4+
- filename: package-lock.json
5+
checksum: 31cf2fecced45ffd2db8b1f7c5258d1c98c2d0be7dd443460cfc070558a85c82
6+
- filename: skills/contentstack-cli/SKILL.md
7+
checksum: cd7046bfdace6bb82ff6168663f05b0a641e615d61167412d0a4c724c3d18209
8+
- filename: skills/code-review/SKILL.md
9+
checksum: f4fb9f63b97acf35845f31577840050af6c4f960dc6522477e31decc0b866313
10+
411
version: ""

AGENTS.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# cli-cm-regex-validate – Agent guide
2+
3+
**Universal entry point** for contributors and AI agents. Detailed conventions live in **`skills/*/SKILL.md`**.
4+
5+
## What this repo is
6+
7+
| Field | Detail |
8+
|-------|--------|
9+
| **Name:** | [contentstack/cli-cm-regex-validate](https://github.com/contentstack/cli-cm-regex-validate) (`@contentstack/cli-cm-regex-validate` on npm) |
10+
| **Purpose:** | Contentstack CLI oclif plugin with a single command, **`csdx cm:stacks:validate-regex`**, which scans content types and/or global fields in a stack for regex `format` values that fail the `safe-regex` check, then writes results to CSV and prints a summary table. User-facing copy lives in `messages/index.json`. |
11+
| **Out of scope (if any):** | Not a general-purpose Contentstack SDK — only this plugin’s command, utils, and tests. |
12+
13+
## Tech stack (at a glance)
14+
15+
| Area | Details |
16+
|------|---------|
17+
| Language | TypeScript (`strict`), Node `>=14.0.0` per `package.json` engines |
18+
| Build | npm; `prepack` runs `tsc -b`, oclif manifest, oclif readme — see `package.json` |
19+
| Tests | Jest + ts-jest (`jest.config.ts`), `npm test`; suites under `test/utils/`, fixtures `test/data/*.json` |
20+
| Lint / coverage | ESLint (`.eslintrc`), `npm run posttest` |
21+
| Other | oclif v3, `@contentstack/cli-command`; CI: Node 22.x — [`.github/workflows/unit-tests.yml`](.github/workflows/unit-tests.yml). **CI runs Jest only** (`npm run test`); **ESLint is not run in CI** — run `npm run posttest` locally before merge. |
22+
23+
## Commands (quick reference)
24+
25+
| Command type | Command |
26+
|--------------|---------|
27+
| Build (release prep) | `npm run prepack` — cleans `lib`, compiles, generates oclif manifest and readme |
28+
| Test | `npm test` |
29+
| Lint | `npm run posttest` |
30+
31+
CI runs `npm i` and `npm run test` on pull requests — see [`.github/workflows/unit-tests.yml`](.github/workflows/unit-tests.yml). It does **not** run `npm run posttest` (ESLint); run lint locally before merging.
32+
33+
## Where the documentation lives: skills
34+
35+
| Skill | Path | What it covers |
36+
|-------|------|----------------|
37+
| Development workflow | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Commands, repo layout, naming, hooks, TDD, before merge |
38+
| Testing | [`skills/testing/SKILL.md`](skills/testing/SKILL.md) | Jest, mocks, fixtures, no live API calls |
39+
| Contentstack CLI | [`skills/contentstack-cli/SKILL.md`](skills/contentstack-cli/SKILL.md) | Command flow, SDK, schema walk, `safe-regex`, CSV/table output |
40+
| Code review | [`skills/code-review/SKILL.md`](skills/code-review/SKILL.md) | PR and release checklist |
41+
42+
An index with “when to use” hints is in [`skills/README.md`](skills/README.md).
43+
44+
## Using Cursor (optional)
45+
46+
If you use **Cursor**, [`.cursor/rules/README.md`](.cursor/rules/README.md) only points to **[`AGENTS.md`](AGENTS.md)** — same docs as everyone else.

0 commit comments

Comments
 (0)