chore: fix cspell violations in code blocks#12167
Conversation
|
Thanks for the PR, @kirkwaiblinger! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
View your CI Pipeline Execution ↗ for commit 697980d
☁️ Nx Cloud last updated this comment at |
| > | ||
| > See **https://typescript-eslint.io/rules/strict-void-return** for documentation. | ||
|
|
||
| {/* cspell:words Kazik,Zenek */} |
There was a problem hiding this comment.
We should either start a custom dictionary or add these to the JSON file since they aren't context-dependent and can legitimately appear elsewhere
There was a problem hiding this comment.
Having custom dictionary for names is good idea. It makes upkeep of those word lists easier and it’s kinda self-documenting.
Vscode also supports adding the words to the custom dictionaries, so it’s as easy than adding to the main file.
There was a problem hiding this comment.
Instead of using random names like this as well -- we should just use standard, english words / names so we don't need to add dictionary exceptions.
There was a problem hiding this comment.
Personally I think name diversification is a good idea; we do that in MDN. English docs are not just for English culture.
There was a problem hiding this comment.
I also like the names used here... I double we'll really want to reuse these names in other places, hence why I scoped them to the file, but I am fine with it if we wanted to just add them to the main file 🤷
| Calls to the `getDataKey` function can return a value that's not a `string`, despite the function's explicit return type annotation. | ||
| That can lead to unexpected behavior at runtime: | ||
|
|
||
| <!-- cspell:ignore bleu --> |
There was a problem hiding this comment.
just change the example to use green instead?
There was a problem hiding this comment.
Idk I think it makes more sense as is? "bleu" is intentionally a typo of "blue" in the context.
| title: 'Avoiding `any`s with Linting and TypeScript' | ||
| --- | ||
|
|
||
| {/* cspell:words Lazlo,Nadya,Nandor */} |
There was a problem hiding this comment.
Can we use names already in the dict?
There was a problem hiding this comment.
Same as #12167 (comment)... I like the idea of name diversification, and so I like the idea of just allow-listing a few names to be used in a specific file, rather than relying on globally allowing them.
|
you can always tell when I wrote a doc cos I used the "correct" spelling 😝 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #12167 +/- ##
=======================================
Coverage 86.71% 86.71%
=======================================
Files 513 513
Lines 16271 16271
Branches 5060 5060
=======================================
Hits 14109 14109
Misses 1474 1474
Partials 688 688
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
| title: 'Avoiding `any`s with Linting and TypeScript' | ||
| --- | ||
|
|
||
| {/* cspell:words Lazlo,Nadya,Nandor */} |
697980d
PR Checklist
Overview
Tweak some typos, and otherwise add things to dictionary