agents-md-gen 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.12.0
+
+- New **Typecheck** and **Format** commands in the generated file — what an
+  agent should run before committing. Only emitted with a clear signal:
+  package.json `typecheck`/`type-check`/`tsc` and `format`/`fmt` scripts;
+  ruff or black, mypy or pyright config (Python); `cargo check`/`cargo fmt`
+  (Rust); `gofmt` (Go); `deno fmt` and deno tasks; `dart format`;
+  `mix format`.
+- Fix: the Python lint command lacked the `poetry run`/`uv run`/`pipenv run`
+  prefix the other commands had, so it failed when ruff/flake8 only lived in
+  the project's virtualenv.
+- README: pin a version when using `--check` in CI.
+
 ## 0.11.0
 
 - Fix: Bun projects using the text `bun.lock` (the default since Bun 1.2)

package/README.md

@@ -124,6 +124,11 @@ longer matches what the repo would generate, so a stale file (say, a new
 test framework got added but nobody regenerated it) gets caught instead of
 silently rotting. Pair it with the GitHub Action above.
 
+New releases detect more things, which changes the generated file — so with
+`--check`, pin the version you generated with (`npx agents-md-gen@0.12.0
+--check`, or the action's `version` input) and bump it on purpose, rather
+than letting `@latest` fail CI the day a release lands.
+
 ## Example
 
 Real output — this is what `npx agents-md-gen` produces when run against

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agents-md-gen",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Generate a solid AGENTS.md / CLAUDE.md for any repo by detecting its stack, commands, and structure",
   "license": "MIT",
   "homepage": "https://github.com/Peshino2012/homebrew-tap#readme",

package/src/detect.js

@@ -84,6 +84,8 @@ function detectNode(root) {
     test: run('test'),
     lint: run('lint'),
     dev: run('dev') || run('start'),
+    typecheck: run('typecheck') || run('type-check') || run('tsc'),
+    format: run('format') || run('fmt'),
   };
 
   return {
@@ -121,6 +123,8 @@ function detectDeno(root) {
       test: task('test') || 'deno test',
       lint: task('lint') || 'deno lint',
       dev: task('dev') || task('start'),
+      typecheck: task('check') || task('typecheck'),
+      format: task('fmt') || task('format') || 'deno fmt',
     },
   };
 }
@@ -162,6 +166,16 @@ function detectPython(root) {
 
   const run = { poetry: 'poetry run ', uv: 'uv run ', pipenv: 'pipenv run ' }[packageManager] || '';
 
+  const usesBlack = /^\[tool\.black\]/m.test(pyproject) || hasPythonDep(depsText, 'black');
+  const usesMypy = /^\[tool\.mypy\]/m.test(pyproject) || exists(root, 'mypy.ini') || hasPythonDep(depsText, 'mypy');
+  const usesPyright = /^\[tool\.pyright\]/m.test(pyproject) || exists(root, 'pyrightconfig.json');
+  let formatCmd = null;
+  if (usesRuff) formatCmd = `${run}ruff format .`;
+  else if (usesBlack) formatCmd = `${run}black .`;
+  let typecheckCmd = null;
+  if (usesMypy) typecheckCmd = `${run}mypy .`;
+  else if (usesPyright) typecheckCmd = `${run}pyright`;
+
   let testCmd = null;
   if (usesPytest) testCmd = `${run}pytest`;
   else if (hasManagePy) testCmd = `${run}python manage.py test`;
@@ -177,8 +191,10 @@ function detectPython(root) {
       install: installCmd,
       build: null,
       test: testCmd,
-      lint: usesRuff ? 'ruff check .' : (exists(root, '.flake8') ? 'flake8' : null),
+      lint: usesRuff ? `${run}ruff check .` : (exists(root, '.flake8') ? `${run}flake8` : null),
       dev: hasManagePy ? `${run}python manage.py runserver` : null,
+      typecheck: typecheckCmd,
+      format: formatCmd,
     },
   };
 }
@@ -215,6 +231,8 @@ function detectRust(root) {
       test: 'cargo test',
       lint: 'cargo clippy',
       dev: null,
+      typecheck: 'cargo check',
+      format: 'cargo fmt',
     },
   };
 }
@@ -242,6 +260,7 @@ function detectGo(root) {
       test: 'go test ./...',
       lint: (exists(root, '.golangci.yml') || exists(root, '.golangci.yaml')) ? 'golangci-lint run' : 'go vet ./...',
       dev: null,
+      format: 'gofmt -w .',
     },
   };
 }
@@ -461,6 +480,7 @@ function detectDart(root) {
       test: isFlutter ? 'flutter test' : 'dart test',
       lint: 'dart analyze',
       dev: isFlutter ? 'flutter run' : null,
+      format: 'dart format .',
     },
   };
 }
@@ -483,6 +503,7 @@ function detectElixir(root) {
       test: exists(root, 'test') ? 'mix test' : null,
       lint: exists(root, '.credo.exs') ? 'mix credo' : null,
       dev: null,
+      format: 'mix format',
     },
   };
 }

package/src/render.js

@@ -27,6 +27,8 @@ function renderCommands(stack) {
   if (c.build) lines.push(`- Build: \`${c.build}\``);
   if (c.test) lines.push(`- Test: \`${c.test}\``);
   if (c.lint) lines.push(`- Lint: \`${c.lint}\``);
+  if (c.typecheck) lines.push(`- Typecheck: \`${c.typecheck}\``);
+  if (c.format) lines.push(`- Format: \`${c.format}\``);
   return lines;
 }