├── .editorconfig ├── .github ├── FUNDING.yml ├── actions │ ├── github-app-token │ │ └── action.yaml │ ├── pr │ │ └── action.yaml │ └── setup │ │ └── action.yaml ├── dependabot.yml ├── release.yml └── workflows │ ├── codeql-analysis.yml │ ├── cspell-action.yml │ ├── publish-docker-image.yml │ ├── release-please.yml │ ├── test.yml │ ├── update-cspell.yml │ ├── update-dependabot.yml │ └── update-dependencies.yml ├── .gitignore ├── .pre-commit-hooks.yaml ├── .prettierignore ├── .release-please-manifest.json ├── CHANGELOG.md ├── Dockerfile ├── LICENSE ├── README.md ├── SECURITY.md ├── cspell.json ├── docker └── german │ ├── Dockerfile │ ├── README.md │ └── cspell.config.yaml ├── index.js ├── package-lock.json ├── package.json ├── release-please-config.json └── static ├── help-check.txt ├── help-link.txt ├── help-lint.txt ├── help-suggestions.txt ├── help-trace.txt └── help.txt /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 4 6 | end_of_line = lf 7 | charset = utf-8 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | 11 | [*.CRLF.txt] 12 | end_of_line = crlf 13 | 14 | [*.noEOL.txt] 15 | insert_final_newline = false 16 | 17 | [*.{yaml,yml}] 18 | indent_size = 2 19 | 20 | [*.{json,jsonc}] 21 | indent_size = 2 22 | 23 | [*.md] 24 | indent_size = 2 25 | trim_trailing_whitespace = false 26 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | patreon: streetsidesoftware 4 | tidelift: "npm/cspell" 5 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 6 | - streetsidesoftware 7 | open_collective: cspell 8 | # ko_fi: # Replace with a single Ko-fi username 9 | # community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 10 | # liberapay: # Replace with a single Liberapay username 11 | # issuehunt: # Replace with a single IssueHunt username 12 | # otechie: # Replace with a single Otechie username 13 | # custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | 15 | # cspell:ignore issuehunt 16 | -------------------------------------------------------------------------------- /.github/actions/github-app-token/action.yaml: -------------------------------------------------------------------------------- 1 | name: github_app_token 2 | description: Create a token for making Pull Requests 3 | 4 | # Note: this just calls tibdex/github-app-token, but it allows us to keep it in one place. 5 | 6 | inputs: 7 | app_id: 8 | description: Application ID used to make the PR 9 | required: true 10 | app_private_key: 11 | description: Application Private Key used to sign the PR 12 | required: true 13 | outputs: 14 | token: 15 | description: A token for making Pull Requests 16 | value: ${{ steps.generate-token.outputs.token }} 17 | runs: 18 | using: "composite" 19 | steps: 20 | - uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # v1.5 # cspell:ignore tibdex 21 | id: generate-token 22 | with: 23 | app_id: ${{ inputs.app_id }} 24 | private_key: ${{ inputs.app_private_key }} 25 | -------------------------------------------------------------------------------- /.github/actions/pr/action.yaml: -------------------------------------------------------------------------------- 1 | name: create_pr 2 | description: Create A Pull Request That will Trigger Workflows 3 | inputs: 4 | base: 5 | description: The Base Ref to apply the diff 6 | required: false 7 | body: 8 | description: Optional body of the PR 9 | required: false 10 | commit-message: 11 | description: Commit Message for the PR 12 | required: true 13 | branch: 14 | description: The Branch to create for the PR 15 | required: true 16 | title: 17 | description: PR title - defaults to commit-message 18 | required: false 19 | app_id: 20 | description: Application ID used to make the PR 21 | required: true 22 | app_private_key: 23 | description: Application Private Key used to sign the PR 24 | required: true 25 | runs: 26 | using: "composite" 27 | steps: 28 | - name: Has changes 29 | shell: bash 30 | run: | 31 | git --no-pager diff --compact-summary --exit-code && echo "git_status=clean" >> $GITHUB_ENV || echo "git_status=dirty" >> $GITHUB_ENV 32 | git --no-pager diff --compact-summary 33 | - name: Gen Body 34 | shell: bash 35 | env: 36 | BODY: ${{ inputs.body }} 37 | run: | 38 | echo 'git_body<> $GITHUB_ENV 39 | echo "$BODY" >> $GITHUB_ENV 40 | git --no-pager diff --compact-summary >> $GITHUB_ENV 41 | echo 'DIFF' >> $GITHUB_ENV 42 | - name: Echo git_status 43 | shell: bash 44 | run: echo "${{ env.git_status }}" 45 | 46 | - name: Body 47 | shell: bash 48 | run: | 49 | echo "$git_body" 50 | 51 | - uses: ./.github/actions/github-app-token 52 | if: env.git_status == 'dirty' 53 | id: generate-token 54 | with: 55 | app_id: ${{ inputs.app_id }} 56 | app_private_key: ${{ inputs.app_private_key }} 57 | 58 | - name: Create Pull Request 59 | if: env.git_status == 'dirty' 60 | uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v4 61 | with: 62 | commit-message: ${{ inputs.commit-message }} 63 | branch: ${{ inputs.branch }} 64 | base: ${{ inputs.base }} 65 | title: ${{ inputs.title || inputs.commit-message }} 66 | token: ${{ steps.generate-token.outputs.token }} 67 | body: ${{ env.git_body }} 68 | delete-branch: true 69 | -------------------------------------------------------------------------------- /.github/actions/setup/action.yaml: -------------------------------------------------------------------------------- 1 | name: setup_node 2 | description: Setup Node, and install Npm 3 | inputs: 4 | node-version: 5 | required: false 6 | description: The version of Node to use. 7 | default: "22.x" 8 | runs: 9 | using: "composite" 10 | steps: 11 | - name: Use Node.js ${{ inputs.node-version }} 12 | uses: actions/setup-node@v4 13 | with: 14 | registry-url: "https://registry.npmjs.org" 15 | node-version: ${{ inputs.node-version }} 16 | cache: "npm" 17 | - name: NPM Version 18 | run: npm -v; 19 | shell: bash 20 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "npm" # See documentation for possible values 9 | directory: "/" # Location of package manifests 10 | schedule: 11 | interval: "weekly" 12 | 13 | - package-ecosystem: "github-actions" 14 | # Workflow files stored in the 15 | # default location of `.github/workflows` 16 | directory: "/" 17 | schedule: 18 | interval: "daily" 19 | 20 | - package-ecosystem: "npm" # See documentation for possible values 21 | directory: "/" # Location of package manifests 22 | target-branch: "cspell4" 23 | schedule: 24 | interval: "weekly" 25 | 26 | - package-ecosystem: "github-actions" 27 | # Workflow files stored in the 28 | # default location of `.github/workflows` 29 | directory: "/" 30 | target-branch: "cspell4" 31 | schedule: 32 | interval: "daily" 33 | 34 | # Automatically added by streetsidesoftware/public/update-dependabot-github-actions 35 | - package-ecosystem: github-actions 36 | directory: /.github/actions/setup 37 | schedule: 38 | interval: daily 39 | commit-message: 40 | prefix: ci 41 | 42 | # Automatically added by streetsidesoftware/public/update-dependabot-github-actions 43 | - package-ecosystem: github-actions 44 | directory: /.github/actions/pr 45 | schedule: 46 | interval: daily 47 | commit-message: 48 | prefix: ci 49 | 50 | # Automatically added by streetsidesoftware/public/update-dependabot-github-actions 51 | - package-ecosystem: github-actions 52 | directory: /.github/actions/github-app-token 53 | schedule: 54 | interval: daily 55 | commit-message: 56 | prefix: ci 57 | -------------------------------------------------------------------------------- /.github/release.yml: -------------------------------------------------------------------------------- 1 | # .github/release.yml 2 | 3 | changelog: 4 | exclude: 5 | categories: 6 | - title: Breaking Changes 7 | labels: 8 | - Semver-Major 9 | - breaking 10 | - title: Features 11 | labels: 12 | - Semver-Minor 13 | - feature 14 | - title: Fixes 15 | labels: 16 | - fix 17 | - dev 18 | - title: Other Changes 19 | labels: 20 | - "*" 21 | - title: Maintenance 22 | labels: 23 | - chore 24 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | - cspell4 8 | pull_request: 9 | branches: 10 | - main 11 | - cspell4 12 | workflow_dispatch: 13 | schedule: 14 | - cron: "0 23 * * 0" 15 | 16 | jobs: 17 | analyze: 18 | name: Analyze 19 | runs-on: ubuntu-latest 20 | 21 | steps: 22 | - name: Checkout repository 23 | uses: actions/checkout@v4 24 | with: 25 | # Make sure it goes back far enough to find where the branch split from main 26 | fetch-depth: 20 27 | 28 | - name: Initialize CodeQL 29 | uses: github/codeql-action/init@v3 30 | with: 31 | languages: "javascript" 32 | 33 | - name: Perform CodeQL Analysis 34 | uses: github/codeql-action/analyze@v3 35 | -------------------------------------------------------------------------------- /.github/workflows/cspell-action.yml: -------------------------------------------------------------------------------- 1 | name: cspell-action 2 | on: 3 | pull_request: 4 | push: 5 | branches: 6 | - main 7 | workflow_dispatch: 8 | 9 | jobs: 10 | cspell: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4 14 | - uses: streetsidesoftware/cspell-action@v7 15 | with: 16 | files: "." 17 | incremental_files_only: false 18 | check_dot_files: true 19 | -------------------------------------------------------------------------------- /.github/workflows/publish-docker-image.yml: -------------------------------------------------------------------------------- 1 | # GitHub recommends pinning actions to a commit SHA. 2 | # To get a newer version, you will need to update the SHA. 3 | # You can also reference a tag or branch, but the action may change without warning. 4 | 5 | name: " 📦 Publish Docker Images" 6 | 7 | on: 8 | workflow_dispatch: 9 | inputs: 10 | dryRun: 11 | description: "Dry Run" 12 | type: choice 13 | options: 14 | - "yes" 15 | - "no" 16 | default: "no" 17 | required: false 18 | workflow_call: 19 | 20 | env: 21 | REGISTRY: ghcr.io 22 | IMAGE_NAME: "streetsidesoftware/cspell" 23 | 24 | permissions: 25 | contents: read 26 | packages: write 27 | 28 | jobs: 29 | build-and-push-image: 30 | runs-on: ubuntu-latest 31 | 32 | env: 33 | DEBUG: ${{ github.event.inputs.dryRun == 'yes'}} 34 | 35 | steps: 36 | - name: Checkout repository 37 | uses: actions/checkout@v4 38 | 39 | - name: CSpell Version 40 | run: | 41 | export CSPELL_VERSION=$(jq -r ".dependencies.cspell | sub(\"[_^]\"; \"\")" package.json) 42 | echo CSPELL_VERSION=$CSPELL_VERSION >> $GITHUB_ENV 43 | 44 | - name: Log in to the Container registry 45 | uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 46 | with: 47 | registry: ${{ env.REGISTRY }} 48 | username: ${{ github.actor }} 49 | password: ${{ secrets.GITHUB_TOKEN }} 50 | 51 | - name: Extract metadata (tags, labels) for Docker 52 | id: meta 53 | uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 54 | with: 55 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 56 | tags: | 57 | type=semver,pattern={{version}},value=${{ env.CSPELL_VERSION }} 58 | labels: | 59 | org.opencontainers.image.title=cspell 60 | org.opencontainers.image.description=CSpell command line spell checker for code and other documents. 61 | org.opencontainers.image.vendor=Street Side Software 62 | 63 | - name: Log Docker metadata 64 | env: 65 | META: $${{ toJSON(steps.meta.outputs) }} 66 | run: echo "$META" 67 | 68 | - name: Build and push Docker image 69 | uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 70 | if: ${{ env.DEBUG != 'true' }} 71 | with: 72 | context: . 73 | push: true 74 | tags: ${{ steps.meta.outputs.tags }} 75 | labels: ${{ steps.meta.outputs.labels }} 76 | # cspell:ignore opencontainers 77 | -------------------------------------------------------------------------------- /.github/workflows/release-please.yml: -------------------------------------------------------------------------------- 1 | name: " 🚀 release-please" 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | workflow_dispatch: 8 | 9 | permissions: 10 | contents: write 11 | pull-requests: write 12 | id-token: write 13 | 14 | jobs: 15 | release-please: 16 | runs-on: ubuntu-latest 17 | outputs: 18 | release_created: ${{ steps.release.outputs.release_created }} 19 | steps: 20 | - uses: googleapis/release-please-action@v4 21 | id: release 22 | with: 23 | config-file: release-please-config.json 24 | manifest-file: .release-please-manifest.json 25 | 26 | # cspell:ignore noreply googleapis 27 | 28 | publish: 29 | runs-on: ubuntu-latest 30 | needs: 31 | - release-please 32 | if: ${{ needs.release-please.outputs.release_created }} 33 | steps: 34 | # The logic below handles the npm publication: 35 | - uses: actions/checkout@v4 36 | - name: Setup 37 | uses: ./.github/actions/setup 38 | with: 39 | node-version: ${{ matrix.node-version }} 40 | 41 | - run: npm ci 42 | 43 | - run: npm publish 44 | env: 45 | NODE_AUTH_TOKEN: ${{secrets.PUBLISH_NPM}} 46 | 47 | publish-docker: 48 | permissions: 49 | contents: write 50 | packages: write 51 | needs: 52 | - release-please 53 | uses: ./.github/workflows/publish-docker-image.yml 54 | if: ${{ needs.release-please.outputs.release_created }} 55 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: " 🧪 Test" 2 | on: 3 | pull_request: 4 | push: 5 | branches: 6 | - main 7 | workflow_dispatch: 8 | 9 | jobs: 10 | test-node-versions: 11 | runs-on: ${{ matrix.os }} 12 | 13 | strategy: 14 | matrix: 15 | node-version: 16 | # List of supported node versions (latest is tested in `test-os`) 17 | - 20.x 18 | - 22.x 19 | - 23.x 20 | 21 | os: 22 | - ubuntu-latest 23 | 24 | steps: 25 | - uses: actions/checkout@v4 26 | 27 | - name: Setup 28 | uses: ./.github/actions/setup 29 | with: 30 | node-version: ${{ matrix.node-version }} 31 | 32 | - run: npm -v 33 | - run: npm ci --omit=dev 34 | - run: npm test 35 | 36 | # Ensure the repository is clean after build & test 37 | - run: git --no-pager diff --compact-summary --exit-code 38 | 39 | test-os: 40 | runs-on: ${{ matrix.os }} 41 | 42 | strategy: 43 | matrix: 44 | node-version: 45 | # Test the latest node version here, move older versions to `test-old-node-versions` 46 | - 22.x 47 | 48 | os: 49 | - windows-latest 50 | # - macos-latest 51 | 52 | steps: 53 | - uses: actions/checkout@v4 54 | 55 | - name: Setup 56 | uses: ./.github/actions/setup 57 | with: 58 | node-version: ${{ matrix.node-version }} 59 | 60 | - run: npm ci --omit=dev 61 | - run: npm test 62 | 63 | # Ensure the repository is clean after build & test 64 | - run: git --no-pager diff --compact-summary --exit-code 65 | 66 | test-docker: 67 | runs-on: ubuntu-latest 68 | 69 | steps: 70 | - uses: actions/checkout@v4 71 | - run: docker build -t cspell . 72 | - run: docker run -v $(pwd):/workdir cspell 73 | -------------------------------------------------------------------------------- /.github/workflows/update-cspell.yml: -------------------------------------------------------------------------------- 1 | name: " 📚 Update CSpell" 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | base: 7 | description: The Base Ref to apply the diff 8 | required: false 9 | default: "main" 10 | 11 | push: 12 | branches: 13 | - main 14 | paths: 15 | - "**/package.json" 16 | - "**/package-lock.json" 17 | 18 | schedule: 19 | - cron: "0 7 * * *" 20 | 21 | jobs: 22 | update-cspell: 23 | if: github.repository_owner == 'streetsidesoftware' 24 | runs-on: ubuntu-latest 25 | env: 26 | NEW_BRANCH: update-cspell-${{ inputs.base || 'main' }} 27 | REF_BRANCH: ${{ inputs.base || 'main' }} 28 | steps: 29 | - name: Start 30 | env: 31 | EVENT_INPUTS: ${{ toJson(github.event.inputs) }} 32 | run: | 33 | echo "$EVENT_INPUTS" 34 | 35 | - name: Checkout code 36 | uses: actions/checkout@v4 37 | with: 38 | ref: ${{ env.REF_BRANCH }} 39 | 40 | - name: Setup 41 | uses: ./.github/actions/setup 42 | with: 43 | node-version: 22.x 44 | 45 | - name: Install 46 | run: | 47 | npm i 48 | 49 | - name: CSpell Old Version 50 | run: echo CSPELL_VERSION_OLD=$(npx cspell -V) >> $GITHUB_ENV 51 | 52 | - name: Update CSpell to latest 53 | run: | 54 | npm i cspell@latest 55 | 56 | - name: CSpell Version 57 | run: echo CSPELL_VERSION=$(npx cspell -V) >> $GITHUB_ENV 58 | 59 | - name: Minor Versions 60 | run: | 61 | echo CSPELL_MINOR_OLD=$(echo '"${{ env.CSPELL_VERSION_OLD }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV 62 | echo CSPELL_MINOR_NEW=$(echo '"${{ env.CSPELL_VERSION }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV 63 | 64 | - name: Determine Update type 65 | env: 66 | type: ${{ (env.CSPELL_MINOR_OLD == env.CSPELL_MINOR_NEW && 'fix') || 'feat' }} 67 | run: | 68 | echo PR_TYPE=$type >> $GITHUB_ENV 69 | 70 | - name: Install 71 | run: npm install 72 | 73 | - name: Update Readme 74 | run: | 75 | npm run build:readme 76 | npm run lint:fix 77 | 78 | - name: Git Status 79 | id: git-status 80 | uses: streetsidesoftware/actions/public/dirty@v1 81 | 82 | - name: Echo git_status 83 | env: 84 | REPORT: | 85 | Dirty: ${{ steps.git-status.outputs.isDirty && 'yes' || 'no' }} 86 | CSpell Version: ${{ env.CSPELL_VERSION }} 87 | Old Version: ${{ env.CSPELL_VERSION_OLD }} 88 | run: | 89 | echo "$REPORT" 90 | 91 | - name: CSpell Version Msg 92 | id: cspell_version_msg 93 | uses: streetsidesoftware/actions/public/output@v1 94 | with: 95 | value: CSpell version (${{ env.CSPELL_VERSION }}) 96 | 97 | - name: Commit Message 98 | id: commit_message 99 | uses: streetsidesoftware/actions/public/output@v1 100 | with: 101 | value: >- 102 | Update ${{ steps.cspell_version_msg.outputs.value }} 103 | 104 | - name: Gen PR Body 105 | id: body 106 | uses: streetsidesoftware/actions/public/pr-body@v1 107 | with: 108 | title: ${{ steps.commit_message.outputs.value }} 109 | message: | 110 | **CSpell Version:** ${{ env.CSPELL_VERSION_OLD }} -> ${{ env.CSPELL_VERSION }} 111 | **Type:** ${{ env.PR_TYPE }} 112 | path: >- 113 | package.json 114 | 115 | - name: Show Summary 116 | uses: streetsidesoftware/actions/public/summary@v1 117 | with: 118 | text: | 119 | ${{ steps.body.outputs.body }} 120 | 121 | **Status:** ${{ steps.git-status.outputs.isDirty && 'dirty' || 'clean' }} 122 | 123 | ## Changes: 124 | 125 | ``` 126 | ${{ steps.git-status.outputs.status }} 127 | ``` 128 | 129 | - name: PR 130 | if: steps.git-status.outputs.isDirty 131 | uses: streetsidesoftware/actions/.github/actions/pr@v1 132 | with: 133 | commit-message: "${{ env.PR_TYPE }}: ${{ steps.commit_message.outputs.value }}" 134 | branch: ${{ env.NEW_BRANCH }} 135 | base: ${{ env.REF_BRANCH }} 136 | title: "${{ env.PR_TYPE }}: ${{ steps.commit_message.outputs.value }}" 137 | body: ${{ steps.body.outputs.body }} 138 | app_id: ${{ secrets.AUTOMATION_APP_ID }} 139 | app_private_key: ${{ secrets.AUTOMATION_PRIVATE_KEY }} 140 | -------------------------------------------------------------------------------- /.github/workflows/update-dependabot.yml: -------------------------------------------------------------------------------- 1 | name: " 🤖 Update Dependabot" 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | base: 7 | description: The Base Ref to apply the diff 8 | required: false 9 | default: "main" 10 | 11 | schedule: 12 | - cron: "0 12 * * *" 13 | 14 | permissions: 15 | contents: read 16 | 17 | jobs: 18 | update-dependabot: 19 | runs-on: ubuntu-latest 20 | env: 21 | NEW_BRANCH: update-dependabot-${{ inputs.base || 'main' }} 22 | REF_BRANCH: ${{ inputs.base || 'main' }} 23 | PR_TYPE: ci 24 | steps: 25 | - name: Checkout code 26 | uses: actions/checkout@v4 27 | with: 28 | ref: ${{ env.REF_BRANCH }} 29 | 30 | - name: Setup 31 | uses: ./.github/actions/setup 32 | 33 | - name: Run Action 34 | id: dependabot 35 | uses: streetsidesoftware/actions/public/update-dependabot-github-actions@v1 36 | with: 37 | prefix: ci 38 | 39 | - name: Echo Result 40 | env: 41 | SUMMARY: ${{ steps.dependabot.outputs.summary }} 42 | run: | 43 | echo "$SUMMARY" 44 | 45 | - name: Prettier 46 | run: | 47 | npm i 48 | npx prettier .github/dependabot.yml --write 49 | 50 | - name: PR 51 | uses: streetsidesoftware/actions/.github/actions/pr@v1 52 | with: 53 | commit-message: "${{ env.PR_TYPE }}: Workflow Bot -- Update dependabot.yml" 54 | branch: ${{ env.NEW_BRANCH }} 55 | base: ${{ env.REF_BRANCH }} 56 | title: "${{ env.PR_TYPE }}: Workflow Bot -- Update dependabot.yml (${{ env.REF_BRANCH }})" 57 | body: ${{ steps.dependabot.outputs.summary }} 58 | app_id: ${{ secrets.AUTOMATION_APP_ID }} 59 | app_private_key: ${{ secrets.AUTOMATION_PRIVATE_KEY }} 60 | -------------------------------------------------------------------------------- /.github/workflows/update-dependencies.yml: -------------------------------------------------------------------------------- 1 | name: " 🔗 Update Dependencies Main" 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | base: 7 | description: The Base Ref to apply the diff 8 | required: false 9 | default: "main" 10 | 11 | push: 12 | branches: 13 | - main 14 | paths: 15 | - "**/package.json" 16 | - "**/package-lock.json" 17 | 18 | schedule: 19 | - cron: "0 12 * * 0" 20 | 21 | jobs: 22 | update-dependencies: 23 | if: github.repository_owner == 'streetsidesoftware' 24 | runs-on: ubuntu-latest 25 | env: 26 | NEW_BRANCH: update-dependencies-${{ inputs.base || 'main' }} 27 | REF_BRANCH: ${{ inputs.base || 'main' }} 28 | steps: 29 | - name: Start 30 | env: 31 | EVENT_INPUTS: ${{ toJson(github.event.inputs) }} 32 | run: | 33 | echo "$EVENT_INPUTS" 34 | 35 | - name: Checkout code 36 | uses: actions/checkout@v4 37 | with: 38 | ref: ${{ env.REF_BRANCH }} 39 | 40 | - name: Setup 41 | uses: ./.github/actions/setup 42 | with: 43 | node-version: 22.x 44 | 45 | - name: Update Root 46 | run: | 47 | npm i 48 | npx npm-check-updates -t semver -u 49 | rm -rf node_modules package-lock.json 50 | 51 | - name: Install 52 | run: npm install 53 | 54 | - name: Lint Fix 55 | run: | 56 | npm run lint:fix 57 | 58 | - name: Git Status 59 | id: git-status 60 | uses: streetsidesoftware/actions/public/dirty@v1 61 | 62 | - name: Gen PR Body 63 | id: body 64 | uses: streetsidesoftware/actions/public/pr-body@v1 65 | with: 66 | title: Update Dependencies 67 | path: >- 68 | package.json 69 | 70 | - name: Show Summary 71 | uses: streetsidesoftware/actions/public/summary@v1 72 | with: 73 | text: | 74 | ${{ steps.body.outputs.body }} 75 | 76 | **Status:** ${{ steps.git-status.outputs.isDirty && 'dirty' || 'clean' }} 77 | 78 | - name: PR 79 | uses: streetsidesoftware/actions/.github/actions/pr@v1 80 | with: 81 | commit-message: "chore: Workflow Bot -- Update ALL Dependencies" 82 | branch: ${{ env.NEW_BRANCH }} 83 | base: ${{ env.REF_BRANCH }} 84 | title: "chore: Workflow Bot -- Update ALL Dependencies (${{ env.REF_BRANCH }})" 85 | body: ${{ steps.body.outputs.body }} 86 | app_id: ${{ secrets.AUTOMATION_APP_ID }} 87 | app_private_key: ${{ secrets.AUTOMATION_PRIVATE_KEY }} 88 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | -------------------------------------------------------------------------------- /.pre-commit-hooks.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # For use with pre-commit. 3 | # See usage instructions at http://pre-commit.com 4 | 5 | - id: cspell 6 | name: cspell 7 | description: This hook runs CSpell spellchecker 8 | entry: cspell-cli 9 | language: node 10 | types: [text] 11 | args: 12 | - --no-must-find-files 13 | - --no-progress 14 | - --no-summary 15 | - --gitignore 16 | - --files # this needs to be the last argument so that the paths are passed correctly. 17 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | CHANGELOG.md 2 | -------------------------------------------------------------------------------- /.release-please-manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | ".": "9.0.1" 3 | } 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. 4 | 5 | ## [9.0.1](https://github.com/streetsidesoftware/cspell-cli/compare/v9.0.0...v9.0.1) (2025-05-08) 6 | 7 | 8 | ### Trivial updates and changes. 9 | 10 | * Update CSpell version (9.0.1) ([#672](https://github.com/streetsidesoftware/cspell-cli/issues/672)) ([5071a49](https://github.com/streetsidesoftware/cspell-cli/commit/5071a49979588532d07643b54c711ef054b149cd)) 11 | 12 | ## [9.0.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.19.1...v9.0.0) (2025-05-07) 13 | 14 | 15 | ### ⚠ BREAKING CHANGES 16 | 17 | * Upgrade to CSpell 9.0.0 ([#670](https://github.com/streetsidesoftware/cspell-cli/issues/670)) 18 | 19 | ### Features 20 | 21 | * Upgrade to CSpell 9.0.0 ([#670](https://github.com/streetsidesoftware/cspell-cli/issues/670)) ([280c047](https://github.com/streetsidesoftware/cspell-cli/commit/280c047d11796bb778f1199c4bb6ba8c5e05a7f6)) 22 | 23 | ## [8.19.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.19.0...v8.19.1) (2025-05-05) 24 | 25 | 26 | ### Trivial updates and changes. 27 | 28 | * Update CSpell version (8.19.3) ([#665](https://github.com/streetsidesoftware/cspell-cli/issues/665)) ([df04f04](https://github.com/streetsidesoftware/cspell-cli/commit/df04f0435b2e26c81402981721f1b0aa3b720fd2)) 29 | * Update CSpell version (8.19.4) ([#668](https://github.com/streetsidesoftware/cspell-cli/issues/668)) ([c68a53e](https://github.com/streetsidesoftware/cspell-cli/commit/c68a53ef455f56b64d27eab09e19bbbd6c078c7f)) 30 | 31 | ## [8.19.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.18.0...v8.19.0) (2025-04-19) 32 | 33 | 34 | ### Features 35 | 36 | * Update CSpell version (8.19.0) ([#659](https://github.com/streetsidesoftware/cspell-cli/issues/659)) ([df109a3](https://github.com/streetsidesoftware/cspell-cli/commit/df109a3a8704fa07ccf576620f318ed60e8e4cc7)) 37 | 38 | 39 | ### Trivial updates and changes. 40 | 41 | * Update CSpell version (8.19.1) ([#661](https://github.com/streetsidesoftware/cspell-cli/issues/661)) ([af89c7e](https://github.com/streetsidesoftware/cspell-cli/commit/af89c7e7d79889a2c00ade522f443d98b7329e71)) 42 | 43 | ## [8.18.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.17.3...v8.18.0) (2025-04-18) 44 | 45 | 46 | ### Features 47 | 48 | * Update CSpell version (8.18.0) ([#648](https://github.com/streetsidesoftware/cspell-cli/issues/648)) ([eefd332](https://github.com/streetsidesoftware/cspell-cli/commit/eefd332d61c22c6e74312c15bf988c0b91dc9dba)) 49 | * Update CSpell version (8.19.0) ([#656](https://github.com/streetsidesoftware/cspell-cli/issues/656)) ([3b6fa0f](https://github.com/streetsidesoftware/cspell-cli/commit/3b6fa0fcb33135ef55e97d92d23aebca203cfdf9)) 50 | 51 | 52 | ### Trivial updates and changes. 53 | 54 | * Revert "feat: Update CSpell version (8.19.0)" ([#657](https://github.com/streetsidesoftware/cspell-cli/issues/657)) ([c880075](https://github.com/streetsidesoftware/cspell-cli/commit/c880075c3bd3501814c9f753ca931b8c5c478ec7)) 55 | * Update CSpell version (8.18.1) ([#651](https://github.com/streetsidesoftware/cspell-cli/issues/651)) ([a70d6bb](https://github.com/streetsidesoftware/cspell-cli/commit/a70d6bb7a511f963c62af49b1d11cacdac7948ea)) 56 | 57 | ## [8.17.3](https://github.com/streetsidesoftware/cspell-cli/compare/v8.17.2...v8.17.3) (2025-02-23) 58 | 59 | 60 | ### Trivial updates and changes. 61 | 62 | * Update CSpell version (8.17.4) ([#631](https://github.com/streetsidesoftware/cspell-cli/issues/631)) ([01bd10e](https://github.com/streetsidesoftware/cspell-cli/commit/01bd10e69e8ace1076a20b8516e78a37fe2ced30)) 63 | * Update CSpell version (8.17.5) ([#635](https://github.com/streetsidesoftware/cspell-cli/issues/635)) ([352c509](https://github.com/streetsidesoftware/cspell-cli/commit/352c509e2b5af30fabbf1d53159627f77b065762)) 64 | 65 | ## [8.17.2](https://github.com/streetsidesoftware/cspell-cli/compare/v8.17.1...v8.17.2) (2025-02-02) 66 | 67 | 68 | ### Trivial updates and changes. 69 | 70 | * Update CSpell version (8.17.3) ([#624](https://github.com/streetsidesoftware/cspell-cli/issues/624)) ([c4182d2](https://github.com/streetsidesoftware/cspell-cli/commit/c4182d21894e1e38303763a025c36ce476c0c734)) 71 | 72 | ## [8.17.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.17.0...v8.17.1) (2025-01-15) 73 | 74 | 75 | ### Trivial updates and changes. 76 | 77 | * Update CSpell version (8.17.2) ([#615](https://github.com/streetsidesoftware/cspell-cli/issues/615)) ([d259857](https://github.com/streetsidesoftware/cspell-cli/commit/d2598579b86b83edee96d7f92b8c2feac11159f5)) 78 | 79 | ## [8.17.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.16.1...v8.17.0) (2024-12-17) 80 | 81 | 82 | ### Features 83 | 84 | * Update CSpell version (8.17.0) ([#600](https://github.com/streetsidesoftware/cspell-cli/issues/600)) ([603f826](https://github.com/streetsidesoftware/cspell-cli/commit/603f8265d998ac27990d7ee82fae09f778edd7de)) 85 | 86 | 87 | ### Trivial updates and changes. 88 | 89 | * Update CSpell version (8.17.1) ([#603](https://github.com/streetsidesoftware/cspell-cli/issues/603)) ([c2db120](https://github.com/streetsidesoftware/cspell-cli/commit/c2db1207d97d0de72252624b4e81ee4dd6646d66)) 90 | 91 | ## [8.16.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.16.0...v8.16.1) (2024-12-02) 92 | 93 | 94 | ### Trivial updates and changes. 95 | 96 | * Update CSpell version (8.16.1) ([#595](https://github.com/streetsidesoftware/cspell-cli/issues/595)) ([ab57b03](https://github.com/streetsidesoftware/cspell-cli/commit/ab57b03edb2ffb6d7ad1b6aba62b9796f714d5d9)) 97 | 98 | ## [8.16.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.15.3...v8.16.0) (2024-11-10) 99 | 100 | 101 | ### Features 102 | 103 | * Update CSpell version (8.16.0) ([#587](https://github.com/streetsidesoftware/cspell-cli/issues/587)) ([a1e6559](https://github.com/streetsidesoftware/cspell-cli/commit/a1e65598c31748da2c187184316f3daa9b261afc)) 104 | 105 | ## [8.15.3](https://github.com/streetsidesoftware/cspell-cli/compare/v8.15.2...v8.15.3) (2024-11-06) 106 | 107 | 108 | ### Trivial updates and changes. 109 | 110 | * Update CSpell version (8.15.5) ([#581](https://github.com/streetsidesoftware/cspell-cli/issues/581)) ([40ebc32](https://github.com/streetsidesoftware/cspell-cli/commit/40ebc32749f2f2f9120d7be249405ef425c79019)) 111 | * Update CSpell version (8.15.7) ([#583](https://github.com/streetsidesoftware/cspell-cli/issues/583)) ([e675c0a](https://github.com/streetsidesoftware/cspell-cli/commit/e675c0a224b7be765e9dfb5940588ac16abb487a)) 112 | 113 | ## [8.15.2](https://github.com/streetsidesoftware/cspell-cli/compare/v8.15.1...v8.15.2) (2024-10-18) 114 | 115 | 116 | ### Trivial updates and changes. 117 | 118 | * Update CSpell version (8.15.2) ([#572](https://github.com/streetsidesoftware/cspell-cli/issues/572)) ([882c7a0](https://github.com/streetsidesoftware/cspell-cli/commit/882c7a07b5992f68181391abd90b6ee397816267)) 119 | * Update CSpell version (8.15.3) ([#574](https://github.com/streetsidesoftware/cspell-cli/issues/574)) ([9abdc89](https://github.com/streetsidesoftware/cspell-cli/commit/9abdc89251202ca76290577f43ce7e26bef80872)) 120 | * Update CSpell version (8.15.4) ([#577](https://github.com/streetsidesoftware/cspell-cli/issues/577)) ([dae3dca](https://github.com/streetsidesoftware/cspell-cli/commit/dae3dca1279c03e97473d235887effa0e2edd0b6)) 121 | 122 | ## [8.15.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.15.0...v8.15.1) (2024-10-11) 123 | 124 | 125 | ### Trivial updates and changes. 126 | 127 | * Update CSpell version (8.15.1) ([#564](https://github.com/streetsidesoftware/cspell-cli/issues/564)) ([e736ac7](https://github.com/streetsidesoftware/cspell-cli/commit/e736ac7a2e0172b8cee7a51e5973ff47867b79bc)) 128 | 129 | ## [8.15.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.14.0...v8.15.0) (2024-10-11) 130 | 131 | 132 | ### Features 133 | 134 | * Update CSpell version (8.15.0) ([#561](https://github.com/streetsidesoftware/cspell-cli/issues/561)) ([7334c06](https://github.com/streetsidesoftware/cspell-cli/commit/7334c06390999b1f6d985ea92978c77637c75a81)) 135 | 136 | ## [8.14.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.13.3...v8.14.0) (2024-10-07) 137 | 138 | 139 | ### Features 140 | 141 | * Update CSpell version (8.14.1) ([#544](https://github.com/streetsidesoftware/cspell-cli/issues/544)) ([239550e](https://github.com/streetsidesoftware/cspell-cli/commit/239550e2fd64e24d2ef4088e70c224303cbb49f0)) 142 | 143 | 144 | ### Trivial updates and changes. 145 | 146 | * Update CSpell version (8.14.2) ([#549](https://github.com/streetsidesoftware/cspell-cli/issues/549)) ([841f205](https://github.com/streetsidesoftware/cspell-cli/commit/841f2056c3c991e4fb298ec65fb6331fa822889b)) 147 | * Update CSpell version (8.14.4) ([#554](https://github.com/streetsidesoftware/cspell-cli/issues/554)) ([86f7e0e](https://github.com/streetsidesoftware/cspell-cli/commit/86f7e0eecfd5e931670108b2a623fa057d1aaae3)) 148 | 149 | ## [8.13.3](https://github.com/streetsidesoftware/cspell-cli/compare/v8.13.2...v8.13.3) (2024-08-12) 150 | 151 | 152 | ### Trivial updates and changes. 153 | 154 | * force file paths in pre-commit ([#540](https://github.com/streetsidesoftware/cspell-cli/issues/540)) ([8d24a6a](https://github.com/streetsidesoftware/cspell-cli/commit/8d24a6aecb9a1fe2b5e865d1d4f4a541816ca926)) 155 | * Update CSpell version (8.13.3) ([#542](https://github.com/streetsidesoftware/cspell-cli/issues/542)) ([ebf3055](https://github.com/streetsidesoftware/cspell-cli/commit/ebf3055750272a57c1dc172cbfdb3e60cf90ba3c)) 156 | 157 | ## [8.13.2](https://github.com/streetsidesoftware/cspell-cli/compare/v8.13.1...v8.13.2) (2024-08-08) 158 | 159 | 160 | ### Trivial updates and changes. 161 | 162 | * Update CSpell version (8.13.2) ([#534](https://github.com/streetsidesoftware/cspell-cli/issues/534)) ([0e8c2de](https://github.com/streetsidesoftware/cspell-cli/commit/0e8c2de3cd08c06fb2774c61c4157c3f1913a435)) 163 | 164 | ## [8.13.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.13.0...v8.13.1) (2024-08-02) 165 | 166 | 167 | ### Trivial updates and changes. 168 | 169 | * Update CSpell version (8.13.1) ([#529](https://github.com/streetsidesoftware/cspell-cli/issues/529)) ([f8c64e5](https://github.com/streetsidesoftware/cspell-cli/commit/f8c64e55a856b7986d2af9bf9397986ec066485b)) 170 | 171 | ## [8.13.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.12.0...v8.13.0) (2024-07-30) 172 | 173 | 174 | ### Features 175 | 176 | * Update CSpell version (8.13.0) ([#527](https://github.com/streetsidesoftware/cspell-cli/issues/527)) ([c6d0d4c](https://github.com/streetsidesoftware/cspell-cli/commit/c6d0d4c177100e127bcb1dfb8763d8e314d8edc9)) 177 | 178 | ## [8.12.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.11.0...v8.12.0) (2024-07-23) 179 | 180 | 181 | ### Features 182 | 183 | * Update CSpell version (8.12.1) ([#524](https://github.com/streetsidesoftware/cspell-cli/issues/524)) ([7cefa07](https://github.com/streetsidesoftware/cspell-cli/commit/7cefa07b2094807f648a467cf7087522edbf2639)) 184 | 185 | ## [8.11.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.10.1...v8.11.0) (2024-07-22) 186 | 187 | 188 | ### Features 189 | 190 | * Update CSpell version (8.11.0) ([#516](https://github.com/streetsidesoftware/cspell-cli/issues/516)) ([b7531cc](https://github.com/streetsidesoftware/cspell-cli/commit/b7531ccb55f77d7815fe07a1486c7a12c46bb767)) 191 | 192 | ## [8.10.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.10.0...v8.10.1) (2024-07-06) 193 | 194 | 195 | ### Trivial updates and changes. 196 | 197 | * Update CSpell version (8.10.4) ([#511](https://github.com/streetsidesoftware/cspell-cli/issues/511)) ([c7a209c](https://github.com/streetsidesoftware/cspell-cli/commit/c7a209cb892de6b721e8a5d2406725545f5ec611)) 198 | 199 | ## [8.10.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.9.0...v8.10.0) (2024-07-03) 200 | 201 | 202 | ### Features 203 | 204 | * Update CSpell version (8.10.0) ([#509](https://github.com/streetsidesoftware/cspell-cli/issues/509)) ([0f8e20d](https://github.com/streetsidesoftware/cspell-cli/commit/0f8e20d6657bc84fe52559b02e17d20915874f80)) 205 | 206 | 207 | ### Trivial updates and changes. 208 | 209 | * Update CSpell version (8.9.1) ([#502](https://github.com/streetsidesoftware/cspell-cli/issues/502)) ([f9c4782](https://github.com/streetsidesoftware/cspell-cli/commit/f9c47820fa13ce6f1dba7788c67302ce8941c5d7)) 210 | 211 | ## [8.9.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.8.2...v8.9.0) (2024-06-19) 212 | 213 | 214 | ### Features 215 | 216 | * Update CSpell version (8.9.0) ([#500](https://github.com/streetsidesoftware/cspell-cli/issues/500)) ([909b5eb](https://github.com/streetsidesoftware/cspell-cli/commit/909b5eb45a1ca96fa9e8dedc7cf18a7fab560829)) 217 | 218 | 219 | ### Trivial updates and changes. 220 | 221 | * Update CSpell version (8.8.4) ([#491](https://github.com/streetsidesoftware/cspell-cli/issues/491)) ([eabf347](https://github.com/streetsidesoftware/cspell-cli/commit/eabf3476ab1ed593598ea0faaa145028dc12baf2)) 222 | * Update CSpell version (8.8.4) ([#493](https://github.com/streetsidesoftware/cspell-cli/issues/493)) ([86b1ef9](https://github.com/streetsidesoftware/cspell-cli/commit/86b1ef9b073cb6f95df5a29f7b79fa92a8de7f4d)) 223 | 224 | ## [8.8.2](https://github.com/streetsidesoftware/cspell-cli/compare/v8.8.1...v8.8.2) (2024-05-23) 225 | 226 | 227 | ### Trivial updates and changes. 228 | 229 | * Update CSpell version (8.8.2) ([#485](https://github.com/streetsidesoftware/cspell-cli/issues/485)) ([744b8dd](https://github.com/streetsidesoftware/cspell-cli/commit/744b8dd1d7cbb7128eff160a105825bd3ddceb44)) 230 | * Update CSpell version (8.8.3) ([#487](https://github.com/streetsidesoftware/cspell-cli/issues/487)) ([29af017](https://github.com/streetsidesoftware/cspell-cli/commit/29af017fa00b4a2231be67cb996af85d3f61ed85)) 231 | 232 | ## [8.8.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.8.0...v8.8.1) (2024-05-10) 233 | 234 | 235 | ### Trivial updates and changes. 236 | 237 | * Update CSpell version (8.8.1) ([#480](https://github.com/streetsidesoftware/cspell-cli/issues/480)) ([4d265c9](https://github.com/streetsidesoftware/cspell-cli/commit/4d265c9b8c620f6287345efdaffaa22491e993b9)) 238 | 239 | ## [8.8.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.7.0...v8.8.0) (2024-05-04) 240 | 241 | 242 | ### Features 243 | 244 | * Update CSpell version (8.8.0) ([#478](https://github.com/streetsidesoftware/cspell-cli/issues/478)) ([094ed52](https://github.com/streetsidesoftware/cspell-cli/commit/094ed52f6b8b25331faf8eea9dad80a11117c897)) 245 | 246 | ## [8.7.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.6.1...v8.7.0) (2024-04-11) 247 | 248 | 249 | ### Features 250 | 251 | * Update CSpell version (8.7.0) ([#473](https://github.com/streetsidesoftware/cspell-cli/issues/473)) ([3563f33](https://github.com/streetsidesoftware/cspell-cli/commit/3563f33c28f7fa96d28b9fd69eeba3e8cb757a06)) 252 | 253 | ## [8.6.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.6.0...v8.6.1) (2024-03-26) 254 | 255 | 256 | ### Trivial updates and changes. 257 | 258 | * Update CSpell version (8.6.1) ([#470](https://github.com/streetsidesoftware/cspell-cli/issues/470)) ([a09feb5](https://github.com/streetsidesoftware/cspell-cli/commit/a09feb58d8fe1f419130435a7cf738b0bb5fb173)) 259 | 260 | ## [8.6.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.5.0...v8.6.0) (2024-03-06) 261 | 262 | 263 | ### Features 264 | 265 | * Update CSpell version (8.6.0) ([#461](https://github.com/streetsidesoftware/cspell-cli/issues/461)) ([aa8d750](https://github.com/streetsidesoftware/cspell-cli/commit/aa8d7508757b41c2b1bf6f8c0030afe6001ad2be)) 266 | 267 | ## [8.5.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.4.0...v8.5.0) (2024-03-02) 268 | 269 | 270 | ### Features 271 | 272 | * Update CSpell version (8.5.0) ([#458](https://github.com/streetsidesoftware/cspell-cli/issues/458)) ([de8dd9d](https://github.com/streetsidesoftware/cspell-cli/commit/de8dd9d92021150c8e0914c31ecbb8ed38853114)) 273 | 274 | 275 | ### Trivial updates and changes. 276 | 277 | * Add example on how to extend Docker Container ([#455](https://github.com/streetsidesoftware/cspell-cli/issues/455)) ([ef646eb](https://github.com/streetsidesoftware/cspell-cli/commit/ef646ebee138bd8b81b8a8aa54056945a1212803)) 278 | 279 | ## [8.4.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.3.0...v8.4.0) (2024-02-20) 280 | 281 | 282 | ### Features 283 | 284 | * Update CSpell version (8.4.0) ([#449](https://github.com/streetsidesoftware/cspell-cli/issues/449)) ([892ee3d](https://github.com/streetsidesoftware/cspell-cli/commit/892ee3dda11f7f2bcbe8bd58670c021265c784ab)) 285 | 286 | 287 | ### Trivial updates and changes. 288 | 289 | * Update CSpell version (8.4.1) ([#451](https://github.com/streetsidesoftware/cspell-cli/issues/451)) ([a9d03b6](https://github.com/streetsidesoftware/cspell-cli/commit/a9d03b6b20a9c2c64a647a2cd3e6c8fb2679f15b)) 290 | 291 | ## [8.3.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.2.1...v8.3.0) (2024-01-02) 292 | 293 | 294 | ### Features 295 | 296 | * Update CSpell version (8.3.0) ([#433](https://github.com/streetsidesoftware/cspell-cli/issues/433)) ([7598eca](https://github.com/streetsidesoftware/cspell-cli/commit/7598ecac27dd741d7a99ce011ece3598b8723721)) 297 | 298 | 299 | ### Trivial updates and changes. 300 | 301 | * Update CSpell version (8.3.2) ([#437](https://github.com/streetsidesoftware/cspell-cli/issues/437)) ([65b31a6](https://github.com/streetsidesoftware/cspell-cli/commit/65b31a6e7e85425317e12c255ccbae79d4f2003f)) 302 | 303 | ## [8.2.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.2.0...v8.2.1) (2023-12-29) 304 | 305 | 306 | ### Trivial updates and changes. 307 | 308 | * Update CSpell version (8.2.4) ([#430](https://github.com/streetsidesoftware/cspell-cli/issues/430)) ([6062061](https://github.com/streetsidesoftware/cspell-cli/commit/606206125a4617601ca36ff64067219cfd368664)) 309 | 310 | ## [8.2.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.1.1...v8.2.0) (2023-12-23) 311 | 312 | 313 | ### Features 314 | 315 | * Update CSpell version (8.2.1) ([#427](https://github.com/streetsidesoftware/cspell-cli/issues/427)) ([fdcfafb](https://github.com/streetsidesoftware/cspell-cli/commit/fdcfafb9005c4678625f139285082cfcac7b5f51)) 316 | 317 | 318 | ### Trivial updates and changes. 319 | 320 | * Update CSpell version (8.2.3) ([#429](https://github.com/streetsidesoftware/cspell-cli/issues/429)) ([37b6754](https://github.com/streetsidesoftware/cspell-cli/commit/37b67543ddc508c1e779b72051d62a13778a7a53)) 321 | 322 | ## [8.1.1](https://github.com/streetsidesoftware/cspell-cli/compare/v8.1.0...v8.1.1) (2023-12-06) 323 | 324 | 325 | ### Trivial updates and changes. 326 | 327 | * Update CSpell version (8.1.3) ([#419](https://github.com/streetsidesoftware/cspell-cli/issues/419)) ([2ff2edc](https://github.com/streetsidesoftware/cspell-cli/commit/2ff2edc5b1150d2bd9351efb19ea50ae5bee8e0d)) 328 | 329 | ## [8.1.0](https://github.com/streetsidesoftware/cspell-cli/compare/v8.0.0...v8.1.0) (2023-12-05) 330 | 331 | 332 | ### Features 333 | 334 | * Update CSpell version (8.1.2) ([#414](https://github.com/streetsidesoftware/cspell-cli/issues/414)) ([497e9e8](https://github.com/streetsidesoftware/cspell-cli/commit/497e9e8f97e2df01284fc4e02a01eb243c8d01c8)) 335 | 336 | ## [8.0.0](https://github.com/streetsidesoftware/cspell-cli/compare/v7.3.3...v8.0.0) (2023-11-07) 337 | 338 | 339 | ### ⚠ BREAKING CHANGES 340 | 341 | * Update CSpell to v8 ([#402](https://github.com/streetsidesoftware/cspell-cli/issues/402)) 342 | 343 | ### Features 344 | 345 | * Update CSpell to v8 ([#402](https://github.com/streetsidesoftware/cspell-cli/issues/402)) ([f73e999](https://github.com/streetsidesoftware/cspell-cli/commit/f73e999900114982f5a49761f975c6de6374cce1)) 346 | 347 | ## [7.3.3](https://github.com/streetsidesoftware/cspell-cli/compare/v7.3.2...v7.3.3) (2023-11-07) 348 | 349 | 350 | ### Trivial updates and changes. 351 | 352 | * Workflow Bot -- Update CSpell to (7.3.9) (main) ([#399](https://github.com/streetsidesoftware/cspell-cli/issues/399)) ([137578d](https://github.com/streetsidesoftware/cspell-cli/commit/137578da9ef23094b9242cb8a775226f5c484f98)) 353 | 354 | ## [7.3.2](https://github.com/streetsidesoftware/cspell-cli/compare/v7.3.1...v7.3.2) (2023-10-16) 355 | 356 | 357 | ### Trivial updates and changes. 358 | 359 | * Workflow Bot -- Update CSpell to (7.3.8) (main) ([#393](https://github.com/streetsidesoftware/cspell-cli/issues/393)) ([19955b5](https://github.com/streetsidesoftware/cspell-cli/commit/19955b5dc8aa9bb7f957760b6df33c62e6b8ab5c)) 360 | 361 | ## [7.3.1](https://github.com/streetsidesoftware/cspell-cli/compare/v7.3.0...v7.3.1) (2023-09-29) 362 | 363 | 364 | ### Trivial updates and changes. 365 | 366 | * Workflow Bot -- Update CSpell to (7.3.3) (main) ([#376](https://github.com/streetsidesoftware/cspell-cli/issues/376)) ([a2f282d](https://github.com/streetsidesoftware/cspell-cli/commit/a2f282d418dac68d82eb5727786ba49459abe23d)) 367 | * Workflow Bot -- Update CSpell to (7.3.5) (main) ([#378](https://github.com/streetsidesoftware/cspell-cli/issues/378)) ([eb1eaad](https://github.com/streetsidesoftware/cspell-cli/commit/eb1eaadcf615cdb5a01cceec11bcd659b74116be)) 368 | * Workflow Bot -- Update CSpell to (7.3.6) (main) ([#384](https://github.com/streetsidesoftware/cspell-cli/issues/384)) ([af1e32b](https://github.com/streetsidesoftware/cspell-cli/commit/af1e32b7f3b30c0ab14ede7bf778155de18fe63d)) 369 | * Workflow Bot -- Update CSpell to (7.3.7) (main) ([#390](https://github.com/streetsidesoftware/cspell-cli/issues/390)) ([81c7b04](https://github.com/streetsidesoftware/cspell-cli/commit/81c7b04d34b15553e1e6c34df04c05464839f956)) 370 | 371 | ## [7.3.0](https://github.com/streetsidesoftware/cspell-cli/compare/v7.2.0...v7.3.0) (2023-09-01) 372 | 373 | 374 | ### Features 375 | 376 | * Workflow Bot -- Update CSpell to (7.3.0) (main) ([#371](https://github.com/streetsidesoftware/cspell-cli/issues/371)) ([93a0294](https://github.com/streetsidesoftware/cspell-cli/commit/93a02947b57b16bf07a5ef7c0056417ad7d66ed6)) 377 | 378 | 379 | ### Bug Fixes 380 | 381 | * Workflow Bot -- Update CSpell to (7.3.2) (main) ([#372](https://github.com/streetsidesoftware/cspell-cli/issues/372)) ([710835b](https://github.com/streetsidesoftware/cspell-cli/commit/710835b484a82f06adabea9fe03abbbe4b298283)) 382 | 383 | ## [7.2.0](https://github.com/streetsidesoftware/cspell-cli/compare/v7.1.0...v7.2.0) (2023-08-29) 384 | 385 | 386 | ### Features 387 | 388 | * Workflow Bot -- Update CSpell to (7.2.0) (main) ([#368](https://github.com/streetsidesoftware/cspell-cli/issues/368)) ([ede1e7c](https://github.com/streetsidesoftware/cspell-cli/commit/ede1e7cbbcc11ebd4215db7ae001a1b745d67e36)) 389 | 390 | ## [7.1.0](https://github.com/streetsidesoftware/cspell-cli/compare/v7.0.1...v7.1.0) (2023-08-29) 391 | 392 | 393 | ### Features 394 | 395 | * Workflow Bot -- Update CSpell to (7.1.1) (main) ([#366](https://github.com/streetsidesoftware/cspell-cli/issues/366)) ([6b1fa04](https://github.com/streetsidesoftware/cspell-cli/commit/6b1fa040909c8e26486a5389a8f44ec41bcfd551)) 396 | 397 | ## [7.0.1](https://github.com/streetsidesoftware/cspell-cli/compare/v7.0.0...v7.0.1) (2023-08-24) 398 | 399 | 400 | ### Bug Fixes 401 | 402 | * Workflow Bot -- Update CSpell to (7.0.1) (main) ([#361](https://github.com/streetsidesoftware/cspell-cli/issues/361)) ([395f75c](https://github.com/streetsidesoftware/cspell-cli/commit/395f75cc880385e5b20454f9328c705c8a24d758)) 403 | 404 | ## [7.0.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.31.2...v7.0.0) (2023-08-11) 405 | 406 | 407 | ### ⚠ BREAKING CHANGES 408 | 409 | * Upgrade to CSpell 7 ([#355](https://github.com/streetsidesoftware/cspell-cli/issues/355)) 410 | 411 | ### Features 412 | 413 | * Upgrade to CSpell 7 ([#355](https://github.com/streetsidesoftware/cspell-cli/issues/355)) ([9b88897](https://github.com/streetsidesoftware/cspell-cli/commit/9b88897899b064a61922dbb338fd65a7f5d8d267)) 414 | 415 | ## [6.31.2](https://github.com/streetsidesoftware/cspell-cli/compare/v6.31.1...v6.31.2) (2023-08-09) 416 | 417 | 418 | ### Bug Fixes 419 | 420 | * Workflow Bot -- Update CSpell to (6.31.3) (main) ([#352](https://github.com/streetsidesoftware/cspell-cli/issues/352)) ([f388eec](https://github.com/streetsidesoftware/cspell-cli/commit/f388eecf4ee7944f767ced4d93ecee23b4957b13)) 421 | 422 | ## [6.31.1](https://github.com/streetsidesoftware/cspell-cli/compare/v6.31.0...v6.31.1) (2023-07-20) 423 | 424 | 425 | ### Bug Fixes 426 | 427 | * Fix pre-commit instructions. ([06c26da](https://github.com/streetsidesoftware/cspell-cli/commit/06c26daabf96eca3206c0a87c4b0fce5df982d81)) 428 | * Workflow Bot -- Update ALL Dictionaries ([#337](https://github.com/streetsidesoftware/cspell-cli/issues/337)) ([4e759df](https://github.com/streetsidesoftware/cspell-cli/commit/4e759df6266b91e5caf44492c5b768be93eb11db)) 429 | * Workflow Bot -- Update CSpell to (6.31.2) (main) ([#347](https://github.com/streetsidesoftware/cspell-cli/issues/347)) ([8b1498d](https://github.com/streetsidesoftware/cspell-cli/commit/8b1498dce012a93c72b83a059755087c88cfebbe)) 430 | 431 | ## [6.31.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.30.1...v6.31.0) (2023-03-27) 432 | 433 | 434 | ### Features 435 | 436 | * Workflow Bot -- Update CSpell to (6.31.1) (main) ([#323](https://github.com/streetsidesoftware/cspell-cli/issues/323)) ([3fe3f9e](https://github.com/streetsidesoftware/cspell-cli/commit/3fe3f9e6bcc66f943a21cc5d493627da0011c3e6)) 437 | 438 | ## [6.30.1](https://github.com/streetsidesoftware/cspell-cli/compare/v6.30.0...v6.30.1) (2023-03-19) 439 | 440 | 441 | ### Bug Fixes 442 | 443 | * Workflow Bot -- Update CSpell to (6.30.1) (main) ([#317](https://github.com/streetsidesoftware/cspell-cli/issues/317)) ([b1d1c23](https://github.com/streetsidesoftware/cspell-cli/commit/b1d1c23669603ae37d31c70a267a3642aaac7c18)) 444 | * Workflow Bot -- Update CSpell to (6.30.2) (main) ([#319](https://github.com/streetsidesoftware/cspell-cli/issues/319)) ([3cfc4d8](https://github.com/streetsidesoftware/cspell-cli/commit/3cfc4d8bde28a81653de966297b4cae3ee9bb420)) 445 | 446 | ## [6.30.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.29.0...v6.30.0) (2023-03-17) 447 | 448 | 449 | ### Features 450 | 451 | * Workflow Bot -- Update CSpell to (6.30.0) (main) ([#315](https://github.com/streetsidesoftware/cspell-cli/issues/315)) ([dc949d3](https://github.com/streetsidesoftware/cspell-cli/commit/dc949d3870c20d237d84cef16cf8ec8ea70f7ab7)) 452 | 453 | ## [6.29.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.28.0...v6.29.0) (2023-03-14) 454 | 455 | 456 | ### Features 457 | 458 | * Workflow Bot -- Update CSpell to (6.29.3) (main) ([#311](https://github.com/streetsidesoftware/cspell-cli/issues/311)) ([0043936](https://github.com/streetsidesoftware/cspell-cli/commit/0043936681c8f9e36eb693528c7e950a38f7895d)) 459 | 460 | ## [6.28.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.27.0...v6.28.0) (2023-03-04) 461 | 462 | 463 | ### Features 464 | 465 | * Workflow Bot -- Update CSpell to (6.28.0) (main) ([#308](https://github.com/streetsidesoftware/cspell-cli/issues/308)) ([628c559](https://github.com/streetsidesoftware/cspell-cli/commit/628c559b6689133c200ce4bfac9e6ec2e815f804)) 466 | 467 | ## [6.27.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.26.0...v6.27.0) (2023-02-27) 468 | 469 | 470 | ### Features 471 | 472 | * Workflow Bot -- Update CSpell to (6.27.0) (main) ([#301](https://github.com/streetsidesoftware/cspell-cli/issues/301)) ([b5bd284](https://github.com/streetsidesoftware/cspell-cli/commit/b5bd284be4dfc77cf7e0f0d9483c070eb48b37b5)) 473 | 474 | ## [6.26.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.24.0...v6.26.0) (2023-02-17) 475 | 476 | 477 | ### Features 478 | 479 | * Workflow Bot -- Update CSpell to (6.25.0) (main) ([#296](https://github.com/streetsidesoftware/cspell-cli/issues/296)) ([8e4d619](https://github.com/streetsidesoftware/cspell-cli/commit/8e4d619d75e11c383df4855ab9474986a32df927)) 480 | * Workflow Bot -- Update CSpell to (6.26.3) (main) ([#297](https://github.com/streetsidesoftware/cspell-cli/issues/297)) ([ecc2451](https://github.com/streetsidesoftware/cspell-cli/commit/ecc2451c52966f598e7af54961beeb07d762201a)) 481 | 482 | 483 | ### Miscellaneous Chores 484 | 485 | * release as 6.26.0 ([33fb24d](https://github.com/streetsidesoftware/cspell-cli/commit/33fb24d2bc2e76a0e4f1837081dd8499fcc9eccd)) 486 | 487 | ## [6.24.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.22.0...v6.24.0) (2023-02-14) 488 | 489 | 490 | ### Features 491 | 492 | * Workflow Bot -- Update CSpell to (6.23.0) (main) ([#292](https://github.com/streetsidesoftware/cspell-cli/issues/292)) ([99de729](https://github.com/streetsidesoftware/cspell-cli/commit/99de729697d3278e99ff8758056cf6f07e85a7ab)) 493 | * Workflow Bot -- Update CSpell to (6.24.0) (main) ([#294](https://github.com/streetsidesoftware/cspell-cli/issues/294)) ([07ae917](https://github.com/streetsidesoftware/cspell-cli/commit/07ae9176dfee45e2da442b265578342d4b54c876)) 494 | 495 | 496 | ### Miscellaneous Chores 497 | 498 | * release 6.24.0 ([f6778d2](https://github.com/streetsidesoftware/cspell-cli/commit/f6778d29203eea764e55d05b833f1c1e866bdfce)) 499 | 500 | ## [6.22.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.21.0...v6.22.0) (2023-02-06) 501 | 502 | 503 | ### Features 504 | 505 | * Workflow Bot -- Update CSpell to (6.22.0) (main) ([#290](https://github.com/streetsidesoftware/cspell-cli/issues/290)) ([8b8959f](https://github.com/streetsidesoftware/cspell-cli/commit/8b8959f66d3775d19b9d9db5e25cf2e6cc7a732a)) 506 | 507 | ## [6.21.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.20.0...v6.21.0) (2023-02-03) 508 | 509 | 510 | ### Features 511 | 512 | * Update CSpell to 6.21.0 ([4a819fc](https://github.com/streetsidesoftware/cspell-cli/commit/4a819fcf4e69a4c1c7a16e35c0ce5d42bd09051e)) 513 | * Workflow Bot -- Update CSpell to (6.21.0) (main) ([#288](https://github.com/streetsidesoftware/cspell-cli/issues/288)) ([4a819fc](https://github.com/streetsidesoftware/cspell-cli/commit/4a819fcf4e69a4c1c7a16e35c0ce5d42bd09051e)) 514 | 515 | ## [6.20.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.19.2...v6.20.0) (2023-02-02) 516 | 517 | 518 | ### Features 519 | 520 | * Update CSpell to 6.20.1 ([c0d3275](https://github.com/streetsidesoftware/cspell-cli/commit/c0d3275f15c04724d6d706a363fbc1435e1c8ba9)) 521 | * Workflow Bot -- Update CSpell to (6.20.1) (main) ([#286](https://github.com/streetsidesoftware/cspell-cli/issues/286)) ([c0d3275](https://github.com/streetsidesoftware/cspell-cli/commit/c0d3275f15c04724d6d706a363fbc1435e1c8ba9)) 522 | 523 | ## [6.19.2](https://github.com/streetsidesoftware/cspell-cli/compare/v6.17.1...v6.19.2) (2023-01-19) 524 | 525 | 526 | ### Features 527 | 528 | * Workflow Bot -- Update CSpell to (6.19.2) (main) ([#281](https://github.com/streetsidesoftware/cspell-cli/issues/281)) ([8241347](https://github.com/streetsidesoftware/cspell-cli/commit/8241347b3b8c493b105e619f3bcc47e84adfabbc)) 529 | 530 | 531 | ### Continuous Integration 532 | 533 | * Workflow Bot -- Update ALL Dependencies (main) ([#277](https://github.com/streetsidesoftware/cspell-cli/issues/277)) ([2c1748a](https://github.com/streetsidesoftware/cspell-cli/commit/2c1748a20ec19061e83099fae8cb1bbf140fecff)) 534 | 535 | ## [6.17.1](https://github.com/streetsidesoftware/cspell-cli/compare/v6.17.0...v6.17.1) (2022-12-30) 536 | 537 | 538 | ### Bug Fixes 539 | 540 | * Update CSpell to 6.18.1 ([8816084](https://github.com/streetsidesoftware/cspell-cli/commit/8816084ab738c6eb0294fc977812b1292dd94b6f)) 541 | * Workflow Bot -- Update CSpell to (6.18.1) (main) ([#275](https://github.com/streetsidesoftware/cspell-cli/issues/275)) ([8816084](https://github.com/streetsidesoftware/cspell-cli/commit/8816084ab738c6eb0294fc977812b1292dd94b6f)) 542 | 543 | ## [6.17.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.16.0...v6.17.0) (2022-12-22) 544 | 545 | 546 | ### Features 547 | 548 | * Update CSpell to 6.17.0 ([142efd5](https://github.com/streetsidesoftware/cspell-cli/commit/142efd5c83ce7f360dd105097bf0ce75cc78dfb4)) 549 | * Update CSpell to 6.18.0 ([5696d62](https://github.com/streetsidesoftware/cspell-cli/commit/5696d6240a06a70240948aeed23754482432b767)) 550 | * Workflow Bot -- Update CSpell to (6.17.0) (main) ([#267](https://github.com/streetsidesoftware/cspell-cli/issues/267)) ([142efd5](https://github.com/streetsidesoftware/cspell-cli/commit/142efd5c83ce7f360dd105097bf0ce75cc78dfb4)) 551 | * Workflow Bot -- Update CSpell to (6.18.0) (main) ([#272](https://github.com/streetsidesoftware/cspell-cli/issues/272)) ([5696d62](https://github.com/streetsidesoftware/cspell-cli/commit/5696d6240a06a70240948aeed23754482432b767)) 552 | 553 | ## [6.16.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.15.0...v6.16.0) (2022-12-03) 554 | 555 | 556 | ### Features 557 | 558 | * Workflow Bot -- Update CSpell to (6.16.0) (main) ([#266](https://github.com/streetsidesoftware/cspell-cli/issues/266)) ([ac84f80](https://github.com/streetsidesoftware/cspell-cli/commit/ac84f807baac961e71434ba2c0afb2c296937a6b)) 559 | 560 | 561 | ### Bug Fixes 562 | 563 | * Workflow Bot -- Update CSpell to (6.15.1) (main) ([#263](https://github.com/streetsidesoftware/cspell-cli/issues/263)) ([25f5cf7](https://github.com/streetsidesoftware/cspell-cli/commit/25f5cf734c7a1e2995612a0d130ed7ce2514b6eb)) 564 | 565 | ## [6.15.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.14.1...v6.15.0) (2022-11-26) 566 | 567 | 568 | ### Features 569 | 570 | * Workflow Bot -- Update CSpell to (6.15.0) (main) ([#262](https://github.com/streetsidesoftware/cspell-cli/issues/262)) ([8f4730f](https://github.com/streetsidesoftware/cspell-cli/commit/8f4730f47a5820b9786accf1142c4b6246a80dbd)) 571 | 572 | 573 | ### Bug Fixes 574 | 575 | * Workflow Bot -- Update CSpell to (6.14.3) (main) ([#259](https://github.com/streetsidesoftware/cspell-cli/issues/259)) ([9b748c1](https://github.com/streetsidesoftware/cspell-cli/commit/9b748c1846964973b055a431358d3a6f5e23cfaa)) 576 | 577 | ## [6.14.1](https://github.com/streetsidesoftware/cspell-cli/compare/v6.14.0...v6.14.1) (2022-11-12) 578 | 579 | 580 | ### Bug Fixes 581 | 582 | * Update CSpell to 6.14.1 ([82e4623](https://github.com/streetsidesoftware/cspell-cli/commit/82e4623084feced295a83edc46c2fdc6cb7223e0)) 583 | * Update CSpell to 6.14.1 ([859e253](https://github.com/streetsidesoftware/cspell-cli/commit/859e25317369299e7e78d922f15d62d66d732ff5)) 584 | * Update CSpell to 6.14.2 ([cc070ea](https://github.com/streetsidesoftware/cspell-cli/commit/cc070eab25637768ba92d6e376657fcd976e5137)) 585 | * Workflow Bot -- Update CSpell to (6.14.1) (main) ([#254](https://github.com/streetsidesoftware/cspell-cli/issues/254)) ([859e253](https://github.com/streetsidesoftware/cspell-cli/commit/859e25317369299e7e78d922f15d62d66d732ff5)) 586 | * Workflow Bot -- Update CSpell to (6.14.1) (main) ([#255](https://github.com/streetsidesoftware/cspell-cli/issues/255)) ([82e4623](https://github.com/streetsidesoftware/cspell-cli/commit/82e4623084feced295a83edc46c2fdc6cb7223e0)) 587 | * Workflow Bot -- Update CSpell to (6.14.2) (main) ([#257](https://github.com/streetsidesoftware/cspell-cli/issues/257)) ([cc070ea](https://github.com/streetsidesoftware/cspell-cli/commit/cc070eab25637768ba92d6e376657fcd976e5137)) 588 | 589 | ## [6.14.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.13.0...v6.14.0) (2022-11-04) 590 | 591 | 592 | ### Features 593 | 594 | * Workflow Bot -- Update CSpell to (6.14.0) (main) ([#250](https://github.com/streetsidesoftware/cspell-cli/issues/250)) ([caabbe0](https://github.com/streetsidesoftware/cspell-cli/commit/caabbe09d8e9d15e26c0f677042a42b5ce12b541)) 595 | 596 | ## [6.13.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.12.0...v6.13.0) (2022-11-01) 597 | 598 | 599 | ### Features 600 | 601 | * Update CSpell to 6.13.3 ([135f43e](https://github.com/streetsidesoftware/cspell-cli/commit/135f43eab8a85f5f2d45123f94bcd37113b33851)) 602 | * Workflow Bot -- Update CSpell to (6.13.3) (main) ([#246](https://github.com/streetsidesoftware/cspell-cli/issues/246)) ([135f43e](https://github.com/streetsidesoftware/cspell-cli/commit/135f43eab8a85f5f2d45123f94bcd37113b33851)) 603 | 604 | ## [6.12.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.11.0...v6.12.0) (2022-09-30) 605 | 606 | 607 | ### Features 608 | 609 | * Update CSpell to 6.12.0 ([b9c44e8](https://github.com/streetsidesoftware/cspell-cli/commit/b9c44e8793a74b7f24b5ae581a6250c63f741ea7)) 610 | * Workflow Bot -- Update CSpell to (6.12.0) (main) ([#232](https://github.com/streetsidesoftware/cspell-cli/issues/232)) ([b9c44e8](https://github.com/streetsidesoftware/cspell-cli/commit/b9c44e8793a74b7f24b5ae581a6250c63f741ea7)) 611 | 612 | ## [6.11.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.10.0...v6.11.0) (2022-09-30) 613 | 614 | 615 | ### Features 616 | 617 | * Update CSpell to 6.11.1 ([c034738](https://github.com/streetsidesoftware/cspell-cli/commit/c0347383fd37ec7f5e97e99ebde7a332358969a0)) 618 | * Workflow Bot -- Update CSpell to (6.11.1) (main) ([#231](https://github.com/streetsidesoftware/cspell-cli/issues/231)) ([c034738](https://github.com/streetsidesoftware/cspell-cli/commit/c0347383fd37ec7f5e97e99ebde7a332358969a0)) 619 | 620 | ## [6.10.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.9.0...v6.10.0) (2022-09-20) 621 | 622 | 623 | ### Features 624 | 625 | * Update CSpell to 6.10.0 ([862955d](https://github.com/streetsidesoftware/cspell-cli/commit/862955d7a6334220c5392813ffb043f4462c741a)) 626 | * Workflow Bot -- Update CSpell to (6.10.0) (main) ([#229](https://github.com/streetsidesoftware/cspell-cli/issues/229)) ([862955d](https://github.com/streetsidesoftware/cspell-cli/commit/862955d7a6334220c5392813ffb043f4462c741a)) 627 | 628 | 629 | ### Bug Fixes 630 | 631 | * Update CSpell to 6.10.1 ([bb63f5e](https://github.com/streetsidesoftware/cspell-cli/commit/bb63f5e8c8f75910e883af45a28fe7d11966bc3d)) 632 | * Update CSpell to 6.9.1 ([eab3071](https://github.com/streetsidesoftware/cspell-cli/commit/eab30718a714cd4df7c2fe31c58d669b30eda899)) 633 | * Workflow Bot -- Update CSpell to (6.10.1) (main) ([#230](https://github.com/streetsidesoftware/cspell-cli/issues/230)) ([bb63f5e](https://github.com/streetsidesoftware/cspell-cli/commit/bb63f5e8c8f75910e883af45a28fe7d11966bc3d)) 634 | * Workflow Bot -- Update CSpell to (6.9.1) (main) ([#224](https://github.com/streetsidesoftware/cspell-cli/issues/224)) ([eab3071](https://github.com/streetsidesoftware/cspell-cli/commit/eab30718a714cd4df7c2fe31c58d669b30eda899)) 635 | 636 | ## [6.9.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.8.2...v6.9.0) (2022-09-15) 637 | 638 | 639 | ### Features 640 | 641 | * Workflow Bot -- Update CSpell to (6.9.0) (main) ([#221](https://github.com/streetsidesoftware/cspell-cli/issues/221)) ([95de835](https://github.com/streetsidesoftware/cspell-cli/commit/95de835174fc36fdee98f09ee005ec9d2eab6ea9)) 642 | 643 | 644 | ### Bug Fixes 645 | 646 | * Update CSpell to 6.9.0 ([95de835](https://github.com/streetsidesoftware/cspell-cli/commit/95de835174fc36fdee98f09ee005ec9d2eab6ea9)) 647 | 648 | ## [6.8.2](https://github.com/streetsidesoftware/cspell-cli/compare/v6.8.1...v6.8.2) (2022-09-13) 649 | 650 | 651 | ### Bug Fixes 652 | 653 | * Update CSpell to 6.8.2 ([ecf615f](https://github.com/streetsidesoftware/cspell-cli/commit/ecf615fbba2625a87ecc0decef1feef6c6a9654b)) 654 | * Workflow Bot -- Update CSpell to (6.8.2) (main) ([#219](https://github.com/streetsidesoftware/cspell-cli/issues/219)) ([ecf615f](https://github.com/streetsidesoftware/cspell-cli/commit/ecf615fbba2625a87ecc0decef1feef6c6a9654b)) 655 | 656 | ## [6.8.1](https://github.com/streetsidesoftware/cspell-cli/compare/v6.8.0...v6.8.1) (2022-08-27) 657 | 658 | 659 | ### Bug Fixes 660 | 661 | * Update CSpell to 6.8.1 ([ac43c73](https://github.com/streetsidesoftware/cspell-cli/commit/ac43c73a022f1bf5617fd475c4a1d4d92374a60c)) 662 | * Workflow Bot -- Update CSpell to (6.8.1) (main) ([#212](https://github.com/streetsidesoftware/cspell-cli/issues/212)) ([ac43c73](https://github.com/streetsidesoftware/cspell-cli/commit/ac43c73a022f1bf5617fd475c4a1d4d92374a60c)) 663 | 664 | ## [6.8.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.7.0...v6.8.0) (2022-08-21) 665 | 666 | 667 | ### Features 668 | 669 | * Update to CSpell 6.8.0 ([#210](https://github.com/streetsidesoftware/cspell-cli/issues/210)) ([2e6a76b](https://github.com/streetsidesoftware/cspell-cli/commit/2e6a76b2e86e82f3fc695892ea5b4599dba49177)) 670 | 671 | ## [6.7.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.6.0...v6.7.0) (2022-08-19) 672 | 673 | 674 | ### Features 675 | 676 | * Update CSpell to 6.7.0 ([#208](https://github.com/streetsidesoftware/cspell-cli/issues/208)) ([ee88dec](https://github.com/streetsidesoftware/cspell-cli/commit/ee88decc083eaeecb10d4759e5b6d66ab3ce4fef)) 677 | 678 | ## [6.6.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.5.0...v6.6.0) (2022-08-12) 679 | 680 | 681 | ### Features 682 | 683 | * Update CSpell to 6.6.0 ([#202](https://github.com/streetsidesoftware/cspell-cli/issues/202)) ([c52067f](https://github.com/streetsidesoftware/cspell-cli/commit/c52067f06ffe44c380ce639327ac9b3ff40968fc)) 684 | 685 | 686 | ### Bug Fixes 687 | 688 | * Update CSpell to 6.6.1 ([#204](https://github.com/streetsidesoftware/cspell-cli/issues/204)) ([d2a01c9](https://github.com/streetsidesoftware/cspell-cli/commit/d2a01c9555eb1d4e72ba0ab0c07c47763467c980)) 689 | 690 | ## [6.5.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.3.4...v6.5.0) (2022-07-30) 691 | 692 | 693 | ### Features 694 | 695 | * Update CSpell to 6.5.0 ([#197](https://github.com/streetsidesoftware/cspell-cli/issues/197)) ([75751dd](https://github.com/streetsidesoftware/cspell-cli/commit/75751dd6e619445f214e6431e0046d34a8a45b3d)) 696 | 697 | 698 | ### Miscellaneous Chores 699 | 700 | * release 6.5.0 ([9d5b37b](https://github.com/streetsidesoftware/cspell-cli/commit/9d5b37b68d4da5b0dbbea342703bffc805782113)) 701 | 702 | ## [6.3.4](https://github.com/streetsidesoftware/cspell-cli/compare/v6.3.3...v6.3.4) (2022-07-28) 703 | 704 | 705 | ### Bug Fixes 706 | 707 | * Update README to include Docker ([#189](https://github.com/streetsidesoftware/cspell-cli/issues/189)) ([22cb783](https://github.com/streetsidesoftware/cspell-cli/commit/22cb78312b9801adf3d28191c604398ec01fba50)) 708 | 709 | ## [6.3.3](https://github.com/streetsidesoftware/cspell-cli/compare/v6.3.2...v6.3.3) (2022-07-27) 710 | 711 | 712 | ### Bug Fixes 713 | 714 | * Update CSpell to 6.4.2 ([#185](https://github.com/streetsidesoftware/cspell-cli/issues/185)) ([8224ef8](https://github.com/streetsidesoftware/cspell-cli/commit/8224ef84824c4271fcf64e1528d72fc7d376439b)) 715 | 716 | ## [6.3.2](https://github.com/streetsidesoftware/cspell-cli/compare/v6.3.1...v6.3.2) (2022-07-24) 717 | 718 | 719 | ### Bug Fixes 720 | 721 | * Update CSpell to 6.4.1 ([#181](https://github.com/streetsidesoftware/cspell-cli/issues/181)) ([47bf7b1](https://github.com/streetsidesoftware/cspell-cli/commit/47bf7b1ba74fdc2787a1ddb5e2a9648f62763325)) 722 | 723 | ## [6.3.1](https://github.com/streetsidesoftware/cspell-cli/compare/v6.3.0...v6.3.1) (2022-07-20) 724 | 725 | 726 | ### Bug Fixes 727 | 728 | * Update CSpell to 6.4.0 ([#179](https://github.com/streetsidesoftware/cspell-cli/issues/179)) ([fc23997](https://github.com/streetsidesoftware/cspell-cli/commit/fc23997d55efaee559989909ed4660f0fbf45d16)) 729 | 730 | ## [6.3.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.2.0...v6.3.0) (2022-07-18) 731 | 732 | 733 | ### Features 734 | 735 | * Update CSpell to 6.3.0 ([#176](https://github.com/streetsidesoftware/cspell-cli/issues/176)) ([9d0171e](https://github.com/streetsidesoftware/cspell-cli/commit/9d0171e5b381facfba65696c244934f38d6ca82d)) 736 | 737 | 738 | ### Bug Fixes 739 | 740 | * Update CSpell to 6.3.0 ([#175](https://github.com/streetsidesoftware/cspell-cli/issues/175)) ([bc17a0a](https://github.com/streetsidesoftware/cspell-cli/commit/bc17a0a1bdcbc47c7ace7cf346c4386ae6898e14)) 741 | 742 | ## [6.2.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.1.7...v6.2.0) (2022-07-15) 743 | 744 | 745 | ### Bug Fixes 746 | 747 | * Make sure the README has full version ([#173](https://github.com/streetsidesoftware/cspell-cli/issues/173)) ([9bd52b0](https://github.com/streetsidesoftware/cspell-cli/commit/9bd52b0afffeb88d521d9a1f2cd18f88a5715455)) 748 | 749 | 750 | ### Miscellaneous Chores 751 | 752 | * release 6.2.0 ([a88fb19](https://github.com/streetsidesoftware/cspell-cli/commit/a88fb199ec785647442f5c73e162835b0fd25b9d)) 753 | 754 | ## [6.1.7](https://github.com/streetsidesoftware/cspell-cli/compare/v6.1.6...v6.1.7) (2022-07-08) 755 | 756 | 757 | ### Bug Fixes 758 | 759 | * Update CSpell to 6.2.3 ([#168](https://github.com/streetsidesoftware/cspell-cli/issues/168)) ([75ad4a6](https://github.com/streetsidesoftware/cspell-cli/commit/75ad4a67805987468b2d7b89a7bb4e9dfc026a41)) 760 | * Update CSpell to latest ([#164](https://github.com/streetsidesoftware/cspell-cli/issues/164)) ([fcddce9](https://github.com/streetsidesoftware/cspell-cli/commit/fcddce92b94e07b906ebda24838b3defd7c8c3dc)) 761 | 762 | ## [6.1.6](https://github.com/streetsidesoftware/cspell-cli/compare/v6.1.5...v6.1.6) (2022-07-07) 763 | 764 | 765 | ### Miscellaneous Chores 766 | 767 | * release 6.1.6 ([fb2a67d](https://github.com/streetsidesoftware/cspell-cli/commit/fb2a67d065243091a169d45c71dc107e3e151461)) 768 | 769 | ## [6.1.5](https://github.com/streetsidesoftware/cspell-cli/compare/v6.1.4...v6.1.5) (2022-07-07) 770 | 771 | 772 | ### Miscellaneous Chores 773 | 774 | * release 6.1.5 ([1245a04](https://github.com/streetsidesoftware/cspell-cli/commit/1245a04915913aea66c69e3441d6eec2c518329a)) 775 | 776 | ## [6.1.4](https://github.com/streetsidesoftware/cspell-cli/compare/v6.1.3...v6.1.4) (2022-07-07) 777 | 778 | 779 | ### Bug Fixes 780 | 781 | * Update README.md ([#157](https://github.com/streetsidesoftware/cspell-cli/issues/157)) ([8ccd766](https://github.com/streetsidesoftware/cspell-cli/commit/8ccd766dfbcbd789250def049579f8b9267c42d1)) 782 | * Update Release Notes Format ([7ff246c](https://github.com/streetsidesoftware/cspell-cli/commit/7ff246cf7e6010989431357fe3c21987784f03a3)) 783 | 784 | 785 | ### Miscellaneous Chores 786 | 787 | * force release 6.1.2 ([7cad036](https://github.com/streetsidesoftware/cspell-cli/commit/7cad0361f3d9203b2569bd66eb1df3d7147cbaf7)) 788 | * release 6.1.3 ([89bd950](https://github.com/streetsidesoftware/cspell-cli/commit/89bd95080399308225e1c8a8f5ae0ddce932a009)) 789 | * release 6.1.4 ([b5e7dc9](https://github.com/streetsidesoftware/cspell-cli/commit/b5e7dc9ff51a71b86ac468ed8c29b6b1734cdb6c)) 790 | 791 | ## [6.1.3](https://github.com/streetsidesoftware/cspell-cli/compare/cspell-cli-v6.1.2...cspell-cli-v6.1.3) (2022-07-07) 792 | 793 | 794 | ### Miscellaneous Chores 795 | 796 | * release 6.1.3 ([89bd950](https://github.com/streetsidesoftware/cspell-cli/commit/89bd95080399308225e1c8a8f5ae0ddce932a009)) 797 | 798 | ## [6.1.2](https://github.com/streetsidesoftware/cspell-cli/compare/cspell-cli-v6.1.0...cspell-cli-v6.1.2) (2022-07-07) 799 | 800 | 801 | ### Bug Fixes 802 | 803 | * Update README.md ([#157](https://github.com/streetsidesoftware/cspell-cli/issues/157)) ([8ccd766](https://github.com/streetsidesoftware/cspell-cli/commit/8ccd766dfbcbd789250def049579f8b9267c42d1)) 804 | * Update Release Notes Format ([7ff246c](https://github.com/streetsidesoftware/cspell-cli/commit/7ff246cf7e6010989431357fe3c21987784f03a3)) 805 | 806 | 807 | ### Miscellaneous Chores 808 | 809 | * force release 6.1.2 ([7cad036](https://github.com/streetsidesoftware/cspell-cli/commit/7cad0361f3d9203b2569bd66eb1df3d7147cbaf7)) 810 | 811 | ## [6.1.1](https://github.com/streetsidesoftware/cspell-cli/compare/v6.1.0...v6.1.1) (2022-07-06) 812 | 813 | 814 | ### Bug Fixes 815 | 816 | * Update Release Notes Format ([7ff246c](https://github.com/streetsidesoftware/cspell-cli/commit/7ff246cf7e6010989431357fe3c21987784f03a3)) 817 | 818 | ## [6.1.0](https://github.com/streetsidesoftware/cspell-cli/compare/v6.0.0...v6.1.0) (2022-07-06) 819 | 820 | 821 | ### Features 822 | 823 | * Upgrade to CSpell 6.2.2 ([#150](https://github.com/streetsidesoftware/cspell-cli/issues/150)) ([29557a4](https://github.com/streetsidesoftware/cspell-cli/commit/29557a41fa961a56fabc997ae02e88470cde120b)) 824 | 825 | ## [6.0.0](https://github.com/streetsidesoftware/cspell-cli/compare/v5.10.0...v6.0.0) (2022-05-22) 826 | 827 | 828 | ### ⚠ BREAKING CHANGES 829 | 830 | * Upgrade to CSpell 6.0.0 (#141) 831 | 832 | ### Features 833 | 834 | * Upgrade to CSpell 6.0.0 ([#141](https://github.com/streetsidesoftware/cspell-cli/issues/141)) ([df3c79b](https://github.com/streetsidesoftware/cspell-cli/commit/df3c79bcd9c5745e4ebdeb5cc250ead15324ce1e)) 835 | 836 | 837 | ### Bug Fixes 838 | 839 | * Update README.md ([#143](https://github.com/streetsidesoftware/cspell-cli/issues/143)) ([fa9f036](https://github.com/streetsidesoftware/cspell-cli/commit/fa9f036a6c61ce4c1e4618a859be3fe3771540a5)) 840 | 841 | ## [5.10.0](https://github.com/streetsidesoftware/cspell-cli/compare/v5.9.1...v5.10.0) (2022-05-22) 842 | 843 | 844 | ### Features 845 | 846 | * Upgrade to CSpell 5.20.0 ([#136](https://github.com/streetsidesoftware/cspell-cli/issues/136)) ([608edbb](https://github.com/streetsidesoftware/cspell-cli/commit/608edbb5f7ac232be8beaa51324cf90baca4a527)) 847 | 848 | ### [5.9.1](https://github.com/streetsidesoftware/cspell-cli/compare/v5.9.0...v5.9.1) (2022-04-11) 849 | 850 | ## [5.9.0](https://github.com/streetsidesoftware/cspell-cli/compare/v5.8.4...v5.9.0) (2022-03-12) 851 | 852 | ### [5.8.4](https://github.com/streetsidesoftware/cspell-cli/compare/v5.8.1...v5.8.4) (2022-02-21) 853 | 854 | 855 | ### Bug Fixes 856 | 857 | * Update to cspell 5.18.5 ([#115](https://github.com/streetsidesoftware/cspell-cli/issues/115)) ([e46bbb9](https://github.com/streetsidesoftware/cspell-cli/commit/e46bbb9e181318f4cfefcfde11d00e17742090f2)) 858 | * Upgrade cspell to 5.18.3 ([#110](https://github.com/streetsidesoftware/cspell-cli/issues/110)) ([c01ed90](https://github.com/streetsidesoftware/cspell-cli/commit/c01ed90ee4f45f73af47916d3cb025b42b525f15)) 859 | 860 | ### [5.8.2](https://github.com/streetsidesoftware/cspell-cli/compare/v5.8.1...v5.8.2) (2022-02-21) 861 | 862 | 863 | ### Bug Fixes 864 | 865 | * Update to cspell 5.18.5 ([#115](https://github.com/streetsidesoftware/cspell-cli/issues/115)) ([e46bbb9](https://github.com/streetsidesoftware/cspell-cli/commit/e46bbb9e181318f4cfefcfde11d00e17742090f2)) 866 | * Upgrade cspell to 5.18.3 ([#110](https://github.com/streetsidesoftware/cspell-cli/issues/110)) ([c01ed90](https://github.com/streetsidesoftware/cspell-cli/commit/c01ed90ee4f45f73af47916d3cb025b42b525f15)) 867 | 868 | ### [5.8.1](https://github.com/streetsidesoftware/cspell-cli/compare/v5.8.0...v5.8.1) (2022-02-01) 869 | 870 | 871 | ### Bug Fixes 872 | 873 | * Update readme to use the general version. ([#108](https://github.com/streetsidesoftware/cspell-cli/issues/108)) ([d0e1fd2](https://github.com/streetsidesoftware/cspell-cli/commit/d0e1fd267b34f3a7adf31d2ff2eacfd72ec17d48)) 874 | 875 | ## [5.8.0](https://github.com/streetsidesoftware/cspell-cli/compare/v5.7.0...v5.8.0) (2022-02-01) 876 | 877 | 878 | ### Features 879 | 880 | * Upgrade to cspell 5.17.0 ([#104](https://github.com/streetsidesoftware/cspell-cli/issues/104)) ([47f575d](https://github.com/streetsidesoftware/cspell-cli/commit/47f575defe2ddfe2076f57e3f20da297071bd010)) 881 | 882 | ## [5.7.0](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.12...v5.7.0) (2022-01-21) 883 | 884 | ### [5.6.12](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.11...v5.6.12) (2021-12-29) 885 | 886 | ### [5.6.11](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.10...v5.6.11) (2021-12-02) 887 | 888 | ### [5.6.10](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.9...v5.6.10) (2021-10-06) 889 | 890 | ### [5.6.9](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.8...v5.6.9) (2021-09-24) 891 | 892 | ### [5.6.7](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.6...v5.6.7) (2021-09-13) 893 | 894 | ### [5.6.6](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.5...v5.6.6) (2021-09-13) 895 | 896 | 897 | ### Bug Fixes 898 | 899 | * Create .pre-commit-hooks.yaml ([#48](https://github.com/streetsidesoftware/cspell-cli/issues/48)) ([982d5b1](https://github.com/streetsidesoftware/cspell-cli/commit/982d5b1f0b3ffa2676888a40e81194b32e1a6d61)) 900 | 901 | ### [5.6.5](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.4...v5.6.5) (2021-09-12) 902 | 903 | 904 | ### Bug Fixes 905 | 906 | * Update cspell to 5.9.0 ([#37](https://github.com/streetsidesoftware/cspell-cli/issues/37)) ([dd68418](https://github.com/streetsidesoftware/cspell-cli/commit/dd68418995edebd8e0cdbfdae6effa15ae4dc481)) 907 | 908 | ### [5.6.4](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.3...v5.6.4) (2021-08-21) 909 | 910 | ### [5.6.3](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.2...v5.6.3) (2021-06-10) 911 | 912 | ### [5.6.2](https://github.com/streetsidesoftware/cspell-cli/compare/v1.0.1...v5.6.2) (2021-06-10) 913 | 914 | 915 | ### Bug Fixes 916 | 917 | * Have the Major and Minor version match `cspell` ([c433c1a](https://github.com/streetsidesoftware/cspell-cli/commit/c433c1a0e2e1064df418ae777c2dc5bd388cf2db)) 918 | 919 | ### [1.0.1](https://github.com/streetsidesoftware/cspell-cli/compare/v1.0.0...v1.0.1) (2021-06-10) 920 | 921 | ## [1.0.0](https://github.com/streetsidesoftware/cspell-cli/compare/v0.0.1...v1.0.0) (2021-06-05) 922 | 923 | 924 | ### Bug Fixes 925 | 926 | * fix setup instructions ([d725ad1](https://github.com/streetsidesoftware/cspell-cli/commit/d725ad1477320638209e1f9bce53f1a72efa7c0f)) 927 | 928 | ### 0.0.1 (2021-06-05) 929 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:22-alpine 2 | 3 | WORKDIR /app 4 | ENV HOME=/home 5 | COPY package-lock.json package.json index.js ./ 6 | RUN npm ci --omit=dev 7 | RUN npm install --location=global 8 | 9 | WORKDIR /workdir 10 | ENTRYPOINT [ "cspell-cli" ] 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Street Side Software 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cspell-cli 2 | 3 | ## Usage 4 | 5 | To check all files under the current directory, run: 6 | 7 | ``` 8 | npx cspell-cli --gitignore . 9 | ``` 10 | 11 | ## Setup [pre-commit](https://pre-commit.com) Hook 12 | 13 | This repository enables using [cspell](https://github.com/streetsidesoftware/cspell) as a [pre-commit](https://pre-commit.com) hook. 14 | 15 | 16 | 17 | ```yaml 18 | # .pre-commit-config.yaml 19 | repos: 20 | - repo: https://github.com/streetsidesoftware/cspell-cli 21 | rev: v9.0.1 22 | hooks: 23 | - id: cspell # Spell check changed files 24 | - id: cspell # Spell check the commit message 25 | name: check commit message spelling 26 | args: 27 | - --no-must-find-files 28 | - --no-progress 29 | - --no-summary 30 | - --files 31 | - .git/COMMIT_EDITMSG 32 | stages: [commit-msg] 33 | always_run: true # This might not be necessary. 34 | ``` 35 | 36 | 37 | 38 | ## Setup Custom Dictionary 39 | 40 | To use a custom dictionary with the `pre-commit` hook, create either a `cspell.config.yaml` or `cspell.json` file in your project's root directory. 41 | 42 | `cspell.config.yaml` 43 | 44 | ```yaml 45 | dictionaryDefinitions: 46 | - name: myWords 47 | path: ./path/to/cSpell_dict.txt 48 | addWords: true 49 | dictionaries: 50 | - myWords 51 | ``` 52 | 53 | `cSpell.json` 54 | 55 | ```json 56 | { 57 | "dictionaryDefinitions": [ 58 | { 59 | "name": "myWords", 60 | "path": "./path/to/cSpell_dict.txt", 61 | "addWords": true 62 | } 63 | ], 64 | "dictionaries": ["myWords"] 65 | } 66 | ``` 67 | 68 | If you installed the [Code Spell Checker extension](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for VS Code, this can be done automatically from the command palette by running "Spell: Create a CSpell configuration file". 69 | 70 | ## Install from GitHub 71 | 72 | This repo also allows installing the `cspell-cli` directly from GitHub: 73 | 74 | ``` 75 | npm install -g git+https://github.com/streetsidesoftware/cspell-cli 76 | ``` 77 | 78 | ## Docker 79 | 80 | [Package cspell](https://github.com/streetsidesoftware/cspell-cli/pkgs/container/cspell) 81 | 82 | ```sh 83 | docker run -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest "**" 84 | ``` 85 | 86 | See [Extending the Docker Container to include German](https://github.com/streetsidesoftware/cspell-cli/tree/main/docker/german/README.md) 87 | 88 | ## Usage 89 | 90 | `cspell --help`: 91 | 92 | 93 | 94 | ``` 95 | Usage: cspell [options] [command] 96 | 97 | Spelling Checker for Code 98 | 99 | Options: 100 | -V, --version output the version number 101 | -h, --help display help for command 102 | 103 | Commands: 104 | lint [options] [globs...] Check spelling 105 | trace [options] [words...] Trace words -- Search for words in the 106 | configuration and dictionaries. 107 | check [options] Spell check file(s) and display the 108 | result. The full file is displayed in 109 | color. 110 | suggestions|sug [options] [words...] Spelling Suggestions for words. 111 | link Link dictionaries and other settings to 112 | the cspell global config. 113 | help [command] display help for command 114 | ``` 115 | 116 | 117 | 118 | ### Lint 119 | 120 | `lint` is the default command. 121 | 122 | `cspell lint --help`: 123 | 124 | 125 | 126 | ``` 127 | Usage: cspell lint [options] [globs...] [file:// ...] [stdin[://]] 128 | 129 | Patterns: 130 | - [globs...] Glob Patterns 131 | - [stdin] Read from "stdin" assume text file. 132 | - [stdin://] Read from "stdin", use for file type and config. 133 | - [file://] Check the file at 134 | 135 | Examples: 136 | cspell . Recursively check all files. 137 | cspell lint . The same as "cspell ." 138 | cspell "*.js" Check all .js files in the current directory 139 | cspell "**/*.js" Check all .js files recursively 140 | cspell "src/**/*.js" Only check .js under src 141 | cspell "**/*.txt" "**/*.js" Check both .js and .txt files. 142 | cspell "**/*.{txt,js,md}" Check .txt, .js, and .md files. 143 | cat LICENSE | cspell stdin Check stdin 144 | cspell stdin://docs/doc.md Check stdin as if it was "./docs/doc.md" 145 | 146 | Check spelling 147 | 148 | Options: 149 | -c, --config Configuration file to use. By default cspell 150 | looks for cspell.json in the current directory. 151 | -v, --verbose Display more information about the files being 152 | checked and the configuration. 153 | --locale Set language locales. i.e. "en,fr" for English 154 | and French, or "en-GB" for British English. 155 | --language-id Force programming language for unknown 156 | extensions. i.e. "php" or "scala" 157 | --words-only Only output the words not found in the 158 | dictionaries. 159 | -u, --unique Only output the first instance of a word not 160 | found in the dictionaries. 161 | -e, --exclude Exclude files matching the glob pattern. This 162 | option can be used multiple times to add multiple 163 | globs. 164 | --file-list Specify a list of files to be spell checked. The 165 | list is filtered against the glob file patterns. 166 | Note: the format is 1 file path per line. 167 | --file [file...] Specify files to spell check. They are filtered 168 | by the [globs...]. 169 | --no-issues Do not show the spelling errors. 170 | --no-progress Turn off progress messages 171 | --no-summary Turn off summary message in console. 172 | -s, --silent Silent mode, suppress error messages. 173 | --no-exit-code Do not return an exit code if issues are found. 174 | --quiet Only show spelling issues or errors. 175 | --fail-fast Exit after first file with an issue or error. 176 | -r, --root Root directory, defaults to current directory. 177 | --no-relative Issues are displayed with absolute path instead 178 | of relative to the root. 179 | --show-context Show the surrounding text around an issue. 180 | --show-suggestions Show spelling suggestions. 181 | --no-show-suggestions Do not show spelling suggestions or fixes. 182 | --no-must-find-files Do not error if no files are found. 183 | --cache Use cache to only check changed files. 184 | --no-cache Do not use cache. 185 | --cache-reset Reset the cache file. 186 | --cache-strategy Strategy to use for detecting changed files. 187 | (choices: "content", "metadata", default: 188 | "content") 189 | --cache-location Path to the cache file or directory. (default: 190 | ".cspellcache") 191 | --dot Include files and directories starting with `.` 192 | (period) when matching globs. 193 | --gitignore Ignore files matching glob patterns found in 194 | .gitignore files. 195 | --no-gitignore Do NOT use .gitignore files. 196 | --gitignore-root Prevent searching for .gitignore files past root. 197 | --validate-directives Validate in-document CSpell directives. 198 | --color Force color. 199 | --no-color Turn off color. 200 | --no-default-configuration Do not load the default configuration and 201 | dictionaries. 202 | --debug Output information useful for debugging 203 | cspell.json files. 204 | --reporter Specify one or more reporters to use. 205 | --issue-template [template] Use a custom issue template. See --help 206 | --issue-template for details. 207 | -h, --help display help for command 208 | 209 | More Examples: 210 | 211 | cspell "**/*.js" --reporter @cspell/cspell-json-reporter 212 | This will spell check all ".js" files recursively and use 213 | "@cspell/cspell-json-reporter". 214 | 215 | cspell . --reporter default 216 | This will force the default reporter to be used overriding 217 | any reporters defined in the configuration. 218 | 219 | cspell . --reporter .//reporter.cjs 220 | Use a custom reporter. See API for details. 221 | 222 | cspell "*.md" --exclude CHANGELOG.md --files README.md CHANGELOG.md 223 | Spell check only check "README.md" but NOT "CHANGELOG.md". 224 | 225 | cspell "/*.md" --no-must-find-files --files $FILES 226 | Only spell check the "/*.md" files in $FILES, 227 | where $FILES is a shell variable that contains the list of files. 228 | 229 | References: 230 | https://cspell.org 231 | https://github.com/streetsidesoftware/cspell 232 | ``` 233 | 234 | 235 | 236 | ### Trace 237 | 238 | `cspell trace --help`: 239 | 240 | 241 | 242 | ``` 243 | Usage: cspell trace [options] [words...] 244 | 245 | Trace words -- Search for words in the configuration and dictionaries. 246 | 247 | Options: 248 | -c, --config Configuration file to use. By default cspell 249 | looks for cspell.json in the current directory. 250 | --locale Set language locales. i.e. "en,fr" for English and 251 | French, or "en-GB" for British English. 252 | --language-id Use programming language. i.e. "php" or "scala". 253 | --allow-compound-words Turn on allowCompoundWords 254 | --no-allow-compound-words Turn off allowCompoundWords 255 | --ignore-case Ignore case and accents when searching for words. 256 | --no-ignore-case Do not ignore case and accents when searching for 257 | words. 258 | --dictionary-path Configure how to display the dictionary path. 259 | (choices: "hide", "short", "long", "full", 260 | default: Display most of the path.) 261 | --stdin Read words from stdin. 262 | --all Show all dictionaries. 263 | --only-found Show only dictionaries that have the words. 264 | --color Force color. 265 | --no-color Turn off color. 266 | --no-default-configuration Do not load the default configuration and 267 | dictionaries. 268 | -h, --help display help for command 269 | ``` 270 | 271 | 272 | 273 | ### Check 274 | 275 | `cspell check --help`: 276 | 277 | 278 | 279 | ``` 280 | Usage: cspell check [options] 281 | 282 | Spell check file(s) and display the result. The full file is displayed in color. 283 | 284 | Options: 285 | -c, --config Configuration file to use. By default cspell 286 | looks for cspell.json in the current directory. 287 | --validate-directives Validate in-document CSpell directives. 288 | --no-validate-directives Do not validate in-document CSpell directives. 289 | --no-color Turn off color. 290 | --color Force color 291 | --no-exit-code Do not return an exit code if issues are found. 292 | --no-default-configuration Do not load the default configuration and 293 | dictionaries. 294 | -h, --help display help for command 295 | ``` 296 | 297 | 298 | 299 | ### Suggestions 300 | 301 | `cspell suggestions --help`: 302 | 303 | 304 | 305 | ``` 306 | Usage: cspell suggestions|sug [options] [words...] 307 | 308 | Spelling Suggestions for words. 309 | 310 | Options: 311 | -c, --config Configuration file to use. By default 312 | cspell looks for cspell.json in the 313 | current directory. 314 | --locale Set language locales. i.e. "en,fr" for 315 | English and French, or "en-GB" for 316 | British English. 317 | --language-id Use programming language. i.e. "php" or 318 | "scala". 319 | -s, --no-strict Ignore case and accents when searching 320 | for words. 321 | --ignore-case Alias of --no-strict. 322 | --num-changes Number of changes allowed to a word 323 | (default: 4) 324 | --num-suggestions Number of suggestions (default: 8) 325 | --no-include-ties Force the number of suggested to be 326 | limited, by not including suggestions 327 | that have the same edit cost. 328 | --stdin Use stdin for input. 329 | --repl REPL interface for looking up 330 | suggestions. 331 | -v, --verbose Show detailed output. 332 | -d, --dictionary Use the dictionary specified. Only 333 | dictionaries specified will be used. 334 | --dictionaries Use the dictionaries specified. Only 335 | dictionaries specified will be used. 336 | --no-color Turn off color. 337 | --color Force color 338 | -h, --help display help for command 339 | ``` 340 | 341 | 342 | 343 | ### Link 344 | 345 | `cspell link --help`: 346 | 347 | 348 | 349 | ``` 350 | Usage: cspell link [options] [command] 351 | 352 | Link dictionaries and other settings to the cspell global config. 353 | 354 | Options: 355 | -h, --help display help for command 356 | 357 | Commands: 358 | list|ls List currently linked configurations. 359 | add|a Add dictionaries any other settings to the cspell 360 | global config. 361 | remove|r Remove matching paths / packages from the global 362 | config. 363 | help [command] display help for command 364 | ``` 365 | 366 | 367 | 368 | ## Versioning 369 | 370 | The major version of `cspell-cli` tries to match the major version of `cspell`. 371 | 372 | `minor` and `patch` versioning goes up independently from `cspell`. Where possible, the `minor` version should match `cspell`. 373 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | | Version | Supported | 6 | | ------- | ------------------ | 7 | | 8.x | :white_check_mark: | 8 | 9 | ## Reporting a Vulnerability 10 | 11 | ## Security contact information 12 | 13 | To report a security vulnerability, please use the 14 | [Tidelift security contact](https://tidelift.com/security). 15 | Tidelift will coordinate the fix and disclosure. 16 | 17 | or send an email to [security@streetsidesoftware.com](mailto:security@streetsidesoftware.com) 18 | -------------------------------------------------------------------------------- /cspell.json: -------------------------------------------------------------------------------- 1 | { 2 | "files": ["**", ".*/**"], 3 | "ignorePaths": [ 4 | ".git", 5 | ".gitignore", 6 | "CHANGELOG.md", 7 | "node_modules", 8 | "package-lock.json" 9 | ], 10 | "words": ["codeql", "streetsidesoftware", "workdir", "COMMIT_EDITMSG"] 11 | } 12 | -------------------------------------------------------------------------------- /docker/german/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ghcr.io/streetsidesoftware/cspell:8.4.1 2 | 3 | WORKDIR /app 4 | ENV HOME=/home 5 | RUN npm install @cspell/dict-de-de@3.2.0 6 | RUN cspell-cli link add @cspell/dict-de-de 7 | 8 | WORKDIR /workdir 9 | -------------------------------------------------------------------------------- /docker/german/README.md: -------------------------------------------------------------------------------- 1 | # Extending the Docker Container to include German 2 | 3 | The CSpell container has all the default dictionaries installed, but to include other dictionaries, 4 | it is necessary to extend the container. 5 | 6 | **`Dockerfile`** 7 | 8 | ```dockerfile 9 | FROM ghcr.io/streetsidesoftware/cspell:8.4.1 10 | 11 | WORKDIR /app 12 | # Setting HOME is necessary to set the location of CSpell's global config. 13 | ENV HOME=/home 14 | # Install the dictionaries we want 15 | RUN npm install @cspell/dict-de-de@3.2.0 16 | # Link the dictionaries so that CSpell is aware of them by default. 17 | RUN cspell-cli link add @cspell/dict-de-de 18 | 19 | # Restore the working directory to the virtual directory. 20 | WORKDIR /workdir 21 | ``` 22 | 23 | ## Building 24 | 25 | ```sh 26 | docker build -t cspell-german:latest . 27 | ``` 28 | 29 | ## Running 30 | 31 | Example of `cspell trace` command: 32 | 33 | ```sh 34 | docker run -v $PWD:/workdir \ 35 | cspell-german:latest \ 36 | trace Strasse \ 37 | --locale=de --dictionary-path=short 38 | ``` 39 | 40 | **Result:** 41 | 42 | ``` 43 | Word F Dictionary Dictionary Location 44 | Strasse - [flagWords]* From Settings `flagWords` 45 | Strasse - [ignoreWords]* From Settings `ignoreWords` 46 | Strasse - [suggestWords]* From Settings `suggestWords` 47 | Strasse - [words]* From Settings `words` 48 | Strasse - aws* [node_modules]/aws.txt 49 | Strasse - companies* [node_modules]/companies.txt 50 | Strasse - computing-acronyms* [node_modules]/computing-acronyms.txt 51 | Strasse - cryptocurrencies* [node_modules]/cryptocurrencies.txt 52 | Straße * de-de* [node_modules]/de_DE.trie.gz 53 | Strasse - filetypes* [node_modules]/filetypes.txt.gz 54 | Strasse - public-licenses* [node_modules]/public-licenses.txt.gz 55 | Strasse - softwareTerms* [node_modules]/softwareTerms.txt 56 | Strasse - web-services* [node_modules]/webServices.txt 57 | ``` 58 | 59 | ## CSpell Configuration 60 | 61 | It is necessary to enable the locale for the dictionary to be used. On the command line, it is `--locale=`, i.e. `--locale=de,en` for German and English. 62 | 63 | In a CSpell Configuration file: 64 | 65 | **`cspell.config.yaml`** 66 | 67 | ```yaml 68 | language: de,en 69 | ``` 70 | 71 | **`cspell.json`** 72 | 73 | ```json 74 | { 75 | "language": "de,en" 76 | } 77 | ``` 78 | 79 | 80 | -------------------------------------------------------------------------------- /docker/german/cspell.config.yaml: -------------------------------------------------------------------------------- 1 | language: en,de 2 | words: 3 | - workdir 4 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | import "cspell/bin"; 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cspell-cli", 3 | "publishConfig": { 4 | "access": "public", 5 | "provenance": true 6 | }, 7 | "version": "9.0.1", 8 | "description": "CLI for cspell; A Spelling Checker for Code!", 9 | "type": "module", 10 | "module": "index.js", 11 | "bin": { 12 | "cspell-cli": "index.js" 13 | }, 14 | "scripts": { 15 | "version-prerelease": "npx version-release -p", 16 | "version-release-minor": "npx standard-version -r minor", 17 | "version-release-patch": "npx standard-version -r patch", 18 | "version-release": "npx standard-version", 19 | "lint:fix": "prettier -w .", 20 | "build:readme": "npm run build:help && npm run build:help-lint && npm run build:help-trace && npm run build:help-check && npm run build:help-suggestions && npm run build:help-link && inject-markdown README.md", 21 | "build:help": "node index.js --help > static/help.txt", 22 | "build:help-lint": "node index.js lint --help > static/help-lint.txt", 23 | "build:help-trace": "node index.js trace --help > static/help-trace.txt", 24 | "build:help-check": "node index.js check --help > static/help-check.txt", 25 | "build:help-suggestions": "node index.js suggestions --help > static/help-suggestions.txt", 26 | "build:help-link": "node index.js link --help > static/help-link.txt", 27 | "test": "node ./index.js ." 28 | }, 29 | "repository": { 30 | "type": "git", 31 | "url": "git+https://github.com/streetsidesoftware/cspell-cli.git" 32 | }, 33 | "keywords": [ 34 | "cspell" 35 | ], 36 | "author": "Jason Dent", 37 | "license": "MIT", 38 | "bugs": { 39 | "url": "https://github.com/streetsidesoftware/cspell-cli/issues" 40 | }, 41 | "homepage": "https://github.com/streetsidesoftware/cspell-cli#readme", 42 | "files": [ 43 | ".pre-commit-hooks.yaml", 44 | "index.js" 45 | ], 46 | "engines": { 47 | "node": ">=20" 48 | }, 49 | "dependencies": { 50 | "cspell": "^9.0.2" 51 | }, 52 | "devDependencies": { 53 | "inject-markdown": "^3.1.4", 54 | "prettier": "^3.5.3" 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /release-please-config.json: -------------------------------------------------------------------------------- 1 | { 2 | "bootstrap-sha": "02f37846182a6805645dd5bad41f9a880b00d5be", 3 | "include-component-in-tag": false, 4 | "include-v-in-tag": true, 5 | "changelog-sections": [ 6 | { 7 | "type": "feat", 8 | "section": "Features" 9 | }, 10 | { 11 | "type": "feature", 12 | "section": "Features" 13 | }, 14 | { 15 | "type": "fix", 16 | "section": "Trivial updates and changes." 17 | }, 18 | { 19 | "type": "perf", 20 | "section": "Performance Improvements" 21 | }, 22 | { 23 | "type": "revert", 24 | "section": "Reverts" 25 | }, 26 | { 27 | "type": "docs", 28 | "section": "Documentation", 29 | "hidden": true 30 | }, 31 | { 32 | "type": "style", 33 | "section": "Styles", 34 | "hidden": true 35 | }, 36 | { 37 | "type": "chore", 38 | "section": "Miscellaneous Chores", 39 | "hidden": true 40 | }, 41 | { 42 | "type": "refactor", 43 | "section": "Code Refactoring", 44 | "hidden": true 45 | }, 46 | { 47 | "type": "test", 48 | "section": "Tests", 49 | "hidden": true 50 | }, 51 | { 52 | "type": "build", 53 | "section": "Build System", 54 | "hidden": true 55 | }, 56 | { 57 | "type": "ci", 58 | "section": "Continuous Integration", 59 | "hidden": true 60 | } 61 | ], 62 | "packages": { 63 | ".": { 64 | "releaseType": "node", 65 | "extra-files": ["README.md"] 66 | } 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /static/help-check.txt: -------------------------------------------------------------------------------- 1 | Usage: cspell check [options] 2 | 3 | Spell check file(s) and display the result. The full file is displayed in color. 4 | 5 | Options: 6 | -c, --config Configuration file to use. By default cspell 7 | looks for cspell.json in the current directory. 8 | --validate-directives Validate in-document CSpell directives. 9 | --no-validate-directives Do not validate in-document CSpell directives. 10 | --no-color Turn off color. 11 | --color Force color 12 | --no-exit-code Do not return an exit code if issues are found. 13 | --no-default-configuration Do not load the default configuration and 14 | dictionaries. 15 | -h, --help display help for command 16 | -------------------------------------------------------------------------------- /static/help-link.txt: -------------------------------------------------------------------------------- 1 | Usage: cspell link [options] [command] 2 | 3 | Link dictionaries and other settings to the cspell global config. 4 | 5 | Options: 6 | -h, --help display help for command 7 | 8 | Commands: 9 | list|ls List currently linked configurations. 10 | add|a Add dictionaries any other settings to the cspell 11 | global config. 12 | remove|r Remove matching paths / packages from the global 13 | config. 14 | help [command] display help for command 15 | -------------------------------------------------------------------------------- /static/help-lint.txt: -------------------------------------------------------------------------------- 1 | Usage: cspell lint [options] [globs...] [file:// ...] [stdin[://]] 2 | 3 | Patterns: 4 | - [globs...] Glob Patterns 5 | - [stdin] Read from "stdin" assume text file. 6 | - [stdin://] Read from "stdin", use for file type and config. 7 | - [file://] Check the file at 8 | 9 | Examples: 10 | cspell . Recursively check all files. 11 | cspell lint . The same as "cspell ." 12 | cspell "*.js" Check all .js files in the current directory 13 | cspell "**/*.js" Check all .js files recursively 14 | cspell "src/**/*.js" Only check .js under src 15 | cspell "**/*.txt" "**/*.js" Check both .js and .txt files. 16 | cspell "**/*.{txt,js,md}" Check .txt, .js, and .md files. 17 | cat LICENSE | cspell stdin Check stdin 18 | cspell stdin://docs/doc.md Check stdin as if it was "./docs/doc.md" 19 | 20 | Check spelling 21 | 22 | Options: 23 | -c, --config Configuration file to use. By default cspell 24 | looks for cspell.json in the current directory. 25 | -v, --verbose Display more information about the files being 26 | checked and the configuration. 27 | --locale Set language locales. i.e. "en,fr" for English 28 | and French, or "en-GB" for British English. 29 | --language-id Force programming language for unknown 30 | extensions. i.e. "php" or "scala" 31 | --words-only Only output the words not found in the 32 | dictionaries. 33 | -u, --unique Only output the first instance of a word not 34 | found in the dictionaries. 35 | -e, --exclude Exclude files matching the glob pattern. This 36 | option can be used multiple times to add multiple 37 | globs. 38 | --file-list Specify a list of files to be spell checked. The 39 | list is filtered against the glob file patterns. 40 | Note: the format is 1 file path per line. 41 | --file [file...] Specify files to spell check. They are filtered 42 | by the [globs...]. 43 | --no-issues Do not show the spelling errors. 44 | --no-progress Turn off progress messages 45 | --no-summary Turn off summary message in console. 46 | -s, --silent Silent mode, suppress error messages. 47 | --no-exit-code Do not return an exit code if issues are found. 48 | --quiet Only show spelling issues or errors. 49 | --fail-fast Exit after first file with an issue or error. 50 | -r, --root Root directory, defaults to current directory. 51 | --no-relative Issues are displayed with absolute path instead 52 | of relative to the root. 53 | --show-context Show the surrounding text around an issue. 54 | --show-suggestions Show spelling suggestions. 55 | --no-show-suggestions Do not show spelling suggestions or fixes. 56 | --no-must-find-files Do not error if no files are found. 57 | --cache Use cache to only check changed files. 58 | --no-cache Do not use cache. 59 | --cache-reset Reset the cache file. 60 | --cache-strategy Strategy to use for detecting changed files. 61 | (choices: "content", "metadata", default: 62 | "content") 63 | --cache-location Path to the cache file or directory. (default: 64 | ".cspellcache") 65 | --dot Include files and directories starting with `.` 66 | (period) when matching globs. 67 | --gitignore Ignore files matching glob patterns found in 68 | .gitignore files. 69 | --no-gitignore Do NOT use .gitignore files. 70 | --gitignore-root Prevent searching for .gitignore files past root. 71 | --validate-directives Validate in-document CSpell directives. 72 | --color Force color. 73 | --no-color Turn off color. 74 | --no-default-configuration Do not load the default configuration and 75 | dictionaries. 76 | --debug Output information useful for debugging 77 | cspell.json files. 78 | --reporter Specify one or more reporters to use. 79 | --issue-template [template] Use a custom issue template. See --help 80 | --issue-template for details. 81 | -h, --help display help for command 82 | 83 | More Examples: 84 | 85 | cspell "**/*.js" --reporter @cspell/cspell-json-reporter 86 | This will spell check all ".js" files recursively and use 87 | "@cspell/cspell-json-reporter". 88 | 89 | cspell . --reporter default 90 | This will force the default reporter to be used overriding 91 | any reporters defined in the configuration. 92 | 93 | cspell . --reporter .//reporter.cjs 94 | Use a custom reporter. See API for details. 95 | 96 | cspell "*.md" --exclude CHANGELOG.md --files README.md CHANGELOG.md 97 | Spell check only check "README.md" but NOT "CHANGELOG.md". 98 | 99 | cspell "/*.md" --no-must-find-files --files $FILES 100 | Only spell check the "/*.md" files in $FILES, 101 | where $FILES is a shell variable that contains the list of files. 102 | 103 | References: 104 | https://cspell.org 105 | https://github.com/streetsidesoftware/cspell 106 | 107 | -------------------------------------------------------------------------------- /static/help-suggestions.txt: -------------------------------------------------------------------------------- 1 | Usage: cspell suggestions|sug [options] [words...] 2 | 3 | Spelling Suggestions for words. 4 | 5 | Options: 6 | -c, --config Configuration file to use. By default 7 | cspell looks for cspell.json in the 8 | current directory. 9 | --locale Set language locales. i.e. "en,fr" for 10 | English and French, or "en-GB" for 11 | British English. 12 | --language-id Use programming language. i.e. "php" or 13 | "scala". 14 | -s, --no-strict Ignore case and accents when searching 15 | for words. 16 | --ignore-case Alias of --no-strict. 17 | --num-changes Number of changes allowed to a word 18 | (default: 4) 19 | --num-suggestions Number of suggestions (default: 8) 20 | --no-include-ties Force the number of suggested to be 21 | limited, by not including suggestions 22 | that have the same edit cost. 23 | --stdin Use stdin for input. 24 | --repl REPL interface for looking up 25 | suggestions. 26 | -v, --verbose Show detailed output. 27 | -d, --dictionary Use the dictionary specified. Only 28 | dictionaries specified will be used. 29 | --dictionaries Use the dictionaries specified. Only 30 | dictionaries specified will be used. 31 | --no-color Turn off color. 32 | --color Force color 33 | -h, --help display help for command 34 | -------------------------------------------------------------------------------- /static/help-trace.txt: -------------------------------------------------------------------------------- 1 | Usage: cspell trace [options] [words...] 2 | 3 | Trace words -- Search for words in the configuration and dictionaries. 4 | 5 | Options: 6 | -c, --config Configuration file to use. By default cspell 7 | looks for cspell.json in the current directory. 8 | --locale Set language locales. i.e. "en,fr" for English and 9 | French, or "en-GB" for British English. 10 | --language-id Use programming language. i.e. "php" or "scala". 11 | --allow-compound-words Turn on allowCompoundWords 12 | --no-allow-compound-words Turn off allowCompoundWords 13 | --ignore-case Ignore case and accents when searching for words. 14 | --no-ignore-case Do not ignore case and accents when searching for 15 | words. 16 | --dictionary-path Configure how to display the dictionary path. 17 | (choices: "hide", "short", "long", "full", 18 | default: Display most of the path.) 19 | --stdin Read words from stdin. 20 | --all Show all dictionaries. 21 | --only-found Show only dictionaries that have the words. 22 | --color Force color. 23 | --no-color Turn off color. 24 | --no-default-configuration Do not load the default configuration and 25 | dictionaries. 26 | -h, --help display help for command 27 | -------------------------------------------------------------------------------- /static/help.txt: -------------------------------------------------------------------------------- 1 | Usage: cspell [options] [command] 2 | 3 | Spelling Checker for Code 4 | 5 | Options: 6 | -V, --version output the version number 7 | -h, --help display help for command 8 | 9 | Commands: 10 | lint [options] [globs...] Check spelling 11 | trace [options] [words...] Trace words -- Search for words in the 12 | configuration and dictionaries. 13 | check [options] Spell check file(s) and display the 14 | result. The full file is displayed in 15 | color. 16 | suggestions|sug [options] [words...] Spelling Suggestions for words. 17 | link Link dictionaries and other settings to 18 | the cspell global config. 19 | help [command] display help for command 20 | --------------------------------------------------------------------------------