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 typos to CI #12

Open
strickvl opened this issue Mar 29, 2024 · 5 comments · May be fixed by #92
Open

Add typos to CI #12

strickvl opened this issue Mar 29, 2024 · 5 comments · May be fixed by #92
Assignees
Labels
CI good first issue Good for newcomers

Comments

@strickvl
Copy link
Collaborator

Use this GH Action as well as a paired spellcheck script to add spellchecking to the CI.

@strickvl strickvl added good first issue Good for newcomers CI labels Mar 29, 2024
@awanshahid1119
Copy link

I am new to opensource and would like to contribute

@strickvl
Copy link
Collaborator Author

Hi. So we'd want a script in scripts/spellcheck.sh which ran the typos command, we'll probably want a _typos.toml config file (as mentioned here) and we'll also want this adding to the CI. Please ask any questions you need here.

@awanshahid1119
Copy link

Hi,
Are there any changes required in the _typos.toml file, or does it work fine as it is?

@strickvl
Copy link
Collaborator Author

strickvl commented Apr 2, 2024

I think you can take this as a good template for that. Maybe remove the custom spellings as those won't apply here, but it might make sense to exclude some files, and the locale should be set to American English. So I'd probably just start with the locale set, and then run the spellcheck and see what comes up and then go from there.

@strickvl strickvl self-assigned this Apr 2, 2024
@awanshahid1119
Copy link

awanshahid1119 commented Apr 2, 2024

$ bash scripts/spellcheck.sh
error: Lient should be Client, Clients
--> .\src\services\LSClient.ts:233:38
|
233 | * @param {LanguageClient} updatedCLient The new language client.
| ^^^^^
|
error: Lient should be Client, Clients
--> .\src\services\LSClient.ts:235:31
|
235 | public updateClient(updatedCLient: LanguageClient): void {
| ^^^^^
|
error: Lient should be Client, Clients
--> .\src\services\LSClient.ts:236:27
|
236 | this.client = updatedCLient;

seems good to me

@strickvl strickvl linked a pull request Jan 8, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants