Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: add cspell ESLint plugin for spellchecking #2234

Merged
merged 6 commits into from
May 22, 2024

Conversation

Planeshifter
Copy link
Member

@Planeshifter Planeshifter commented May 5, 2024

Description

What is the purpose of this pull request?

This pull request:

  • adds the @cspell/eslint-plugin for spellchecking support via ESLint.

The spellchecking is configured to only run on comments and strings as CSpell generates way too many false positives for variable identifiers; the plugin is configured further via a bunch of regular expressions that additionally limit what is scanned to e.g. ignore LaTeX equations, links or parts of example code.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.


@stdlib-js/reviewers

@Planeshifter Planeshifter force-pushed the philipp/add-spellcheck-plugin branch from eef5e46 to 196902b Compare May 7, 2024 01:43
@Planeshifter Planeshifter changed the title [WIP] build: add cspell ESLint plugin for spellchecking build: add cspell ESLint plugin for spellchecking May 7, 2024
@Planeshifter Planeshifter marked this pull request as ready for review May 7, 2024 01:54
@Planeshifter Planeshifter force-pushed the philipp/add-spellcheck-plugin branch from 8e12bdf to cb1893a Compare May 9, 2024 19:19
@kgryte kgryte added the Tools Issue or pull request related to project tooling. label May 22, 2024
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks, @Planeshifter!

@kgryte kgryte merged commit 3806e20 into develop May 22, 2024
6 checks passed
@kgryte kgryte deleted the philipp/add-spellcheck-plugin branch May 22, 2024 06:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Tools Issue or pull request related to project tooling.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants