Problem/Motivation
In a contrib module
https://www.drupal.org/project/extended_logger/ →
I store the Views configuration inside the module.
And when the CI/CD runs, it always shows me that the cspell job has failed with an error:
modules/extended_logger_db/config/install/views.view.extended_logger_logs.yml:71:42 - Unknown word (MQNAY) -- plural_string: !!binary MQNAY291bnQ=
Suggestions: [MANY, MEANY, Meany, mana, MANA]
This is because Views "numeric" field display plugin stores the "Format plural" configuration as base64 encoded binary blob, instead of a plain text or any other non-binary format.
Steps to reproduce
1. Create a View with a numeric plugin id in the field display options.
2. Export the View to yaml file and place into the module config/install directory, or anywhere else.
3. Run the GitLab pipeline and see that cspell job has filed.
Proposed resolution
Seems the proper solution is to not store this setting as binary, but store it as plain text.
But until this is fixed properly, seems we have to use workarounds:
1. Create the .cspell-project-words.txt file and put this base64 string to the project words.
But this is not stable, because every change of the "Format plural" settings will produce a new word with random characters.
2. Configure cspell to ignore the whole YAML file with this Views configuration.
I can't yet find a way how to do it in the files, but seems we can do this in the .gitlab-ci.yml file like this:
variables:
_CSPELL_IGNORE_PATHS: '"config/install/views.view.my_view.yml"'
But ignoring the whole file just because of a single string is not good too.
So, the proper solution is very welcome!
Remaining tasks
User interface changes
Introduced terminology
API changes
Data model changes
Release notes snippet