Skip to content

docs: replace node-markdown-spellcheck with cspell#2015

Open
IstvanCsVarga wants to merge 2 commits intocert-manager:masterfrom
IstvanCsVarga:replace-mdspell-with-cspell
Open

docs: replace node-markdown-spellcheck with cspell#2015
IstvanCsVarga wants to merge 2 commits intocert-manager:masterfrom
IstvanCsVarga:replace-mdspell-with-cspell

Conversation

@IstvanCsVarga
Copy link

@IstvanCsVarga IstvanCsVarga commented Mar 14, 2026

Summary

Replaces the unmaintained node-markdown-spellcheck (mdspell) with cspell, an actively maintained spell checker. The old tool has not been updated in 6+ years and is generating security alerts (#1985).

  • Swap markdown-spellcheck for cspell (v8.19.3) in devDependencies
  • Add cspell.json configuration (US English, ignores versioned/historical docs and auto-generated API references)
  • Extend .spelling dictionary for cspell compatibility
  • Fix 14 genuine typos in current docs caught by cspell
  • Add lodash as a direct dependency (previously only available as a transitive dependency of markdown-spellcheck, used by lib/serialize.js)

Notes

  • Historical versioned docs (content/v*-docs/**) are excluded from spellcheck per maintainer guidance
  • The existing .spelling allowlist is reused as a cspell custom dictionary
  • All checks pass locally (check:spelling, check:eslint, check:links, check:markdown)
  • Full site build verified locally with Node 20

Closes #1985

Replace the unmaintained markdown-spellcheck (mdspell) package with
cspell, an actively maintained spell checker. The old tool has not been
updated in over 6 years and is generating security alerts.

Changes:
- Swap markdown-spellcheck for cspell in devDependencies
- Add cspell.json configuration with US English locale
- Ignore historical versioned docs (content/v*-docs/**)
- Ignore auto-generated API reference docs
- Extend .spelling dictionary for cspell compatibility
- Fix 14 genuine typos in current docs caught by cspell

Closes cert-manager#1985

Signed-off-by: Istvan Csaba Varga <istvan.csaba.varga@accenture.com>
@cert-manager-prow cert-manager-prow bot added the dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. label Mar 14, 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 maelvls 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 14, 2026
lodash/cloneDeep is used in lib/serialize.js but was previously only
available as a transitive dependency of markdown-spellcheck. Adding it
as a direct dependency so the build succeeds after the spellcheck tool
swap.

Signed-off-by: Istvan Csaba Varga <istvan.csaba.varga@accenture.com>
@netlify
Copy link

netlify bot commented Mar 14, 2026

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit b545bdb
🔍 Latest deploy log https://app.netlify.com/projects/cert-manager/deploys/69b4ebafa2e94f0007404fec
😎 Deploy Preview https://deploy-preview-2015--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.

@IstvanCsVarga
Copy link
Author

Friendly ping — would appreciate a review when anyone has a chance. Happy to address any feedback. Thanks!

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

1 participant