agents-md-gen 0.10.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # 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)
+  were reported as npm. Both `bun.lock` and `bun.lockb` count now.
+- Honor corepack's `packageManager` field in package.json over lockfiles.
+- More JS frameworks: Remix, Expo, React Native, Nuxt, SvelteKit, Astro,
+  Angular, Hono, Electron; meta-frameworks replace the library they wrap
+  (Nuxt instead of Vue, SvelteKit instead of Svelte). Playwright as a test
+  runner.
+- Detect Deno projects (`deno.json`/`deno.jsonc`, its tasks, Fresh/Hono).
+- A lone `Pipfile` (no lock yet) is detected as a pipenv Python project.
+- `homepage` points at the public distribution repo; it used to fall back
+  to the private source repo, which 404s for visitors.
+- The README's "real output" example is now checked against the actual
+  CLI output by the test suite, so it can't drift again.
+
 ## 0.10.0
 
 - Detect web frameworks in ecosystems that always reported none:

package/README.md

@@ -53,9 +53,12 @@ docker run --rm -v "$PWD":/workdir ghcr.io/peshino2012/agents-md-gen
 
 ## What it detects
 
-- **Node.js / TypeScript** — package manager (npm/yarn/pnpm/bun), framework
-  (React, Next.js, Vue, Svelte, Express, Fastify, NestJS), test runner
-  (Jest, Vitest, Mocha, Ava, node:test)
+- **Node.js / TypeScript** — package manager (npm/yarn/pnpm/bun, honoring the
+  `packageManager` field), framework (Next.js, Remix, React, Expo/React
+  Native, Nuxt, Vue, SvelteKit, Svelte, Astro, Angular, Express, Fastify,
+  NestJS, Hono, Electron), test runner (Vitest, Jest, Mocha, Ava,
+  node:test, Playwright)
+- **Deno** — `deno.json`/`deno.jsonc` tasks, Fresh/Hono
 - **Python** — package manager (pip/poetry/uv/pipenv), Django/FastAPI/Flask,
   pytest or the Django test runner, ruff
 - **Rust** — Cargo, workspaces, Axum/Actix Web/Rocket/Tauri, clippy
@@ -121,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
@@ -141,7 +149,6 @@ this package's own repo:
 
 ## Structure
 
-- `.github/` — GitHub config (CI, templates)
 - `CHANGELOG.md`
 - `Dockerfile`
 - `LICENSE`
@@ -153,7 +160,6 @@ this package's own repo:
 
 ## Notes
 
-- CI: GitHub Actions (test.yml)
 - License: MIT
 - Docker: Dockerfile
 ````

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "agents-md-gen",
-  "version": "0.10.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",
   "funding": {
     "type": "individual",
     "url": "https://www.npmjs.com/package/agents-md-gen"
@@ -58,6 +59,11 @@
     "fastapi",
     "flask",
     "rails",
+    "deno",
+    "bun",
+    "nuxt",
+    "sveltekit",
+    "astro",
     "cli",
     "codegen",
     "developer-tools"

package/src/detect.js

@@ -31,30 +31,49 @@ function detectNode(root) {
   const pkg = readJson(root, 'package.json');
   if (!pkg) return null;
 
+  // corepack's `packageManager` field ("pnpm@9.12.0") is explicit, so it wins
+  // over lockfile sniffing -- and it's the only signal when no lockfile is
+  // committed.
+  const declared = typeof pkg.packageManager === 'string' ? pkg.packageManager.split('@')[0] : null;
   let packageManager = 'npm';
-  if (exists(root, 'pnpm-lock.yaml')) packageManager = 'pnpm';
+  if (['npm', 'pnpm', 'yarn', 'bun'].includes(declared)) packageManager = declared;
+  else if (exists(root, 'pnpm-lock.yaml')) packageManager = 'pnpm';
   else if (exists(root, 'yarn.lock')) packageManager = 'yarn';
-  else if (exists(root, 'bun.lockb')) packageManager = 'bun';
+  else if (exists(root, 'bun.lock') || exists(root, 'bun.lockb')) packageManager = 'bun';
 
   const deps = { ...(pkg.dependencies || {}), ...(pkg.devDependencies || {}) };
   const has = (name) => Object.prototype.hasOwnProperty.call(deps, name);
 
-  const frameworks = [];
-  if (has('next')) frameworks.push('Next.js');
-  if (has('react') && !has('next')) frameworks.push('React');
-  if (has('vue')) frameworks.push('Vue');
-  if (has('svelte')) frameworks.push('Svelte');
-  if (has('express')) frameworks.push('Express');
-  if (has('fastify')) frameworks.push('Fastify');
-  if (has('@nestjs/core')) frameworks.push('NestJS');
-  if (has('vite')) frameworks.push('Vite');
-  if (has('typescript')) frameworks.push('TypeScript');
+  // Meta-frameworks are listed instead of the library they're built on
+  // (Nuxt, not Vue; SvelteKit, not Svelte).
+  const isRemix = has('@remix-run/react') || has('@remix-run/node');
+  const frameworks = [
+    has('next') && 'Next.js',
+    isRemix && 'Remix',
+    has('expo') && 'Expo',
+    has('react-native') && !has('expo') && 'React Native',
+    has('react') && !has('next') && !isRemix && !has('react-native') && 'React',
+    has('nuxt') && 'Nuxt',
+    has('vue') && !has('nuxt') && 'Vue',
+    has('@sveltejs/kit') && 'SvelteKit',
+    has('svelte') && !has('@sveltejs/kit') && 'Svelte',
+    has('astro') && 'Astro',
+    has('@angular/core') && 'Angular',
+    has('express') && 'Express',
+    has('fastify') && 'Fastify',
+    has('@nestjs/core') && 'NestJS',
+    has('hono') && 'Hono',
+    has('electron') && 'Electron',
+    has('vite') && 'Vite',
+    has('typescript') && 'TypeScript',
+  ].filter(Boolean);
 
   const testFramework = has('vitest') ? 'vitest'
     : has('jest') ? 'jest'
     : has('mocha') ? 'mocha'
     : has('ava') ? 'ava'
     : (pkg.scripts && pkg.scripts.test && pkg.scripts.test.includes('node --test')) ? 'node:test'
+    : has('@playwright/test') ? 'playwright'
     : null;
 
   const run = (script) => (pkg.scripts && pkg.scripts[script]) ? `${packageManager} run ${script}` : null;
@@ -65,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 {
@@ -78,16 +99,47 @@ function detectNode(root) {
   };
 }
 
+function detectDeno(root) {
+  const file = ['deno.json', 'deno.jsonc'].find((f) => exists(root, f));
+  if (!file) return null;
+  const config = readJsonWithComments(root, file) || {};
+  const tasks = config.tasks || {};
+  const task = (name) => (tasks[name] ? `deno task ${name}` : null);
+  const text = readText(root, file) || '';
+
+  return {
+    ecosystem: 'Deno',
+    name: config.name || null,
+    description: null,
+    packageManager: 'deno',
+    frameworks: [
+      /\$fresh\/|@fresh\/core/.test(text) && 'Fresh',
+      /\bhono\b/.test(text) && 'Hono',
+    ].filter(Boolean),
+    testFramework: 'deno test',
+    commands: {
+      install: null,
+      build: task('build'),
+      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',
+    },
+  };
+}
+
 function detectPython(root) {
   const hasPyproject = exists(root, 'pyproject.toml');
   const hasRequirements = exists(root, 'requirements.txt');
   const hasSetupPy = exists(root, 'setup.py');
-  if (!hasPyproject && !hasRequirements && !hasSetupPy) return null;
+  const hasPipfile = exists(root, 'Pipfile');
+  if (!hasPyproject && !hasRequirements && !hasSetupPy && !hasPipfile) return null;
 
   let packageManager = 'pip';
   if (exists(root, 'poetry.lock')) packageManager = 'poetry';
   else if (exists(root, 'uv.lock')) packageManager = 'uv';
-  else if (exists(root, 'Pipfile.lock')) packageManager = 'pipenv';
+  else if (hasPipfile) packageManager = 'pipenv';
 
   const pyproject = readText(root, 'pyproject.toml') || '';
   const usesPytest = exists(root, 'pytest.ini') || exists(root, 'conftest.py') || /pytest/.test(pyproject);
@@ -114,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`;
@@ -129,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,
     },
   };
 }
@@ -167,6 +231,8 @@ function detectRust(root) {
       test: 'cargo test',
       lint: 'cargo clippy',
       dev: null,
+      typecheck: 'cargo check',
+      format: 'cargo fmt',
     },
   };
 }
@@ -194,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 .',
     },
   };
 }
@@ -413,6 +480,7 @@ function detectDart(root) {
       test: isFlutter ? 'flutter test' : 'dart test',
       lint: 'dart analyze',
       dev: isFlutter ? 'flutter run' : null,
+      format: 'dart format .',
     },
   };
 }
@@ -435,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',
     },
   };
 }
@@ -643,7 +712,7 @@ function detectMonorepo(root) {
 }
 
 function detectProject(root) {
-  const detectors = [detectNode, detectPython, detectRust, detectGo, detectRuby, detectJava, detectPhp, detectDotnet, detectSwift, detectDart, detectElixir, detectCpp, detectHaskell, detectScala, detectZig, detectJulia];
+  const detectors = [detectNode, detectDeno, detectPython, detectRust, detectGo, detectRuby, detectJava, detectPhp, detectDotnet, detectSwift, detectDart, detectElixir, detectCpp, detectHaskell, detectScala, detectZig, detectJulia];
   const stacks = detectors.map((fn) => fn(root)).filter(Boolean);
 
   return {

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;
 }