Problem/Motivation

There is a new CSPELL job in the gitlab pipeline and it reports some spelling errors and unrecognized part words. This results in a warning and the pipeline end amber.

We can fix these to get the pipeline passing green again.

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

I am going to use this issue as test for the upcoming gitlab_templates changes on #3426136: Execute CSPELL in project root folder and make fixing words easier

jonathan1055’s picture

Version: 8.x-3.x-dev » 4.x-dev

Baseline starting point is

CSpell: Files checked: 43, Issues found: 36 in 10 files
The number of unrecognised/misspelled words is 20
jonathan1055’s picture

The first commit adds a word, but without extra quotes.

+  # There are several part-words used for matching in tests. Tell CSpell not to report these.
+  _CSPELL_WORDS: 'nana'

The job should fail as this is currently incorrect syntax with the existing cspell job.

jonathan1055’s picture

As expected we get the failure

Configuration Error: Failed to read config file: "/builds/issue/module_filter-3431234/gitlabci_cspell/module_filter-3431234/.cspell.json"
CSpell: Files checked: 0, Issues found: 0 in 0 files

https://git.drupalcode.org/issue/module_filter-3431234/-/jobs/1092051

Next commit will use the changes in the gitlab_templates MR155

jonathan1055’s picture

With MR155 the cspell jobs runs correctly.
https://git.drupalcode.org/issue/module_filter-3431234/-/jobs/1092554

CSpell: Files checked: 42, Issues found: 30 in 9 files
The number of unrecognised/misspelled words is 18
An artifact file has been created containing a unique list of these unrecognized words, for you to browse or download.
=== This is _cspell_unrecognized_words.txt ===
aname
Andrey
andrey
bname
ctools
demonstates
desciption
dispayed
initialise
interdif
Mustgrave
Permisions
reclosed
smustgrave
toco
Troeglazov
troeglazov
untain

42 files checked instead of 43. Composer.json is now automatically ignored. The single word 'nana' in _CSPELL_WORDS is no longer reported.

jonathan1055’s picture

The last commit added two more words and ignored the 'maintainers' paragraph in README.md

Spell: Files checked: 42, Issues found: 18 in 8 files
The number of unrecognised/misspelled words is 10
An artifact file has been created containing a unique list of these unrecognized words, for you to browse or download.
=== This is _cspell_unrecognized_words.txt ===
aname
bname
ctools
demonstates
desciption
dispayed
initialise
interdif
Permisions
reclosed
jonathan1055’s picture

Added two drupal/programming terms ctools, interdif to _cspell_words, and changed two variable names to camelCase.

https://git.drupalcode.org/issue/module_filter-3431234/-/jobs/1093117

Now we are just left with the real spelling errors:

CSpell: Files checked: 42, Issues found: 9 in 5 files
The number of unrecognised/misspelled words is 6
An artifact file has been created containing a unique list of these unrecognized words, for you to browse or download.
=== This is _cspell_unrecognized_words.txt ===
demonstates
desciption
dispayed
initialise
Permisions
reclosed
jonathan1055’s picture

The cspell job passes green
https://git.drupalcode.org/issue/module_filter-3431234/-/jobs/1093197

CSpell: Files checked: 41, Issues found: 0 in 0 files
jonathan1055’s picture

The spelling fixes are all done, but this is still using the MR155 from gitlab_templates issue #3426136: Execute CSPELL in project root folder and make fixing words easier

We need to wait for that to be merged, and then also wait for those changes to reach the 'default-ref' tag, which is the equivalent of a stable recommended release.

jonathan1055’s picture

Status: Active » Needs review

#3426136: Execute CSPELL in project root folder and make fixing words easier has been committed.

Also the gitlab_templates default-ref tag has been updated to include this change for all contrib by default. Hence I have reverted the temporary change here.

The CSPELL job ends green. This is ready for review.

smustgrave’s picture

Status: Needs review » Fixed

Fine with all the word changes. Didn't think about the disable for the names I've added my name to the cpsell ignore txt file on other projects haha.

smustgrave’s picture

Unchecking myself.

jonathan1055’s picture

Assigned: jonathan1055 » Unassigned

Nice to see the green pass.

Status: Fixed » Closed (fixed)

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