Skip to content

Replace node-markdown-spellcheck with cspell for spell checking#1986

Open
Abmarne wants to merge 6 commits intocert-manager:masterfrom
Abmarne:master
Open

Replace node-markdown-spellcheck with cspell for spell checking#1986
Abmarne wants to merge 6 commits intocert-manager:masterfrom
Abmarne:master

Conversation

@Abmarne
Copy link

@Abmarne Abmarne commented Feb 28, 2026

I've replaced the unmaintained node-markdown-spellcheck with cspell. Here's a summary of the changes:
Fix: #1985

Changes made:

package.json:
Replaced markdown-spellcheck devDependency with cspell (v8.19.3)
Updated check:spelling script to use cspell CLI
cspell.json (new file):
Configured cspell to use the existing .spelling file as a custom dictionary
Added ignore paths for node_modules, api-docs, etc.
README.md:
Updated reference from mdspell to cspell
Why cspell?

Actively maintained (latest version published 17 hours ago)
Well-established with 124+ stars on GitHub
Supports custom dictionaries (reuses existing .spelling file)
Fast and feature-rich spell checker for code

@cert-manager-prow cert-manager-prow bot added the dco-signoff: no Indicates that at least one commit in this pull request is missing the DCO sign-off message. label Feb 28, 2026
@cert-manager-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign erikgb for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@cert-manager-prow cert-manager-prow bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 28, 2026
@Abmarne Abmarne changed the title Replace node-markdown-spellcheck with cspell for spell checking Replace node-markdown-spellcheck with cspell for spell checking Feb 28, 2026
@Abmarne Abmarne changed the title Replace node-markdown-spellcheck with cspell for spell checking Replace node-markdown-spellcheck with cspell for spell checking Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com> Feb 28, 2026
@Abmarne Abmarne changed the title Replace node-markdown-spellcheck with cspell for spell checking Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com> Replace node-markdown-spellcheck with cspell for spell checking Feb 28, 2026
Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com>
@cert-manager-prow cert-manager-prow bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. and removed dco-signoff: no Indicates that at least one commit in this pull request is missing the DCO sign-off message. labels Feb 28, 2026
Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com>
@cert-manager-prow cert-manager-prow bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 28, 2026
@netlify
Copy link

netlify bot commented Feb 28, 2026

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 6f01a96
🔍 Latest deploy log https://app.netlify.com/projects/cert-manager/deploys/69a306f830b64c00086f4cc2
😎 Deploy Preview https://deploy-preview-1986--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com>
@erikgb
Copy link
Member

erikgb commented Feb 28, 2026

@Abmarne, thanks for picking this up! ❤️ You can probably add ignore configuration of all "historical" documentation.

Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com>
Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com>
Signed-off-by: Abhiraj Marne <abhirajmarne11@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Replace github.com/lukeapage/node-markdown-spellcheck

2 participants