compose-agentsmd 3.3.1 → 3.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  This repository contains CLI tooling for composing per-project `AGENTS.md` files from modular rule sets.
4
4
 
5
+ ## Compatibility
6
+
7
+ - Node.js >= 20
8
+
5
9
  ## Release notes
6
10
 
7
11
  See `CHANGELOG.md` for release notes.
@@ -147,11 +151,14 @@ npm install
147
151
  npm run lint
148
152
  npm run build
149
153
  npm test
150
- ```
151
-
152
- ## Overview
153
- This repository contains the compose-agentsmd project.
154
-
155
- ## Requirements and Configuration
156
- - No required environment variables are documented.
157
-
154
+ ```
155
+
156
+ ## Overview
157
+ This repository contains the compose-agentsmd project.
158
+
159
+ ## Documentation
160
+ - [CHANGELOG.md](CHANGELOG.md)
161
+ - [CONTRIBUTING.md](CONTRIBUTING.md)
162
+ - [SECURITY.md](SECURITY.md)
163
+ - [LICENSE](LICENSE)
164
+ - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "compose-agentsmd",
3
- "version": "3.3.1",
3
+ "version": "3.3.2",
4
4
  "description": "CLI tools for composing per-project AGENTS.md files from modular rule sets",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -44,6 +44,7 @@
44
44
  "node": ">=20"
45
45
  },
46
46
  "devDependencies": {
47
+ "@types/diff": "^7.0.2",
47
48
  "@types/node": "^25.1.0",
48
49
  "typescript": "^5.7.3"
49
50
  },
@@ -2,12 +2,10 @@
2
2
  - Before starting any work, run `compose-agentsmd` from the project root.
3
3
  - `compose-agentsmd` intentionally regenerates `AGENTS.md`; any resulting `AGENTS.md` diff is expected and must not be treated as an unexpected external change.
4
4
  - If `compose-agentsmd` is not available, install it via npm: `npm install -g compose-agentsmd`.
5
- - To update shared rules, run `compose-agentsmd edit-rules`, edit the workspace rules, then run `compose-agentsmd apply-rules`.
5
+ - To update shared/global rules, use `compose-agentsmd edit-rules` to locate the writable rules workspace, make changes only in that workspace, then run `compose-agentsmd apply-rules` (do not manually clone or edit the rules source repo outside this workflow).
6
+ - If you find an existing clone of the rules source repo elsewhere, do not assume it is the correct rules workspace; always treat `compose-agentsmd edit-rules` output as the source of truth.
6
7
  - `compose-agentsmd apply-rules` pushes the rules workspace when `source` is GitHub (if the workspace is clean), then regenerates `AGENTS.md` with refreshed rules.
7
8
  - Do not edit `AGENTS.md` directly; update the source rules and regenerate.
8
9
  - `tools/tool-rules.md` is the shared rule source for all repositories that use compose-agentsmd.
9
- - Before applying any rule updates, present the planned changes first (prefer a colorized diff-style preview), ask for explicit approval, then make the edits.
10
- - These tool rules live in tools/tool-rules.md in the compose-agentsmd repository; do not duplicate them in global rule modules.
11
- - When updating rules, include a colorized diff-style summary in the final response. Use `git diff --stat` first, then include the raw ANSI-colored output of `git diff --color=always` (no sanitizing or reformatting), and limit the output to the rule files that changed.
12
- - Also provide a short, copy-pasteable command the user can run to view the diff in the same format. Use absolute paths so it works regardless of the current working directory, and scope it to the changed rule files.
13
- - If a diff is provided, a separate detailed summary is not required. If a diff is not possible, include a detailed summary of what changed (added/removed/modified items).
10
+ - Before applying any rule updates, present the planned changes first with an ANSI-colored diff-style preview, ask for explicit approval, then make the edits.
11
+ - These tool rules live in tools/tool-rules.md in the compose-agentsmd repository; do not duplicate them in other rule modules.