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

Run cspell in CI #2622

Merged
merged 4 commits into from
Oct 22, 2024
Merged

Run cspell in CI #2622

merged 4 commits into from
Oct 22, 2024

Conversation

andyw8
Copy link
Contributor

@andyw8 andyw8 commented Sep 25, 2024

I added a VS Code cspell configuration a while ago but it relies on people having the extension enabled, and noticing the things it detects. Instead, let's enforce this in CI. I've verified that the extension is still able to read the config.

@andyw8 andyw8 requested a review from a team as a code owner September 25, 2024 15:42
@andyw8 andyw8 requested review from st0012 and alexcrocha September 25, 2024 15:42
@andyw8 andyw8 added the chore Chore task label Sep 25, 2024
.github/workflows/ci.yml Outdated Show resolved Hide resolved
project-words Show resolved Hide resolved
project-words Show resolved Hide resolved
@dirceu
Copy link
Contributor

dirceu commented Sep 25, 2024

Oh nice, that caught a bunch of stuff already!

Do we have to check in that new yarn.lock file?

@andyw8
Copy link
Contributor Author

andyw8 commented Sep 25, 2024

I suppose not. Updated.

.github/workflows/ci.yml Outdated Show resolved Hide resolved
lib/ruby_indexer/test/instance_variables_test.rb Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@andyw8 andyw8 force-pushed the andyw8/cspell branch 4 times, most recently from c0e685f to 80e397d Compare October 16, 2024 18:24
@andyw8
Copy link
Contributor Author

andyw8 commented Oct 16, 2024

Updated to only install cspell in CI.

Copy link
Member

@vinistock vinistock left a comment

Choose a reason for hiding this comment

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

I'm slightly hesitant of making this a required part of CI. I agree that we should avoid typos and misspellings whenever possible, but I wonder if many PRs will end up being blocked on unknown terms and require regular updates to the cspell configuration.

I think there's no harm in trying this out, but if it becomes really annoying, then I will suggest removing the check.

test/fixtures/prism Outdated Show resolved Hide resolved
@andyw8 andyw8 enabled auto-merge (squash) October 22, 2024 14:18
@andyw8 andyw8 merged commit ad5a23b into main Oct 22, 2024
37 checks passed
@andyw8 andyw8 deleted the andyw8/cspell branch October 22, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Chore task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants