Problem/Motivation

Why is cspell running on composer/Metapackage/CoreRecommended/composer.json

Steps to reproduce

https://git.drupalcode.org/project/drupal/-/jobs/10633584#L65

Proposed resolution

Ignore composer.json and composer.lock files.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3607061

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:

Comments

mstrelan created an issue. See original summary.

quietone’s picture

Because it has a description field that is English text.

quietone’s picture

But I take your point. I would think we can get a one line description correct.

mstrelan’s picture

The problem here is that bumping one of core's dependencies introduced a new transient dependency on symfony/polyfill-deepclone, and cspell doesn't like the word "deepclone". You could argue that cspell helped us to notice a new dependency was added, but of course that wouldn't happen if the new dependency was a dictionary word. You could also argue that since we're adding deepclone as a dependency, this is a good prompt to tell us we might want to put it in the dictionary, as we might refer to it in other places.

On the other hand, it felt frustrating that this interrupted my workflow, and I'm not sure it was worthwhile.

TL;DR this should be up for discussion rather than just a matter of just excluding this file from cspell to make it easier.

longwave’s picture

+1 - looks like we could remove various other non-words from dictionary.txt if we do this such as "colinodell", "spaze", "lullabot" etc.

Given that composer.json is mostly machine readable except for "description" and maybe one or two other keys, to me means any disruption caused outweighs any benefits here.

mstrelan’s picture

Status: Active » Needs review

Updated config and dictionaries. LLM assisted here to identify what we could remove. Only two words were removable due to excluding composer.json, the others were already removable. Have used separate commits to highlight which ones are due to this config change.

longwave’s picture

Status: Needs review » Needs work

Added a question.