Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

docs: fix textlint violations in documentation - #57

Merged
roottool merged 3 commits into
mainfrom
docs/fix-textlint
Mar 1, 2026
Merged

roottool merged 3 commits into
mainfrom
docs/fix-textlint

Conversation

@roottool

@roottool roottool commented Mar 1, 2026

Copy link
Copy Markdown
Owner

Description

Apply textlint-based documentation fixes across multiple files.

Type of Change

  • Documentation (changes to documentation only)

Boundary Checklist (Required for Implementation Changes)

  • This is a non-implementation change (Documentation, Tooling, or CI only)
    • Reason: All changes are documentation-only. No source code or tests were modified.

Security & API Stability

Security Impact

  • No impact on security (no changes to forbidden keys, prototype safety)

API Contract

  • No changes to public API (parse function signature, type definitions)
  • No breaking changes to ParseResult, ParseIssue, or IssueCode

Versioning

  • Change is compatible with current v0.x versioning policy

Testing

Automated Checks

  • TypeScript type checking passes (bun run check:type:source)
  • All tests pass (bun run test)
  • Build succeeds (bun run build)

Additional Verification

Documentation-only changes. No runtime behavior is affected.

Changes

  • Normalize terminology: NPM → npm, change log → changelog, Anti-Patterns → antipatterns, Bug fix → Bugfix, Spread Operator → spread syntax, etc.
  • Remove weasel words in README and SECURITY: Many parsers → Parsers often, several → the following, distinguishes clearly → distinguishes
  • Fix MD036 violation in README: **Key points** → ### Key points

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

roottool and others added 3 commits March 1, 2026 22:37
Apply textlint terminology rule auto-fixes.

- Bug fix/fixes → Bugfix/bugfixes
- auto-fixing → autofixing
- change log → changelog
- NPM → npm
- git → Git (in publishing context)
- Spread Operator → spread syntax
- Anti-Patterns → antipatterns

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- README: "Many parsers" → "Parsers often", "several" → "the following"
- SECURITY: remove redundant "clearly"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
  Replace `**Key points**` with `### Key points` to fix MD036 violation.
  Bold emphasis must not be used as a substitute for a proper heading.
@roottool roottool self-assigned this Mar 1, 2026
@codecov

codecov Bot commented Mar 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (918d254) to head (b5dcdcf).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #57   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           22        22           
  Branches         6         6           
=========================================
  Hits            22        22           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@roottool
roottool merged commit da88f81 into main Mar 1, 2026
13 checks passed
@roottool
roottool deleted the docs/fix-textlint branch March 1, 2026 13:56
@roottool roottool added the documentation Improvements or additions to documentation label Mar 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant