-
Notifications
You must be signed in to change notification settings - Fork 1
docs(setup-docs): default to runtime deps with deny-list filter #41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
c06ffe2
docs(setup-docs): default to runtime dependencies with deny-list filter
amondnet 0812655
docs(setup-docs): clarify include semantics and go direct-deps framing
amondnet 4a8c78d
docs(setup-docs): surface peerDependencies bucket and bound include s…
amondnet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| # Default deny-list — packages excluded from `setup-docs` by default | ||
|
|
||
| `setup-docs` reads this file and drops any dependency whose name matches one | ||
| of the patterns below **before** showing the confirmation plan. The goal is | ||
| to keep `AGENTS.md` focused on libraries an AI agent will actually reference | ||
| when writing application code — not on the toolchain that builds or lints it. | ||
|
|
||
| Matching is glob-style (`*` = any characters, `?` = one character). Matching | ||
| is applied to the **package name** (not version), case-sensitive, and works | ||
| across ecosystems — entries that are npm-specific (`@types/*`) simply don't | ||
| match non-npm names. | ||
|
|
||
| Users can always override: | ||
|
|
||
| - `include-dev` — also pulls in `devDependencies` and `peerDependencies` | ||
| (plus dev-scope equivalents for non-npm ecosystems). Both are still | ||
| subject to the deny-list below. | ||
| - `include <name>` — force-include a specific package from any | ||
| *soft-skip* bucket (deny-list, devDependencies, or peerDependencies). | ||
| Comma-separated names are allowed: `include foo,bar`. This does not | ||
| override the always-skip rules in SKILL.md Step 1 (workspace / `link:` | ||
| / `file:` / path deps) — those produce no downloadable docs. | ||
| - `all` — disable the deny-list **and** include `devDependencies` / | ||
| `peerDependencies` in a single shot. Use when you explicitly want the | ||
| previous exhaustive behavior. | ||
|
|
||
| ## Categories | ||
|
|
||
| ### Type-only packages | ||
|
|
||
| AI agents read types from the compiler, not from a separate docs tarball. | ||
|
|
||
| - `@types/*` | ||
|
|
||
| ### Linters / formatters / style | ||
|
|
||
| The tool itself rarely needs docs at code-writing time. If the user is | ||
| writing an ESLint plugin or a Prettier config, they will ask for | ||
| `add-docs eslint` explicitly. | ||
|
|
||
| - `eslint` | ||
| - `eslint-*` | ||
| - `eslint-config-*` | ||
| - `eslint-plugin-*` | ||
| - `@eslint/*` | ||
| - `@typescript-eslint/*` | ||
| - `@stylistic/*` | ||
| - `@antfu/eslint-config` | ||
| - `prettier` | ||
| - `prettier-plugin-*` | ||
| - `@prettier/*` | ||
| - `biome` | ||
| - `@biomejs/*` | ||
| - `stylelint` | ||
| - `stylelint-*` | ||
| - `dprint` | ||
| - `rome` | ||
|
|
||
| ### Build tools / bundlers / transpilers | ||
|
|
||
| - `vite` | ||
| - `@vitejs/*` | ||
| - `webpack` | ||
| - `webpack-*` | ||
| - `rollup` | ||
| - `rollup-*` | ||
| - `@rollup/*` | ||
| - `esbuild` | ||
| - `esbuild-*` | ||
| - `tsup` | ||
| - `unbuild` | ||
| - `parcel` | ||
| - `@parcel/*` | ||
| - `turbo` | ||
| - `nx` | ||
| - `@nx/*` | ||
| - `tsx` | ||
| - `ts-node` | ||
| - `typescript` (types come from the compiler itself) | ||
| - `swc` | ||
| - `@swc/*` | ||
| - `babel` | ||
| - `@babel/*` | ||
| - `babel-*` | ||
|
|
||
| ### Test runners / testing libraries | ||
|
|
||
| - `vitest` | ||
| - `@vitest/*` | ||
| - `jest` | ||
| - `@jest/*` | ||
| - `jest-*` | ||
| - `ts-jest` | ||
| - `mocha` | ||
| - `ava` | ||
| - `tap` | ||
| - `node-tap` | ||
| - `@testing-library/*` | ||
| - `playwright` | ||
| - `@playwright/test` | ||
| - `cypress` | ||
|
|
||
| ### Git hooks / commit tooling / release automation | ||
|
|
||
| - `husky` | ||
| - `lint-staged` | ||
| - `commitlint` | ||
| - `@commitlint/*` | ||
| - `release-please` | ||
| - `release-please-*` | ||
| - `semantic-release` | ||
| - `@semantic-release/*` | ||
| - `changeset` | ||
| - `@changesets/*` | ||
|
|
||
| ### Polyfills / runtime shims | ||
|
|
||
| - `core-js` | ||
| - `core-js-*` | ||
| - `regenerator-runtime` | ||
| - `tslib` | ||
|
|
||
| ## How to extend | ||
|
|
||
| If you keep hitting the same noisy package in multiple projects, append it | ||
| to the relevant category above. Keep the list sorted within each section | ||
| alphabetically to make diffs easy to review. | ||
|
|
||
| If a user reports that a denied package actually does need docs in their | ||
| workflow, don't silently edit the list — tell them to pass `include <name>` | ||
| so the decision stays explicit and project-scoped. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.