chore: clarify where files should be stored. (#1698)

streetsidesoftware · Dec 8, 2022 · 6567bc6 · 6567bc6
1 parent b903ba1
commit 6567bc6
Show file tree

Hide file tree

Showing 69 changed files with 213 additions and 0 deletions.
diff --git a/dictionaries/ada/dict/README.md b/dictionaries/ada/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/ada/src/README.md b/dictionaries/ada/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/ar/src/README.md b/dictionaries/ar/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/bash/dict/README.md b/dictionaries/bash/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/bash/src/README.md b/dictionaries/bash/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/bg_BG/dict/README.md b/dictionaries/bg_BG/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/bg_BG/src/README.md b/dictionaries/bg_BG/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/ca/src/README.md b/dictionaries/ca/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/clojure/src/README.md b/dictionaries/clojure/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/companies/dict/README.md b/dictionaries/companies/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/companies/src/README.md b/dictionaries/companies/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/cpp/src/README.md b/dictionaries/cpp/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/cs_CZ/src/README.md b/dictionaries/cs_CZ/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/css/dict/README.md b/dictionaries/css/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/css/src/README.md b/dictionaries/css/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/dart/src/README.md b/dictionaries/dart/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/de_CH/src/README.md b/dictionaries/de_CH/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/de_DE/src/README.md b/dictionaries/de_DE/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/django/dict/README.md b/dictionaries/django/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/django/src/README.md b/dictionaries/django/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/docker/src/README.md b/dictionaries/docker/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/dotnet/dict/README.md b/dictionaries/dotnet/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/dotnet/src/README.md b/dictionaries/dotnet/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/el/src/README.md b/dictionaries/el/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/elixir/dict/README.md b/dictionaries/elixir/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/elixir/src/README.md b/dictionaries/elixir/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/en_GB-MIT/src/README.md b/dictionaries/en_GB-MIT/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/en_GB/src/README.md b/dictionaries/en_GB/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/en_US/src/README.md b/dictionaries/en_US/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/es_ES/src/README.md b/dictionaries/es_ES/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/et-EE/src/README.md b/dictionaries/et-EE/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/fr_FR/src/README.md b/dictionaries/fr_FR/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/fr_FR_90/src/README.md b/dictionaries/fr_FR_90/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/gaming-terms/dict/README.md b/dictionaries/gaming-terms/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/gaming-terms/src/README.md b/dictionaries/gaming-terms/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/golang/dict/README.md b/dictionaries/golang/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/golang/src/README.md b/dictionaries/golang/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/haskell/dict/README.md b/dictionaries/haskell/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/haskell/src/README.md b/dictionaries/haskell/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/html/src/README.md b/dictionaries/html/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/java/src/README.md b/dictionaries/java/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/markdown/src/README.md b/dictionaries/markdown/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/mnemonics/src/README.md b/dictionaries/mnemonics/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/monkeyc/src/README.md b/dictionaries/monkeyc/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/nb_NO/src/README.md b/dictionaries/nb_NO/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/nl_NL/src/README.md b/dictionaries/nl_NL/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/node/dict/README.md b/dictionaries/node/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/npm/dict/README.md b/dictionaries/npm/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/npm/src/README.md b/dictionaries/npm/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/php/dict/README.md b/dictionaries/php/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/pt_BR/src/README.md b/dictionaries/pt_BR/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/public-licenses/src/README.md b/dictionaries/public-licenses/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/python/src/README.md b/dictionaries/python/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/r/src/README.md b/dictionaries/r/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/ru_RU/src/README.md b/dictionaries/ru_RU/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/shell/dict/README.md b/dictionaries/shell/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/shell/src/README.md b/dictionaries/shell/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/sl_SI/src/README.md b/dictionaries/sl_SI/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/software-terms/dict/README.md b/dictionaries/software-terms/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/sql/src/README.md b/dictionaries/sql/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/svelte/dict/README.md b/dictionaries/svelte/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/dictionaries/svelte/src/README.md b/dictionaries/svelte/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/swift/src/README.md b/dictionaries/swift/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/dictionaries/typescript/dict/README.md b/dictionaries/typescript/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/generator-cspell-dicts/generators/app/index.js b/generator-cspell-dicts/generators/app/index.js
@@ -136,6 +136,8 @@ module.exports = class extends Generator {
             'cspell.json',
             'LICENSE',
             'cspell-tools.config.yaml',
+            'dict/README.md',
+            'src/README.md',
         ];
         files.forEach((fromTo) => {
             fromTo = typeof fromTo === 'string' ? [fromTo, fromTo] : fromTo;

diff --git a/generator-cspell-dicts/generators/app/templates/dict/README.md b/generator-cspell-dicts/generators/app/templates/dict/README.md
@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
diff --git a/generator-cspell-dicts/generators/app/templates/src/README.md b/generator-cspell-dicts/generators/app/templates/src/README.md
@@ -0,0 +1,3 @@
+# Source Directory
+
+All source files used to generate the dictionary should be stored in this directory.
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
   "devDependencies": {
     "@cspell/cspell-tools": "6.17.0",
     "@lerna-lite/cli": "^1.13.0",
+    "@lerna-lite/exec": "^1.13.0",
     "@lerna-lite/run": "^1.13.0",
     "conventional-changelog-conventionalcommits": "^5.0.0",
     "cpy-cli": "^4.2.0",

diff --git a/yarn.lock b/yarn.lock
@@ -239,6 +239,18 @@
     write-json-file "^4.3.0"
     write-pkg "^4.0.0"
 
+"@lerna-lite/exec@^1.13.0":
+  version "1.13.0"
+  resolved "https://registry.npmjs.org/@lerna-lite/exec/-/exec-1.13.0.tgz#898ded67932520de3291a02687dee7749507ce34"
+  integrity sha512-vLeToiu/kf8p4bGiAajI/2rIqRMTBviSQlNQig0/YtPJJSHcwOSI1OB9ZVJTUdnivpRKSh2fa8JMIFih1uBozQ==
+  dependencies:
+    "@lerna-lite/core" "1.13.0"
+    "@lerna-lite/optional-cmd-common" "1.13.0"
+    chalk "^4.1.2"
+    dotenv "^16.0.3"
+    npmlog "^7.0.1"
+    p-map "^4.0.0"
+
 "@lerna-lite/[email protected]":
   version "1.13.0"
   resolved "https://registry.npmjs.org/@lerna-lite/info/-/info-1.13.0.tgz#4f3d428a66819efae6fd8365186befc5dbf99511"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Dict Directory

		NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Source Directory

		All source files used to generate the dictionary should be stored in this directory.