Skip to content

docs: fix typos in comments and JSDoc#4880

Merged
escapedcat merged 1 commit into
conventional-changelog:masterfrom
maxtaran2010:fix/typos-in-comments
Jul 8, 2026
Merged

docs: fix typos in comments and JSDoc#4880
escapedcat merged 1 commit into
conventional-changelog:masterfrom
maxtaran2010:fix/typos-in-comments

Conversation

@maxtaran2010

Copy link
Copy Markdown
Contributor

Summary

Fix three genuine typos found in source code comments and a JSDoc block:

  • supercededsuperseded in @commitlint/cli/src/cli.ts (inline comment)
  • namepacenamespace in @commitlint/load/src/utils/plugin-naming.ts (JSDoc @returns)
  • cotainscontains in @commitlint/format/src/format.test.ts (test name string)

These are straightforward spelling corrections with no behavior change.

- superceded -> superseded in cli.ts comment
- namepace -> namespace in plugin-naming.ts JSDoc
- cotains -> contains in format.test.ts test name

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 8, 2026 09:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Fix typos in comments and JSDoc across commitlint packages

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Correct spelling mistakes in inline comments and JSDoc for clarity.
• Fix a typo in a test description string to improve readability.
• No functional or behavioral changes intended.
High-Level Assessment

The PR’s approach (direct spelling fixes in-place) is the simplest and lowest-risk option. Alternatives like automated spell-checking are broader process changes and out of scope for a targeted typo PR.

Files changed (3) +3 / -3

Tests (1) +1 / -1
format.test.tsFix typo in test name string +1/-1

Fix typo in test name string

• Updates a test description string from “cotains” to “contains” for readability. Test logic remains unchanged.

@commitlint/format/src/format.test.ts

Documentation (2) +2 / -2
cli.tsFix typo in CLI inline comment +1/-1

Fix typo in CLI inline comment

• Corrects the spelling of “superceded” to “superseded” in a comment explaining deprecated env var usage on Windows. No code behavior changes.

@commitlint/cli/src/cli.ts

plugin-naming.tsFix typo in JSDoc @returns description +1/-1

Fix typo in JSDoc @returns description

• Corrects “namepace” to “namespace” in the JSDoc return description for getNamespaceFromTerm. No functional changes.

@commitlint/load/src/utils/plugin-naming.ts

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@greptile-apps

greptile-apps Bot commented Jul 8, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.
  • The edits are limited to comments, JSDoc text, and a test title string.
  • The test title change does not affect test discovery or assertions.

Important Files Changed

Filename Overview
@commitlint/cli/src/cli.ts Fixes a spelling error in an inline comment; no executable code changed.
@commitlint/format/src/format.test.ts Fixes a spelling error in a Vitest test title; no test behavior changed.
@commitlint/load/src/utils/plugin-naming.ts Fixes a spelling error in JSDoc return text; no implementation or type signature changed.

Reviews (1): Last reviewed commit: "docs: fix typos in comments and JSDoc" | Re-trigger Greptile

@escapedcat
escapedcat merged commit 5769d9f into conventional-changelog:master Jul 8, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants