Now that GitLab templates has #3405955: Add job for CSPELL in contrib pipeline and #3422323: Improve CSPELL we can run CSPELL to fix the spelling errors.

Issue fork scheduler-3421984

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

jonathan1055 created an issue. See original summary.

jonathan1055’s picture

Starting position
CSpell: Files checked: 176, Issues found: 723 in 114 files

The downloaded file of spelling errors has precisely 100 words.

jonathan1055’s picture

Added .cspell.json and included two core dictionaries. This reduced the errors
CSpell: Files checked: 176, Issues found: 195 in 59 files

The number of unrecognised words reduced to 69

jonathan1055’s picture

After the gitlab_templates issue #3422323: Improve CSPELL the top-level files are now being checked, when they were being ignored before. The current position is:

CSpell: Files checked: 195, Issues found: 191 in 60 files
The number of unrecognised/misspelled words is 87

jonathan1055’s picture

Issue summary: View changes

CSpell: Files checked: 195, Issues found: 15 in 6 files
The number of unrecognised/misspelled words is 5

I am not going to add the five "misspelled" words to the custom dictionary right now as that would simply hide what I think needs investigation. The five words are

  • parms - this is part of variable name in src/Form/SchedulerAdminForm.php $message_parms. I want to know if sub-parts of variable names really have to be full words
  • randomstring - is a function call: 'name' => $values['title'] ?? $this->randomstring(12), so are all function names forced to be real words?
  • tnid is part of array key in schema.yml 'tnid' => [ The keys nid and vid are not reported because the min word length is 4
  • unrequired is a real word, in the Oxford English Dictionary and Merriam Webster so should be in one of the cspell dictionaries
  • vals is a var in js/scheduler_vertical_tabs.js var vals = [];

  • jonathan1055 committed 8e1fdc75 on 2.x
    Issue #3421984 by jonathan1055: Use CSPELL to fix spelling errors and...
jonathan1055’s picture

Starting point for 8.x-1.x
CSpell: Files checked: 117, Issues found: 166 in 50 files
The number of unrecognised/misspelled words is 69

  • jonathan1055 committed 9b9d3f23 on 8.x-1.x
    Issue #3421984 by jonathan1055: Use CSPELL to fix spelling errors and...

jonathan1055 changed the visibility of the branch 2.x to hidden.

  • jonathan1055 committed 0a0d3c83 on 2.x
    Issue #3421984 by jonathan1055: Use CSPELL to fix spelling errors and...
jonathan1055’s picture

Status: Active » Fixed

All spelling errors fixed in 2.x and 1.x

jonathan1055’s picture

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

jonathan1055’s picture

Status: Closed (fixed) » Needs work

The README "ignore" comments work for ignoring the words, but the comments are rendered in the file. The correct comment style is <!--- cSpell:disable --->
See https://git.drupalcode.org/project/gitlab_templates/-/merge_requests/202...

  • jonathan1055 committed 7e427cc5 on 2.x
    Issue #3421984 by jonathan1055: Fix CSPELL comment type in README.md
    
jonathan1055’s picture

Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.