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

Add spell-checker #83

Open
5 tasks
mark-wiemer opened this issue Dec 21, 2024 · 4 comments
Open
5 tasks

Add spell-checker #83

mark-wiemer opened this issue Dec 21, 2024 · 4 comments
Assignees
Labels
CI Build process Meta Related to project structure or procedures

Comments

@mark-wiemer
Copy link
Contributor

mark-wiemer commented Dec 21, 2024

Overall, no need to be strict here about American vs British English or including variable names in a dict vs ignoring them each time they come up. Instead, let's focus on integrating an automated check that works so devs can quickly scan files and publish them with confidence.

  • CI fails if words are marked as spelled incorrectly
  • Contributors can easily update the list of known words
  • Contributors can easily ignore entire files if they want to
  • Contributors can easily identify words marked as spelled incorrectly via their IDE as a standard info squiggle (similar to warnings)

Words that can probably be changed:

  • unittests -> unit tests
  • coredev -> core dev
  • toolcaps -> tool caps?
  • crossview -> cross-view

Future considerations:

  • style guide entry on American vs British vs "other" English?
@mark-wiemer
Copy link
Contributor Author

Yep, working on this now using https://streetsidesoftware.com/vscode-spell-checker/, bumped into streetsidesoftware/vscode-cspell-dict-extensions#1081 though :(

@mark-wiemer
Copy link
Contributor Author

CSpell: Files checked: 89, Issues found: 3343 in 86 files.

Well, at least it's working locally :)

@mark-wiemer mark-wiemer changed the title Add spellchecker Add spell-checker Dec 21, 2024
@wsor4035
Copy link
Collaborator

ci shouldnt be added till #15 is done

@mark-wiemer
Copy link
Contributor Author

Fair enough

@GreenXenith GreenXenith added Meta Related to project structure or procedures CI Build process labels Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Build process Meta Related to project structure or procedures
Projects
None yet
Development

No branches or pull requests

3 participants