GitlabCI: Fix CSPELL validation errors

Created on 8 August 2024, 5 months ago
Updated 26 August 2024, 4 months ago

Problem/Motivation

The last pipeline for the current development branch 2.1.x reported quite a few errors for the job CSPELL, see:

 

Steps to reproduce

Build > Pipeline > Run pipeline :
https://git.drupalcode.org/project/colorbox/-/pipelines
Select branch: 2.1.x

Proposed resolution

Fix all errors reported by CSPELL:

  • Fix all spelling, typos and other types of errors, based on suggestions.
  • Ignore certain keywords or names.

 

Feel free to let us know if you have any questions or concerns on any aspects of this ticket or the project in general, we would be glad to help.
Thanks in advance!

πŸ“Œ Task
Status

Fixed

Version

2.1

Component

Code

Created by

πŸ‡«πŸ‡·France dydave

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

Merge Requests

Comments & Activities

  • Issue created by @dydave
  • Pipeline finished with Success
    5 months ago
    Total: 161s
    #248315
  • Pipeline finished with Success
    5 months ago
    #248321
  • Status changed to Needs review 5 months ago
  • πŸ‡«πŸ‡·France dydave

    Quick follow-up on this issue:

    A few additional commits were added to the current merge request MR!39 with a few comments, see above at #2.

    But mostly, at this point:
    Last build on MR!39: https://git.drupalcode.org/issue/colorbox-3467008/-/pipelines/248321

     

    We would greatly appreciate if a maintainer or someone with write permission could take a look at ticket's merge request and let us know if there would be any more work needed.

    Feel free to let us know if you have any questions or concerns on merge request MR!39 or any aspect of this ticket in general, we would surely be glad to help.
    Thanks in advance for your feedback and reviews.

  • Status changed to Needs work 5 months ago
  • πŸ‡ΊπŸ‡ΈUnited States dww

    Unfortunately the changes to the form elements and values makes this a more consequential and potentially breaking change. Eg anyone altering these forms will have to update code to match.

    Probably better for now to ignore those spellings and open a follow up to rename these form elements with possible upgrade path if needed.

    Otherwise, looks great.

    Thanks!
    -Derek

  • Pipeline finished with Success
    5 months ago
    Total: 148s
    #248527
  • Status changed to Needs review 5 months ago
  • πŸ‡«πŸ‡·France dydave

    Thanks a lot Derek (@dww) for the very helpful review and speedy feedback, it's greatly appreciated! πŸ™‚

    Unfortunately the changes to the form elements and values makes this a more consequential and potentially breaking change. Eg anyone altering these forms will have to update code to match.

    Good catch! I had not thought about this one πŸ˜…

    Changes to src/Form/ColorboxSettingsForm.php have been reverted and the words slideshowauto and slideshowspeed ignored in the file.

    Another breaking change:
    https://git.drupalcode.org/project/colorbox/-/merge_requests/39/diffs?di...
    Otherwise, that made me think of another breaking change to the colorbox.install file where the word please was removed in a t function call, thus potentially breaking existing string translations:
    I had a similar comment from Tim (@TR) at #3157138-19: GitlabCI: Fix CSPELL validation errors β†’ , so disabling the rule ForbiddenWord for this line seems like a better option for now.

    As suggested a follow-up task was created, see πŸ“Œ CSPELL: Fix spelling for breaking variables and/or identifiers Active in case maintainers would still like to proceed with these changes.

    Once again, we would greatly appreciate your reviews, comments and feedback.
    Feel free to let us know if you would have any questions or concerns on any of the changes in the merge request or this ticket in general, we would be glad to help.
    Thanks in advance!

  • Status changed to Fixed 5 months ago
  • πŸ‡ΊπŸ‡ΈUnited States paulmckibben Atlanta, GA

    @DYDave, thanks for cleaning this up, and @dww, thanks for reviewing. I have merged this MR.

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

Production build 0.71.5 2024