Problem/Motivation

The CSPELL pipeline job produces the following supposed misspellings:

additonal
configuation
DDEV
fileuri
fullscreen
hieght
Impelements
ondemand
srclang
swappable
WEBM
webm

Steps to reproduce

Run the gitlab pipeline and review the log output of the CSPELL job.

Proposed resolution

I believe the webm, srclang, ondemand, and fullscreen should be added to our ignore list for cspell in .gitlab-ci.yml. The rest of the terms should be found in the code and updated to use proper spelling.

Remaining tasks

Research how often fileuri is used, if we update it to fileUri or file_uri the cspell job will not find it invalid. We could also add it to the exclude list if the change would have impacts for older versions of the module.

Issue fork ableplayer-3427424

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:

About issue forks

Comments

theMusician created an issue. See original summary.

themusician’s picture

themusician commented

Forgot to use the create issue fork for this fix.
https://git.drupalcode.org/project/ableplayer/-/jobs/1077005

themusician’s picture

themusician commented
Status: Active » Fixed

Committed to 3.x

jonathan1055 made their first commit to this issue’s fork.

jonathan1055’s picture

jonathan1055 commented

Hi,
Following up our conversion on Slack I'd like to use this issue to test some improvements to gitlab_templates cspell job.
See #3426136: Execute CSPELL in project root folder and make fixing words easier

We need projects that have already fixed their spelling errors, to make sure the new changes do not cause any regression.

jonathan1055 opened merge request !37

themusician’s picture

themusician commented

@jonathan1055 reviewing the latest pipeline build the changes look good. CSPELL passes.

jonathan1055’s picture

jonathan1055 commented

The initial commit shows that when using the modified gitlab process the cspell job still passes green without any modifications needed.
https://git.drupalcode.org/issue/ableplayer-3427424/-/pipelines/122353

However, the input can be simplified by not needing quotes around each separate word in _CSPELL_WORDS and _CSPELL_IGNORE_PATHS. It also shows that some words no longer need to be listed. The module name is automatically added, and other words are included in the extra dictionaries being used.

https://git.drupalcode.org/project/ableplayer/-/merge_requests/37/diffs

You can leave this MR open, and when the gitlab templates change has been committed and the 'default-ref' tag moved to include it, you can commit this. It will need the temporary change to 'project' and 'ref' to be removed. I can return here to test it once the change is rolled out to all users.

Thanks for letting me use your project for this testing.

themusician’s picture

themusician commented

The automatic addition of the project name to the job is smart.

That will smooth things out for a lot of projects I bet. Congratulations on simplifying the quote pattern.

Thanks for your help originally with this as well.

jonathan1055’s picture

jonathan1055 commented
Status: Fixed » Reviewed & tested by the community

#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/

I have set this to RTBC because you are welcome to merge in the simplification here in MR37. (The phpunit job failure is a separate problem)

themusician’s picture

themusician commented
Status: Reviewed & tested by the community » Fixed
jonathan1055’s picture

jonathan1055 commented

I see that you did not actually commit the simplified cspell list from the MR.

  • 02ded7fb committed on 3.x 
    Issue #3427424: Resolve cspell errors found by gitlab pipeline and align...
themusician’s picture

themusician commented

Hi,

The simplified version is now in place. https://git.drupalcode.org/project/ableplayer/-/blob/3.x/.gitlab-ci.yml#L61

Thank you

jonathan1055’s picture

jonathan1055 commented
Status: Fixed » Needs review

There are still words that do not need to be specified. I have re-based MR37 so it is mergeable now.

themusician’s picture

themusician commented
Status: Needs review » Patch (to be ported)

Thank you again @jonathan1055 for sticking with this one. I had not realized that the dictionaries CSPELL pulls from now are multiple, https://git.drupalcode.org/project/drupal/-/blob/11.1.2/core/.cspell.jso....

Merged and credit provided.

If we can help in the future via this project, please reach out.

jonathan1055’s picture

jonathan1055 commented

I'm pleased to help.

The link you gave is to the dictionaries that Core uses. But for contrib, Gitlab Templates expands that list to use a lot more good dictionaries which contrib projects can make use of, to avoid too many custom additions.

themusician’s picture

themusician commented

Thank you for the follow-up. I appreciate the extra information.

themusician’s picture

themusician commented
Status: Patch (to be ported) » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

jonathan1055’s picture

jonathan1055 commented

Would it be possible to give me a credit on this issue? Thanks.

themusician’s picture

themusician commented

Happy to do that. I thought I had done so back in February, but just now closed the issue while cleaning up the queue.
https://git.drupalcode.org/project/ableplayer/-/commit/912f32b1aa6d85906...

I'll figure out how to amend the commit or make a new one to add credit.

jonathan1055’s picture

jonathan1055 commented

You can't give credit via the commit message any more. It is done via the 'contribution record' blue button at the top of the issue. You will also need to log in to 'new drupal' to do that.

themusician’s picture

themusician commented

We'll see if it takes. I might need to go back and push it as a git commit. Some of these longer running issues don't always seem to sync.

jonathan1055’s picture

jonathan1055 commented

Thank you. Looks like you suceeded, as it shows to me on https://new.drupal.org/contribution-record/10067613 that the box is ticked.
Cheers.

themusician’s picture

themusician commented

Thanks for the guidance and work on the issue here and for Drupal overall.

Status: Fixed » Closed (fixed)

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