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

Spellcheck on CI #6890

Merged
merged 5 commits into from Jun 5, 2023
Merged

Spellcheck on CI #6890

merged 5 commits into from Jun 5, 2023

Conversation

ybiquitous
Copy link
Member

@ybiquitous ybiquitous commented Jun 3, 2023

Which issue, if any, is this issue related to?

None.

Is there anything in the PR that needs further explanation?

This PR introduces spellcheck on CI by using codespell (written in Python).

See:


I automatically fixed some misspells via the following command:

codespell --write

But currently, there are the following false positives. It seems that fixing these doesn't make sense to me.

$ codespell
./lib/utils/__tests__/isValidIdentifier.test.js:20: te ==> the, be, we, to
./lib/utils/__tests__/isValidIdentifier.test.js:22: te ==> the, be, we, to
./lib/rules/no-irregular-whitespace/__tests__/index.js:48: nin ==> inn, min, bin, nine
./lib/rules/selector-list-comma-newline-after/__tests__/index.js:186: nd ==> and, 2nd
./lib/rules/selector-list-comma-newline-after/__tests__/index.js:329: nd ==> and, 2nd
./lib/rules/selector-attribute-quotes/__tests__/index.js:123: te ==> the, be, we, to
./lib/rules/selector-attribute-quotes/__tests__/index.js:174: te ==> the, be, we, to
./lib/rules/selector-attribute-quotes/__tests__/index.js:279: te ==> the, be, we, to
./lib/rules/selector-attribute-quotes/__tests__/index.js:287: te ==> the, be, we, to
./lib/rules/selector-attribute-quotes/__tests__/index.js:288: te ==> the, be, we, to
./lib/rules/selector-type-case/README.md:79: arent ==> aren't
./lib/rules/selector-type-case/__tests__/index.js:308: arent ==> aren't

@changeset-bot
Copy link

changeset-bot bot commented Jun 3, 2023

⚠️ No Changeset found

Latest commit: 466bc91

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ybiquitous ybiquitous marked this pull request as ready for review June 3, 2023 23:52
Copy link
Contributor

@Mouvedia Mouvedia left a comment

Choose a reason for hiding this comment

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

LGTM

@ybiquitous
Copy link
Member Author

@Mouvedia Thanks for the review!

@ybiquitous ybiquitous merged commit 21978e7 into main Jun 5, 2023
15 checks passed
@ybiquitous ybiquitous deleted the spellcheck branch June 5, 2023 22:53
@JounQin
Copy link
Member

JounQin commented Oct 30, 2023

@ybiquitous

Any specific reason for choosing codespell over cspell which is a pure nodejs project and has a VSCode plugin https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker to integrate?

@ybiquitous
Copy link
Member Author

I didn't have a strong opinion, but didn't want to add extra npm dependencies.

@JounQin
Copy link
Member

JounQin commented Oct 30, 2023

I didn't have a strong opinion, but didn't want to add extra npm dependencies.

It sounds like that you prefer to relying on CI checks only instead of checking locally before committing?

@ybiquitous
Copy link
Member Author

Yes. codespell produces some false positives now. I think it's too strict for developers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants