Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .cursor/rules/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Cursor (optional)

**Cursor** users: start at **[`AGENTS.md`](../../AGENTS.md)**. All conventions live in **`skills/*/SKILL.md`**.

This folder only points contributors to **`AGENTS.md`** so editor-specific config does not duplicate the canonical docs.

Path from this file to the repo root agent guide: **`../../AGENTS.md`** (two levels up from `.cursor/rules/`).
11 changes: 9 additions & 2 deletions .talismanrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
fileignoreconfig:
- filename: package-lock.json
checksum: 98330174c261d1793f7e44c1889aea8c6bc1f6dfaa9a5cb4f58ad2c402f4db06
- filename: skills/dev-workflow/SKILL.md
checksum: bbe23955b8865b7b44e8adaf414dce2b0127921ed1e35488adf470fdd833270f
- filename: package-lock.json
checksum: 31cf2fecced45ffd2db8b1f7c5258d1c98c2d0be7dd443460cfc070558a85c82
- filename: skills/contentstack-cli/SKILL.md
checksum: cd7046bfdace6bb82ff6168663f05b0a641e615d61167412d0a4c724c3d18209
- filename: skills/code-review/SKILL.md
checksum: f4fb9f63b97acf35845f31577840050af6c4f960dc6522477e31decc0b866313

version: ""
46 changes: 46 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# cli-cm-regex-validate – Agent guide

**Universal entry point** for contributors and AI agents. Detailed conventions live in **`skills/*/SKILL.md`**.

## What this repo is

| Field | Detail |
|-------|--------|
| **Name:** | [contentstack/cli-cm-regex-validate](https://github.com/contentstack/cli-cm-regex-validate) (`@contentstack/cli-cm-regex-validate` on npm) |
| **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`. |
| **Out of scope (if any):** | Not a general-purpose Contentstack SDK — only this plugin’s command, utils, and tests. |

## Tech stack (at a glance)

| Area | Details |
|------|---------|
| Language | TypeScript (`strict`), Node `>=14.0.0` per `package.json` engines |
| Build | npm; `prepack` runs `tsc -b`, oclif manifest, oclif readme — see `package.json` |
| Tests | Jest + ts-jest (`jest.config.ts`), `npm test`; suites under `test/utils/`, fixtures `test/data/*.json` |
| Lint / coverage | ESLint (`.eslintrc`), `npm run posttest` |
| 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. |

## Commands (quick reference)

| Command type | Command |
|--------------|---------|
| Build (release prep) | `npm run prepack` — cleans `lib`, compiles, generates oclif manifest and readme |
| Test | `npm test` |
| Lint | `npm run posttest` |

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.

## Where the documentation lives: skills

| Skill | Path | What it covers |
|-------|------|----------------|
| Development workflow | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Commands, repo layout, naming, hooks, TDD, before merge |
| Testing | [`skills/testing/SKILL.md`](skills/testing/SKILL.md) | Jest, mocks, fixtures, no live API calls |
| Contentstack CLI | [`skills/contentstack-cli/SKILL.md`](skills/contentstack-cli/SKILL.md) | Command flow, SDK, schema walk, `safe-regex`, CSV/table output |
| Code review | [`skills/code-review/SKILL.md`](skills/code-review/SKILL.md) | PR and release checklist |

An index with “when to use” hints is in [`skills/README.md`](skills/README.md).

## Using Cursor (optional)

If you use **Cursor**, [`.cursor/rules/README.md`](.cursor/rules/README.md) only points to **[`AGENTS.md`](AGENTS.md)** — same docs as everyone else.
Loading
Loading