Fix CSpell issues reported by GitLab CI

Created on 16 July 2024, 5 months ago
Updated 14 September 2024, 3 months ago

Problem/Motivation

GitLab CI introduced CSpell spelling checking, which reports a number of problems.

Please see this pipeline for the full CSpell output.

Steps to reproduce

See pipeline from CSpell run above.

Proposed resolution

I think there some files we can ignore - for example, ones in hidden directories.

There are also words we can ignore globally, for example maintainer usernames.

The remainder are words in source files. Where possible, we should fix the spelling of those words. However, if that's not possible, or there are words that are not misspelt within a single file, we should add an ignore list for that file.

This would be a fairly easy task for a novice contributor.

Remaining tasks

  • In the .gitlab-ci.yml file, add a _CSPELL_IGNORE_PATHS variable, and list paths that should not be checked. I think the /config/ directory could be excluded since it contains exported config. I would consider also ignoring /bitbucket-pipelines.yml.
  • Words like maintainer usernames can be ignored globally. This no longer requires a word list file, ans they can placed in the _CSPELL_WORDS variable as a comma separated list.
  • There may be individual files that need words ignored, for example, the schp Drush command in ScheduledPublishCommands.php. This can be added to a file specific ignore list with a // cSpell:ignore line at the top of the file.
  • Other words flagged seem to be actual misspellings, such as shceduling (should be scheduling) and schedulded (scheduled). These should be fixed.

User interface changes

N/A

API changes

N/A

Data model changes

N/A

📌 Task
Status

Fixed

Version

3.0

Component

Code

Created by

🇮🇪Ireland lostcarpark

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024