chore: add typo check #254
Merged
Conversation
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
commit: |
- Add typos check to pre-push hook to catch spelling errors before pushing - Explicitly specify typos.toml configuration file - Runs after staged changes but before knip linter
There was a problem hiding this comment.
Pull request overview
This PR adds automated typo checking to the codebase using the typos tool, standardizing spelling from British English to American English conventions throughout the project.
- Introduces typo checking via the
typostool with configuration intypos.toml - Standardizes spelling: "normalise" → "normalize", "initialise" → "initialize", "serialisation" → "serialization", "behaviour" → "behavior", "optimised" → "optimized", "favour" → "favor"
- Integrates typo checking into CI pipeline and pre-push git hooks
Reviewed changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
typos.toml |
Adds configuration for the typos checker with US English locale and file exclusions |
lefthook.yaml |
Adds typo checking as a pre-push git hook |
flake.nix |
Adds typos and typos-lsp packages to the development environment |
.github/workflows/ci.yaml |
Restructures CI jobs and adds dedicated typo checking job |
src/toolsets.ts |
Renames normaliseHeaders to normalizeHeaders and updates comment spelling |
src/toolsets.test.ts |
Updates test descriptions and comments from British to American English |
src/requestBuilder.ts |
Updates comment spelling from "serialisation" to "serialization" |
src/requestBuilder.test.ts |
Updates comment spelling from "behaviour" to "behavior" and "serialisation" to "serialization" |
src/headers.ts |
Renames function and updates JSDoc from British to American English |
src/headers.test.ts |
Updates all function calls and test descriptions to use American English |
src/consts.ts |
Updates comment spelling from British to American English |
examples/*.ts |
Updates comments from "Initialise" to "Initialize" across all example files |
README.md |
Updates comment in code example from "Initialise" to "Initialize" |
CHANGELOG.md |
Reformats bullet lists and corrects spelling inconsistencies in historical entries |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Add CHANGELOG.md to oxlint ignorePatterns to prevent linting errors. The changelog is auto-generated and should not be linted alongside application code. It was already excluded from oxfmt.
ryoppippi
force-pushed
the
another-nix
branch
from
b038964 to
43f07db
Compare
Revert changelog formatting from dash bullets to asterisk bullets, and restore blank lines after section headers. This aligns with the canonical format maintained on the main branch.
ryoppippi
force-pushed
the
another-nix
branch
from
43f07db to
5e16ec6
Compare
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.
Summary by cubic
Add automated typo checking (US English) and split CI into parallel jobs to catch spelling errors early and speed up pipelines. Also standardized spelling across docs, examples, tests, and internal code.
CI/Tooling
Refactors
Written for commit c437ee3. Summary will update automatically on new commits.