cspellの設定ファイルをワークスペースから独立させる (#1041)

* cspell.jsonを追加。 * maris.code-workspaceからcspellに関する設定を削除。 * README.mdのcSpellに関する記載を修正。 * 除外対象のパスを追加。 --------- Co-authored-by: Fumika Koyama <[email protected]>
AlesInfiny · Apr 5, 2024 · 71a76ce · 71a76ce
1 parent 48f1f67
commit 71a76ce
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 56 deletions.
diff --git a/cspell.json b/cspell.json
@@ -0,0 +1,65 @@
+{
+    "ignorePaths": [
+        "maris.code-workspace",
+        "cspell.json",
+        "package.json",
+        "package-lock.json",
+        "requirements.txt",
+        "mkdocs.yml",
+        "LICENSE",
+        "LICENSE-CODE",
+        "**/.eslintrc.cjs",
+        "**/.prettierrc.json",
+        "**/openapitools.json",
+        "**/iis-files/**",
+        "**/node_modules/**",
+        "**/build-artifacts/**",
+        ".vscode"
+    ],
+    "words": [
+        "Adoptium",
+        "AlesInfiny",
+        "appsettings",
+        "ASMX",
+        "ASPNETCore",
+        "BIPROGY",
+        "Blazor",
+        "cobertura",
+        "cref",
+        "drawio",
+        "dressca",
+        "EditorBrowsable",
+        "inheritdoc",
+        "langword",
+        "linenums",
+        "mkdocs",
+        "mssql",
+        "MVVM",
+        "nameof",
+        "Newtonsoft",
+        "Noto",
+        "nswag",
+        "openapi",
+        "paramref",
+        "pinia",
+        "Pymarkdown",
+        "Remoting",
+        "resx",
+        "SaaS",
+        "seealso",
+        "struct",
+        "StyleCop",
+        "stylelint",
+        "Swashbuckle",
+        "tailwindcss",
+        "textlint",
+        "typeof",
+        "typeparam",
+        "typeparamref",
+        "viewmodel",
+        "Vetur",
+        "vite",
+        "winbatch",
+        "xunit"
+    ]
+}
diff --git a/documents/README.md b/documents/README.md
@@ -166,7 +166,7 @@ cSpell の拡張機能をインストールしていると、 [問題] ウィン
 
 複合語や技術用語は、辞書登録しないと誤検知されることがあります。
 その場合はワークスペースの辞書に、単語を登録するようにしてください。
-[maris.code-workspace] ファイルの `settings` / `cSpell.words` に単語を登録できます。
+[cspell.json] ファイルの `words` に単語を登録できます。
 
 コード内や設定ファイル内の文字など、単語登録することが望ましくないと考える場合は、以下の記事を参照して、各ページで抑制してください。
 cSpell が実行されないようにするのではなく、そのページ内で使用する抑制しても良い単語を、ページの先頭に記述する方式で抑制しましょう。

diff --git a/maris.code-workspace b/maris.code-workspace
@@ -6,61 +6,6 @@
     ],
     "settings": {
         "tableformatter.common.centerAlignedHeader": false,
-        "cSpell.ignorePaths": [
-            "maris.code-workspace",
-            "package.json",
-            "package-lock.json",
-            "requirements.txt",
-            "**/node_modules/**",
-            "**/build-artifacts/**",
-            ".vscode",
-        ],
-        "cSpell.words": [
-            "Adoptium",
-            "AlesInfiny",
-            "appsettings",
-            "ASMX",
-            "ASPNETCore",
-            "BIPROGY",
-            "Blazor",
-            "cobertura",
-            "cref",
-            "drawio",
-            "dressca",
-            "EditorBrowsable",
-            "inheritdoc",
-            "langword",
-            "linenums",
-            "mkdocs",
-            "mssql",
-            "MVVM",
-            "nameof",
-            "Newtonsoft",
-            "Noto",
-            "nswag",
-            "openapi",
-            "paramref",
-            "pinia",
-            "Pymarkdown",
-            "Remoting",
-            "resx",
-            "SaaS",
-            "seealso",
-            "struct",
-            "StyleCop",
-            "stylelint",
-            "Swashbuckle",
-            "tailwindcss",
-            "textlint",
-            "typeof",
-            "typeparam",
-            "typeparamref",
-            "viewmodel",
-            "Vetur",
-            "vite",
-            "winbatch",
-            "xunit"
-        ],
         "markdownlint.ignore": [
             "LICENSE"
         ],