Repository navigation
docs: List the format and type commands, drop a stale npmignore note - #251
Merged
Merged
Conversation
AGENTS.md now lists format:check, format:write and generate-types next to the other commands. Lint in CI runs format:check, so a change that skips format:write fails there, and the file did not say the command exists. docs.yml asked to add .github to .npmignore. There is no .npmignore and none is needed: files in package.json is an allowlist of index.d.ts and lib, so nothing else is packed.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
These documentation-only changes match the existing tooling and introduce no unresolved issues.
No open issues 🎉
What changed in this PR
Updates contributor guidance to reflect the existing tooling and removes an obsolete packaging comment without changing workflow behavior.
Changes:
- Documents the formatting and type-generation commands in
AGENTS.md. - Removes the stale
.npmignorenote from the documentation workflow.
| File | Description |
|---|---|
AGENTS.md |
Adds three tooling commands and aligns their descriptions. |
.github/workflows/docs.yml |
Removes an obsolete comment about excluding .github from packages. |
Review effort: Balanced
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Two leftovers from the tooling migration:
AGENTS.mdlistsformat:check,format:writeandgenerate-typesnext to the other commands, and the comment column is realigned to fit them.docs.ymldrops a note asking to add.githubto.npmignore.Why
Lint in CI now runs
format:check, so a change that skipsnpm run format:writefails there.AGENTS.mddid not mention the command.There is no
.npmignoreand none is needed.filesinpackage.jsonis an allowlist ofindex.d.tsandlib;npm pack --dry-runpacks 60 files and nothing from.github.Testing
npm run lintandnpm run format:checkclean. Every command listed inAGENTS.mdexists inpackage.json.