Test for words in 'cspell:ignore' that can be removed

I applied the patch and ran the script for two cases. The following shows the relevant part of the output.

1) Add a word that is not used to an ignore line.

$ ddev commit-code-check --cached
/var/www/html/core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockVisibilityTest.php: xyzzy

CSpell: Ignored words can be removed
1/1 ./modules/block/tests/src/Unit/Plugin/migrate/process/BlockVisibilityTest.php 323.07ms
2/2 ./scripts/dev/commit-code-check.sh 203.57ms
CSpell: Files checked: 2, Issues found: 0 in 0 files

CSpell: failed

1) Add a comment to a file that has an ignore line.

$ ddev commit-code-check --cached

CSpell: No ignored words found
1/1 ./modules/block_content/tests/src/Kernel/Plugin/migrate/source/d6/BoxTranslationTest.php 334.55ms
2/2 ./scripts/dev/commit-code-check.sh 14.46ms
CSpell: Files checked: 2, Issues found: 0 in 0 files

CSpell: passed

No need to run tests but setting to NR.

Verified this was working.

Applied patch #2

In action.module I added // cspell:ignore addedline which is a word in the dictionary.txt

Running commit-code-check.sh I got

Stephens-MBP:web $:./core/scripts/dev/commit-code-check.sh --cached
/Users/smustgrave/Sites/Drupal-Demos/drupal-11.x/web/core/modules/action/action.module: addedline

CSpell: Ignored words can be removed
1/1 ./modules/action/action.module 249.26ms
2/2 ./scripts/dev/commit-code-check.sh 9.18ms
CSpell: Files checked: 2, Issues found: 0 in 0 files

Removing the line from action.module and running again was all green.

We need to update the gitlab-ci pipeline to do this otherwise only committers might run this check.

I agree that this needs to be run in gitlab. However, I think that part is better that it is done as part of or after this issue, 📌 Reconcile gitlab lint jobs and commit-code-check.sh Needs work . That issue is proposing breaking up commit-code-check into several scripts that can be run in both environments. So, this would just be incorporating into one of those new scripts instead of direct additions to the pipeline.

The Needs Review Queue Bot → tested this issue.

While you are making the above changes, we recommend that you convert this patch to a merge request → . Merge requests are preferred over patches. Be sure to hide the old patch files as well. (Converting an issue to a merge request without other contributions to the issue will not receive credit.)

Let's get a response to #6 before changing to an MR or other work on the code.

Brought this up in #needs-review-queue-initiative channel and @alexpott mentioned this should be added to pipeline.