From 48e7382e13b857d9b8bc7cded5e865fd6c88405d Mon Sep 17 00:00:00 2001 From: "Jens A. Koch" Date: Thu, 20 Jun 2024 19:35:53 +0200 Subject: [PATCH] lets try the undocumented globRoot --- .github/workflows/check-spelling.yml | 2 +- build-tools/cspell/cspell.config.json | 68 +++++++++++++++++++++++++++ build-tools/cspell/cspell.config.yml | 46 ------------------ build-tools/cspell/repo-words.txt | 3 ++ cspell.json | 2 +- 5 files changed, 73 insertions(+), 48 deletions(-) create mode 100644 build-tools/cspell/cspell.config.json delete mode 100644 build-tools/cspell/cspell.config.yml diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml index 5867297..5b6162e 100644 --- a/.github/workflows/check-spelling.yml +++ b/.github/workflows/check-spelling.yml @@ -25,5 +25,5 @@ jobs: - name: 🙏 Check Spelling using cspell run: | - export CSPELL_OUTPUT=$(sudo cspell -c cspell.json --no-summary .) + export CSPELL_OUTPUT=$(sudo cspell lint --no-summary --no-progress .) if [ -n "$CSPELL_OUTPUT" ]; then echo "$CSPELL_OUTPUT" && exit 1; fi; \ No newline at end of file diff --git a/build-tools/cspell/cspell.config.json b/build-tools/cspell/cspell.config.json new file mode 100644 index 0000000..f904443 --- /dev/null +++ b/build-tools/cspell/cspell.config.json @@ -0,0 +1,68 @@ +{ + "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json", + "version": "0.2", + "id": "csgo-cli-cspell-config", + "name": "csgo-cli cspell Config", + "language": "en-US,de-DE", + "globRoot": "../../", + "files": [ + "*.md", + "docs/**/*.md", + "src/**/*.h", + "src/**/*.cpp", + "tests/**/*.h", + "tests/**/*.cpp" + ], + "ignorePaths": [ + ".git/*/**", + ".git/!(COMMIT_EDITMSG)", + ".vscode/**", + ".clang-format", + "*.lock", + "*.log", + "*.json", + "*.cmake", + "*.bat", + "Changelog.md", + "CMakeLists.txt", + "cspell.json", + "cspell*.{json,yaml}", + "node_modules/**", + "build-tools/**", + "cmake/**", + "dependencies/**", + "downloads/**", + "out/**", + "resources/**", + "vcpkg_packages/**", + "src/ShareCode.cpp", + "src/ShareCode.h", + "tests/ShareCodeUpload.tests.cpp", + "src/steamapi/steamapi.cpp", + "/src/VersionAndConstants.h.in" + ], + "dictionaryDefinitions": [ + { + "name": "repo-words", + "addWords": true, + "scope": [ + "workspace" + ], + "path": "./repo-words.txt", + "description": "A list of words related to this repository." + } + ], + "dictionaries": [ + "repo-words" + ], + "languageSettings": [ + { + "languageId": "*", + "allowCompoundWords": false + }, + { + "languageId": "markdown", + "caseSensitive": true + } + ] +} \ No newline at end of file diff --git a/build-tools/cspell/cspell.config.yml b/build-tools/cspell/cspell.config.yml deleted file mode 100644 index 77b5098..0000000 --- a/build-tools/cspell/cspell.config.yml +++ /dev/null @@ -1,46 +0,0 @@ -# yaml-language-server: $schema=https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json - -$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json -version: "0.2" -language: en-US,de-DE - -files: - - '*.md' - - docs/*.md - - src/**/*.h - - src/**/*.cpp - - tests/**/*.h - - tests/**/*.cpp -ignorePaths: - - .git/*/** - - .git/!(COMMIT_EDITMSG) - - .vscode - - .clang-format - - '*.lock' - - '*.log' - - '*.json' - - '*.cmake' - - cspell.json - - cspell*.{json,yaml} - - CMakeLists.txt - - /build-tools - - /cmake - - /dependencies - - /vcpkg_packages - - ./src/ShareCode.cpp - - ./src/ShareCode.h - - ./tests/ShareCodeUpload.tests.cpp -dictionaryDefinitions: - - name: repo-words - addWords: true - scope: - - workspace - path: ./repo-words.txt - description: A list of words related to this repository. -dictionaries: - - repo-words -languageSettings: - - languageId: '*' - allowCompoundWords: false - - languageId: 'markdown' - caseSensitive: true \ No newline at end of file diff --git a/build-tools/cspell/repo-words.txt b/build-tools/cspell/repo-words.txt index 0fe48f4..5c71714 100644 --- a/build-tools/cspell/repo-words.txt +++ b/build-tools/cspell/repo-words.txt @@ -1,7 +1,9 @@ accountid APIKEY +appveyor BINARYNAME bitnum +cloudflare cmake commentpermission communityvisibilitystate @@ -61,6 +63,7 @@ sharecode sharecodes Sharecodes spdlog +sqlite steamapi steamdb STEAMGAMECOORDINATOR diff --git a/cspell.json b/cspell.json index 4922808..2326b20 100644 --- a/cspell.json +++ b/cspell.json @@ -1,5 +1,5 @@ { "import": [ - "build-tools/cspell/cspell.config.yml" + "build-tools/cspell/cspell.config.json" ] } \ No newline at end of file