refactor: consolidate English shared -ise words into shared-additional-words-ise.txt

[ccoVeille]

Add/Fix Dictionary

Dictionary: _all English dictionary`

Description

• chore: add instructions for external dictionaries source
• chore: add maintenance instructions for English dictionaries
• chore: add instructions for en_GB and en_GB-legacy
• chore: update contributions instructions in README files
• feat: add a shared-additional-words-ise.txt to en_shared

References

• fix: English cleanup #4391 (comment)

Checklist

• By submitting this pull-request, you agree to follow our Code of Conduct
• Verify that the title starts with the correct prefix:
  • fix: - for minor changes like adding words or fixing spelling issues.
  • feat: - for a significant change like adding a whole new set of words to a dictionary.
  • feat!: - for breaking changes, like file format or licensing changes.
  • chore: - for changes that do not impact the content of dictionaries.

[ccoVeille]

@Jason3S I dropped comment to ask you to specificaly looks at them

[Jason3S]

Thank you for the hard work.

I made this into a refactor instead of a feat. The idea is that the consumer of these dictionaries do not care about how the source is arranged if the final dictionary content is not changed.

[Jason3S]

Note: To build the dictionaries locally, just use:

pnpm run conditional-build

It will build any files that need to be updated.

[Jason3S]

It is necessary to build the shared dictionary. To do that, add the following to:

dictionaries/en_shared/cspell-tools.config.yaml

diff --git a/dictionaries/en_shared/cspell-tools.config.yaml b/dictionaries/en_shared/cspell-tools.config.yaml
index 18f3ae1c..4eeba553 100644
--- a/dictionaries/en_shared/cspell-tools.config.yaml
+++ b/dictionaries/en_shared/cspell-tools.config.yaml
@@ -11,6 +11,16 @@ targets:
     compress: false
     excludeWordsFrom:
       - src/exclude-words.txt
+  - name: 'shared-additional-words-ise'
+    sources:
+      - filename: src/shared-additional-words-ise.txt
+        split: true
+    format: plaintext
+    targetDirectory: './dict'
+    generateNonStrict: false
+    compress: false
+    excludeWordsFrom:
+      - src/exclude-words.txt
   - name: exclude-words
     sources:
       - filename: src/exclude-words.txt

[Jason3S]

dictionaries/en_shared/cspell-tools.config.yaml

Note: Due to the fork settings, I cannot submit change / updates. To apply the diff:

1. Download / copy the patch / diff into a file called patch_file.patch
2. Run the following command:

   git apply patch_file.patch

3. pnpm run setup - to build the simple dictionaries.

This should update the file for you.

It is needed otherwise the dictionaries will not build.

[ccoVeille]

Note: Due to the fork settings, I cannot submit change / updates. To apply the diff:

Yes, I know, it's because I use an organization for my forks.

I sent you an invite a few days ago to become a collaborator of my fork to mitigate the issue.

[Jason3S]

Note: Due to the fork settings, I cannot submit change / updates. To apply the diff:

Yes, I know, it's because I use an organization for my forks.

I sent you an invite a few days ago to become a collaborator of my fork to mitigate the issue.

Thank you. I didn't see it. I'll look.

[ccoVeille]

It should be OK now.

The PR can be reviewed.

[Jason3S]

Yes, it is now building! Thank you.