Skip to content
Open
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
26 changes: 3 additions & 23 deletions .cursor/rules/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,5 @@
# Cursor rules
# Cursor (optional)

Rules give context-aware guidance for this **Contentstack query-export CLI plugin** (`@contentstack/cli-cm-export-query`).
**Cursor** users: start at **[AGENTS.md](../../AGENTS.md)**. All conventions live in **`skills/*/SKILL.md`**.

## Rules overview

| File | Purpose |
|------|---------|
| `dev-workflow.md` | TDD, structure, validation commands (always applied) |
| `typescript.mdc` | TypeScript style and naming |
| `contentstack-cli.mdc` | Contentstack CLI utilities, export flow, API habits |
| `testing.mdc` | Mocha/Chai/Sinon and coverage |
| `oclif-commands.mdc` | Command flag and delegation patterns |

## How they attach

- **Always**: `dev-workflow.md`
- **TypeScript**: `typescript.mdc`
- **Commands** (`src/commands/**`): `oclif-commands.mdc` + `typescript.mdc`
- **Core / utils** (`src/core/**`, `src/utils/**`, `src/types/**`): `contentstack-cli.mdc` + `typescript.mdc`
- **Tests** (`test/**`): `testing.mdc` + domain rules as needed

## Chat shortcuts

You can `@`-mention rule topics (for example TypeScript or testing) depending on how your workspace maps rule names.
This folder only points contributors to **`AGENTS.md`** so editor-specific config does not duplicate the canonical docs.
39 changes: 0 additions & 39 deletions .cursor/rules/contentstack-cli.mdc

This file was deleted.

70 changes: 0 additions & 70 deletions .cursor/rules/dev-workflow.md

This file was deleted.

45 changes: 0 additions & 45 deletions .cursor/rules/oclif-commands.mdc

This file was deleted.

66 changes: 0 additions & 66 deletions .cursor/rules/testing.mdc

This file was deleted.

49 changes: 0 additions & 49 deletions .cursor/rules/typescript.mdc

This file was deleted.

5 changes: 0 additions & 5 deletions .cursor/skills/SKILL.md

This file was deleted.

12 changes: 11 additions & 1 deletion .talismanrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
fileignoreconfig:
- filename: package-lock.json
checksum: 30fe4f8843bd6518638dab4c903c8dba58e9040bfce658d1678111cec5844f70
checksum: b4f6e41c55c3c7fa9d8b7ea903eb9bc85f27464306a428c97b7e96e86ffce5f7
- filename: skills/testing/SKILL.md
checksum: da9831797a5e6a4d2e6e846c3f6d2583d84008d2dfd454dd7effe2f897c43a7b
- filename: skills/framework/SKILL.md
checksum: 217cf9123bf9b62a4d9b0c891af8ba388173c601c782ed0fea432f6be7ef5e56
- filename: skills/contentstack-cli/SKILL.md
checksum: b42e3526fb902a31080824b776cc8e233646139ee0915d89c0925744d56d586f
- filename: skills/code-review/SKILL.md
checksum: 687efb830fb4a9fb2b2e6682db052771706ddd9b12dc9cec04943e3cade929b3
- filename: skills/dev-workflow/SKILL.md
checksum: 03434201e3aaaa9239aff2f97826d64ac4ca31467b77c07330ac4b608ee24939
version: '1.0'
45 changes: 45 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# CLI export-query plugin – 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-export-query` ([repository](https://github.com/contentstack/cli)) |
| **Purpose:** | OCLIF plugin for **query-based** stack export (`cm:stacks:export-query` / short `EXPRTQRY`); implements `QueryExporter` and related export flow. |
| **Out of scope (if any):** | Other export/import plugins live in sibling packages; this repo is only the query-export plugin. |

## Tech stack (at a glance)

| Area | Details |
| --- | --- |
| **Language** | TypeScript **^4.9** (`tsconfig.json`); Node **>= 14** (`engines`) |
| **Build** | `tsc -b` → `lib/`; `prepack` runs compile + `oclif manifest` + `oclif readme`; copies `src/config` → `lib/` |
| **Tests** | Mocha + Chai + Sinon; **nyc** coverage; tests under `test/**/*.test.ts` (see [skills/testing/SKILL.md](skills/testing/SKILL.md)) |
| **Lint / coverage** | ESLint `src/**/*.ts`; nyc in `npm test` |
| **Other** | OCLIF v4, Husky |

## Commands (quick reference)

| Command type | Command |
| --- | --- |
| **Build** | `npm run build` |
| **Test** | `npm test` |
| **Lint** | `npm run lint` |

CI: [.github/workflows/unit-test.yml](.github/workflows/unit-test.yml); also `release.yml`, `sca-scan.yml`, `policy-scan.yml` under [.github/workflows/](.github/workflows/).

## Where the documentation lives: skills

| Skill | Path | What it covers |
| --- | --- | --- |
| Development workflow | [skills/dev-workflow/SKILL.md](skills/dev-workflow/SKILL.md) | CI, branches, Husky, PR expectations |
| Contentstack CLI | [skills/contentstack-cli/SKILL.md](skills/contentstack-cli/SKILL.md) | Commands, `QueryExporter`, APIs |
| Framework | [skills/framework/SKILL.md](skills/framework/SKILL.md) | Config, logging, errors, utilities |
| Testing | [skills/testing/SKILL.md](skills/testing/SKILL.md) | Mocha/Chai/Sinon, nyc, TDD |
| Code review | [skills/code-review/SKILL.md](skills/code-review/SKILL.md) | PR checklist |

## Using Cursor (optional)

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