Skip to content

Commit 386a62f

Browse files
authored
Merge pull request #73 from contentstack/update/DX-6012
update: consolidate export-query plugin skills and add AGENTS.md
2 parents 2ba9777 + 480300b commit 386a62f

20 files changed

Lines changed: 774 additions & 1177 deletions

File tree

.cursor/rules/README.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,5 @@
1-
# Cursor rules
1+
# Cursor (optional)
22

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

5-
## Rules overview
6-
7-
| File | Purpose |
8-
|------|---------|
9-
| `dev-workflow.md` | TDD, structure, validation commands (always applied) |
10-
| `typescript.mdc` | TypeScript style and naming |
11-
| `contentstack-cli.mdc` | Contentstack CLI utilities, export flow, API habits |
12-
| `testing.mdc` | Mocha/Chai/Sinon and coverage |
13-
| `oclif-commands.mdc` | Command flag and delegation patterns |
14-
15-
## How they attach
16-
17-
- **Always**: `dev-workflow.md`
18-
- **TypeScript**: `typescript.mdc`
19-
- **Commands** (`src/commands/**`): `oclif-commands.mdc` + `typescript.mdc`
20-
- **Core / utils** (`src/core/**`, `src/utils/**`, `src/types/**`): `contentstack-cli.mdc` + `typescript.mdc`
21-
- **Tests** (`test/**`): `testing.mdc` + domain rules as needed
22-
23-
## Chat shortcuts
24-
25-
You can `@`-mention rule topics (for example TypeScript or testing) depending on how your workspace maps rule names.
5+
This folder only points contributors to **`AGENTS.md`** so editor-specific config does not duplicate the canonical docs.

.cursor/rules/contentstack-cli.mdc

Lines changed: 0 additions & 39 deletions
This file was deleted.

.cursor/rules/dev-workflow.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

.cursor/rules/oclif-commands.mdc

Lines changed: 0 additions & 45 deletions
This file was deleted.

.cursor/rules/testing.mdc

Lines changed: 0 additions & 66 deletions
This file was deleted.

.cursor/rules/typescript.mdc

Lines changed: 0 additions & 49 deletions
This file was deleted.

.cursor/skills/SKILL.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.talismanrc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
fileignoreconfig:
2-
- filename: skills/code-review/SKILL.md
3-
checksum: 8c0c5c1a18ba08aa0c048d261f1ca81c152def23745fd74b531b75a23a5ac969
4-
- filename: skills/framework/SKILL.md
5-
checksum: 5674849276e2087f6361decb2c7e427f451ec7799538fa2eb697b0a8b7b92f44
6-
- filename: .cursor/rules/contentstack-cli.mdc
7-
checksum: 11bf8883f584b900ce1cde336057391717b47eb5a304cb46c5660bb3185cef2f
8-
- filename: skills/code-review/references/code-review-checklist.md
9-
checksum: 6e65ad06469083ed0196edaf8bd2d4478800493b32535be7c98e436082fba44a
10-
- filename: skills/framework/references/framework-patterns.md
11-
checksum: cae3858eea36c1f716ebe4a9679fc3d4eee628cb244cf4fc0a6eccbd8cecb36d
122
- filename: package-lock.json
13-
checksum: 9b73c1e977f09964843bd5f7529ca8decb7e8b5ab462a4e9ab167ff2a05df53f
14-
version: '1.0'
3+
checksum: a907736828db3f054d2e29324a26265e4eeee28416ca2feef4b71ac037468d08
4+
- filename: skills/testing/SKILL.md
5+
checksum: da9831797a5e6a4d2e6e846c3f6d2583d84008d2dfd454dd7effe2f897c43a7b
6+
- filename: skills/framework/SKILL.md
7+
checksum: 2b74c9aaeeee804fe3c2d11e5ed14a20b82922c1d343e7ac0572da1abcc6d26a
8+
- filename: skills/contentstack-cli/SKILL.md
9+
checksum: b42e3526fb902a31080824b776cc8e233646139ee0915d89c0925744d56d586f
10+
- filename: skills/code-review/SKILL.md
11+
checksum: dd24d9e45419787c36cd50142422be53316c4e88dde2d651cc78314db1d4e6aa
12+
- filename: skills/dev-workflow/SKILL.md
13+
checksum: 03434201e3aaaa9239aff2f97826d64ac4ca31467b77c07330ac4b608ee24939
14+
version: "1.0"

AGENTS.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# CLI export-query plugin – 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-export-query` ([repository](https://github.com/contentstack/cli)) |
10+
| **Purpose:** | OCLIF plugin for **query-based** stack export (`cm:stacks:export-query` / short `EXPRTQRY`); implements `QueryExporter` and related export flow. |
11+
| **Out of scope (if any):** | Other export/import plugins live in sibling packages; this repo is only the query-export plugin. |
12+
13+
## Tech stack (at a glance)
14+
15+
| Area | Details |
16+
| --- | --- |
17+
| **Language** | TypeScript **^4.9** (`tsconfig.json`); Node **>= 14** (`engines`) |
18+
| **Build** | `tsc -b``lib/`; `prepack` runs compile + `oclif manifest` + `oclif readme`; copies `src/config``lib/` |
19+
| **Tests** | Mocha + Chai + Sinon; **nyc** coverage; tests under `test/**/*.test.ts` (see [skills/testing/SKILL.md](skills/testing/SKILL.md)) |
20+
| **Lint / coverage** | ESLint `src/**/*.ts`; nyc in `npm test` |
21+
| **Other** | OCLIF v4, Husky |
22+
23+
## Commands (quick reference)
24+
25+
| Command type | Command |
26+
| --- | --- |
27+
| **Build** | `npm run build` |
28+
| **Test** | `npm test` |
29+
| **Lint** | `npm run lint` |
30+
31+
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/).
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) | CI, branches, Husky, PR expectations |
38+
| Contentstack CLI | [skills/contentstack-cli/SKILL.md](skills/contentstack-cli/SKILL.md) | Commands, `QueryExporter`, APIs |
39+
| Framework | [skills/framework/SKILL.md](skills/framework/SKILL.md) | Config, logging, errors, utilities |
40+
| Testing | [skills/testing/SKILL.md](skills/testing/SKILL.md) | Mocha/Chai/Sinon, nyc, TDD |
41+
| Code review | [skills/code-review/SKILL.md](skills/code-review/SKILL.md) | PR checklist |
42+
43+
## Using Cursor (optional)
44+
45+
If you use **Cursor**, [.cursor/rules/README.md](.cursor/rules/README.md) only points to **`AGENTS.md`**—same docs as everyone else.

0 commit comments

Comments
 (0)