chore: repo maintenance tooling (lint, format, pre-commit hooks, contributor docs) - #74
Merged
Merged
Conversation
npm run lint was tsc --noEmit only — a type-check, not a lint — with no formatter and nothing enforcing checks before a commit reached CI. - ESLint (flat config, typescript-eslint) split into lint:types/lint:style under the existing lint script, so CI's Lint step is a drop-in. - Prettier with a format/format:check script, wired into CI as a new step. - lefthook, installed via postinstall, running lint/format/test against staged files on pre-commit. Closes #54, #51.
Mechanical reformat only, no behavior change — establishes the baseline that npm run format:check now enforces in CI. Part of #54.
CLAUDE.md (an AI-assistant-facing file) was the only place the branching model, commit conventions, and Definition of Done were written down, so human contributors had no equivalent onboarding doc, and PRs had no checklist prompting them through it. - CONTRIBUTING.md summarizes the workflow and Definition of Done, linked from README's Development section. - .github/PULL_REQUEST_TEMPLATE.md mirrors that checklist on every PR. - CLAUDE.md/README updated to describe the lint:types/lint:style split, format:check, and the new lefthook pre-commit hook. Closes #53, #52.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
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
2 participants
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.
Summary
Bundles four small, non-user-facing maintenance issues into one PR since none of them touch extension behavior:
lint:types/lint:styleunder the existingnpm run lint, plusformat/format:checkwired into CI.format:checkhas a clean baseline, kept separate from the tooling commit for easier review/blame.lefthookpre-commit hook (lint, format, unit tests against staged files), installed automatically viapostinstall..github/PULL_REQUEST_TEMPLATE.mdmirroring the Definition of Done.CONTRIBUTING.mdcapturing the branching model, commit conventions, and Definition of Done for human contributors (previously only inCLAUDE.md), linked from the README.#56 (README screenshot/GIF) intentionally left out — several open enhancement issues (#42, #48, #50) will visibly change the sidebar, so a screenshot captured now would need to be redone soon.
Test plan
npm run lint(tsc + eslint)npm run format:checknpm run test(155 tests passing)npm run buildnpx lefthook run pre-commitexercised live across all three commits