Match core's code quality checks: cspell

Waiting long enough means we can use GitLab CI, and as of 📌 Adopt GitLab CI: PHPStan compliance + test against 9.5/10.0/10.1/10.2/11.x + max PHP version Fixed we are effectively are using GitLab CI :)

PHPStan is already taken care of.

What's still missing: cspell. That's being added in #3405955: Add job for CSPELL in contrib pipeline → .

#3405955: Add job for CSPELL in contrib pipeline → landed 3 days ago! Will need to adopt version 1.2.0 of the d.o GitLab CI template to get it.

Wim Leers → closed merge request !10

The cspell job is failing because no CDN-specific dictionary was added yet, but also because core's dictionary is not being used — so this is blocked on #3405955-24: Add job for CSPELL in contrib pipeline → .

The current cspell job gives CSpell: Files checked: 37, Issues found: 130 in 23 files and there are 30 distinct misspelled words.

#3422323: Improve CSPELL → is now ready for final testing so I am going to use the MR here to test it.

New test has

CSpell: Files checked: 46, Issues found: 88 in 20 files
The number of unrecognised/misspelled words is 18

You can that the number of files being checked has increased from 37 to 45. This is because the current job only checked in sub-directories, amd files at the top level were ignored.

But the number of distinct incorrect words has dropped from 30 to 18, due to the new version automatically adding the two Drupal core dictionaries plus all the standard ones for languages, like core uses.

Those 18 words are in a downloadable artifact, which I have attached here for quick reference. If there are words that you need to be ignored you can added them to a .cspell-project-words.txt file, which will be included automatically in the job.

#3405955: Add job for CSPELL in contrib pipeline → and #3422323: Improve CSPELL → landed.

Since Monday, the cspell job appeared and is failing but is allowed to fail: https://git.drupalcode.org/project/cdn/-/jobs/985147

CSpell: Files checked: 45, Issues found: 87 in 19 files
The number of unrecognised/misspelled words is 17
An artifact file has been created containing a unique list of these unrecognized words, for you to browse or download.

👍

Thanks, @jonathan1055! 😄

I have updated this MR to use the new gitlab templates MR155 from #3426136: Execute CSPELL in project root folder and make fixing words easier →

Here is the current state of things

CSpell: Files checked: 46, Issues found: 16 in 3 files
The number of unrecognised/misspelled words is 5
=== This is _cspell_unrecognized_words.txt ===
FEDC
gendelims
Hasselt
subdelims
újjáépítésérol

This is fewer than the number you reported in #11 because you already started to add words to your .cspell-project-words.txt

Thanks for letting me use this MR to test gitlab_templates.

#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 updated CSPELL doc page is https://project.pages.drupalcode.org/gitlab_templates/jobs/cspell/

Putting this back to NW because there are five remaining words that need to be ignored. There are lots of ways you can resolve these, see https://project.pages.drupalcode.org/gitlab_templates/jobs/cspell/ but how you do it is your choice. I have finished with the testing, so its over you you now.

I had no idea what gendelims and subdelims meant, so I did some archeology and found that I added these words at #3069516-5: Farfuture functionality + RFC3986-reserved characters = wrong URLs → ~5 years ago. 😅

Thanks for your kind help here, @jonathan1055 — and I'm honored that you used this issue/module to validate d.o GitLab CI template support for cspell 😊

You're welcome. It was a good collaboration.

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