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

feat: spell checking with typos #305

Merged
merged 9 commits into from
Feb 12, 2024
Merged

Conversation

zlataovce
Copy link
Member

No description provided.

- name: Spell check
uses: crate-ci/[email protected]
with:
config: ./.typos.toml
Copy link
Contributor

Choose a reason for hiding this comment

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

Could it be moved into the .GitHub directory to avoid clutter, or can it be used "by default" by running the program locally

Copy link
Member Author

Choose a reason for hiding this comment

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

the CLI searches for it by default, so yes, it would be used if someone just locally ran typos in the directory without options

locale = "en-us"

[default.extend-identifiers]
FilterThreshhold = "FilterThreshhold" # ignore error, it is actually "Paper.FilterThreshhold" in Paper
Copy link
Contributor

Choose a reason for hiding this comment

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

Can it be ignored per-file instead? Incase someone else types it not refering to the option?

It's quite a narrow case tho

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm afraid not, there'd have to be a separate config

.typos.toml Show resolved Hide resolved
.typos.toml Show resolved Hide resolved
.typos.toml Outdated Show resolved Hide resolved
.typos.toml Show resolved Hide resolved
.typos.toml Show resolved Hide resolved
Copy link
Member

@MiniDigger MiniDigger left a comment

Choose a reason for hiding this comment

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

I like and it already caught some typos (even ignoring the bri'sh spellings)

@olijeffers0n olijeffers0n merged commit 6461e08 into PaperMC:main Feb 12, 2024
2 checks passed
@zlataovce zlataovce deleted the feat/spellcheck branch February 12, 2024 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants