- Issue created by @nicxvan
- Issue was unassigned.
- Status changed to Needs review
about 1 year ago 3:27am 26 March 2024 - 🇺🇸United States nicxvan
I've added a custom dictionary.
I need to confirm that the custom dictionary is being used.I need a maintainer to review the following changes:
Used in a switch statement (nothing happened in that, but I'm not sure we should update a switch condition)
- overriden
Spellings that should be fixed by changing the function calls most likely, ignored for now.
- ajaxcancel
- ajaxform
- cancelurl
- submiturl
Should we update instances of chrono with chronological, or add it to the dictionary?
- chrono
Unsure if this was intentional or should be reset?
- Resert
- First commit to issue fork.
- Status changed to Fixed
about 1 year ago 12:50pm 26 March 2024 - 🇨🇦Canada mandclu
Thanks for your work on this @nicxvan. I've merged your changes, though I do share your concern about changing the case check, but as you say there isn't anything happening within that statement.
Merged in.
- 🇮🇪Ireland lostcarpark
Great to see CSpell issues getting fixed.
A couple of things that might be worth looking at in follow on issues...
- We should make cspell mandatory so that new spelling errors can't be ignored. We can do that as follows.
cspell: allow_failure: false
- The global ignore list is handy for words that we want to use in the project that aren't in CSpell or Drupal's dictionaries, but we should be cautious of letting it grow too much as it could get out of hand if the project expands. Where a word is only used in one file, it might be more appropriate to move it to a
// cspell:ignore
line at the top of the file where it's needed. - Adding variable names to the ignore list is a handy quick fix, but where possible we should look to make variable names more meaningful.
- For example there are number of variables that are a combination of two words, such as
$byhour
, which could be separating the words in either snake case or camel case:$by_hour
orbyHour
, making them easier for humans to read, and allowing CSpell to treat as two words. - Other variables, such as
rdata
, could be made more descriptive - presumably the "r" stands for something.
- For example there are number of variables that are a combination of two words, such as
- If we want to exclude whole files, we could add to a
_CSPELL_IGNORE_PATHS
variable. Some modules exclude the README file, though disabling for just the maintainer section seems a good solution. It can also be useful for text fixtures.
- We should make cspell mandatory so that new spelling errors can't be ignored. We can do that as follows.
Automatically closed - issue fixed for 2 weeks with no activity.