diff --git a/.github/cSpell/cspell.config.yml b/.github/cSpell/cspell.config.yml new file mode 100644 index 0000000..9f06ba1 --- /dev/null +++ b/.github/cSpell/cspell.config.yml @@ -0,0 +1,30 @@ +## +# @file +# cSpell configuration file. +# +# @copyright +# Copyright (c) 2025, Codevenience Organization. All rights reserved.
+# +# SPDX-License-Identifier: BSD-3-Clause +# +# @par Specification Reference: +# - https://cspell.org/docs/Configuration/properties +# +## + +$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json + +version: '0.2' + +dictionaryDefinitions: + - name: repo-dict + path: './repo-dict.txt' + addWords: true + +dictionaries: + - repo-dict + +ignorePaths: + - '**/node_modules/**' + # Ignore cSpell dictionary files and configuration files. + - '**/.github/cSpell/**' diff --git a/.github/cSpell/repo-dict.txt b/.github/cSpell/repo-dict.txt new file mode 100644 index 0000000..8b73f25 --- /dev/null +++ b/.github/cSpell/repo-dict.txt @@ -0,0 +1,16 @@ +## +# @file +# Dictionary file for repository specific commands and terminologies. +# +# @copyright +# Copyright (c) 2025, Codevenience Organization. All rights reserved.
+# +# SPDX-License-Identifier: BSD-3-Clause +# +# @par Specification Reference: +# +## + +Codevenience + +retval diff --git a/.github/workflows/spelling-check.yml b/.github/workflows/spelling-check.yml new file mode 100644 index 0000000..7dce93a --- /dev/null +++ b/.github/workflows/spelling-check.yml @@ -0,0 +1,52 @@ +## +# @file +# Configuration file to check the spelling. +# +# @copyright +# Copyright (c) 2025, Codevenience Organization. All rights reserved.
+# +# SPDX-License-Identifier: BSD-3-Clause +# +# @par Specification Reference: +# +## + +name: Quality - Spelling Check + +on: + push: + pull_request: + types: [opened, reopened] + +jobs: + spelling-check: + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest] + + runs-on : ${{ matrix.os }} + + steps: + - name: Checkout the repository and commit + uses: actions/checkout@v3 + with: + submodules: 'recursive' + fetch-depth: 0 + lfs: true + + - name: Checkout LFS objects + run: git lfs checkout + + - uses: streetsidesoftware/cspell-action@v6 + with: + files: '**' + check_dot_files: explicit + root: '.' + treat_flagged_words_as_errors: true + suggestions: true + strict: true + incremental_files_only: false + config: './.github/cSpell/cspell.config.yml' + verbose: true + use_cspell_files: false