streetsidesoftware/cspell-action

Spelling Isn't Checked When Incremental Mode Disabled

Closed this issue · 6 comments

Kurt-von-Laven commented

When passing incremental_files_only: false in a workflow triggered by a pull request event, the cspell action outputs the following and executes in 0 seconds:

Run streetsidesoftware/cspell-action@v1.2.4
  with:
    incremental_files_only: false
    github_token: ***
    inline: warning
    strict: true
cspell-action
Pull Request
Done.
Jason3S commented

Thank you. I would need to take a look at what is going on.

Does files: "**" work for you?

with:
  files: "**"
Kurt-von-Laven commented

Good call! Yes, it does.

owenbendavies commented

I am having the same issue. Adding files: "**" does work however then it doesn't check hidden files:

      - uses: streetsidesoftware/cspell-action@v1

works for just checking files that have changed

      - uses: streetsidesoftware/cspell-action@v1
        with:
          incremental_files_only: false

doesn't check any files

      - uses: streetsidesoftware/cspell-action@v1
        with:
          files: '**'
          incremental_files_only: false

checks all non hidden files, can't think of a single glob to do both hidden and non hidden files, and doesn't support array of globs like cspel.json files setting.

Thank you.

Jason3S commented

@owenbendavies,

If you add enableGlobDot to your cspell.json file, it should should check hidden files.

    "enableGlobDot": true,
    "useGitignore": true,
owenbendavies commented

Ahh thank you, missed that option in the docs. So for now as reference for others I have this in my Github action:

      - uses: streetsidesoftware/cspell-action@v1
         with:
           files: '**'
           incremental_files_only: false

And this in my .cspell.json

{
  "version": "0.2",
  "enableGlobDot": true,
  "files": ["**"],
  "ignorePaths": [".git"],
  "useGitignore": true,

(files in the cypress.json is so I can run locally as well)

Thank you for your help, and for this really good github action as is nicer than running as a command in the github action.

Owen

Jason3S commented

@Kurt-von-Laven,

I have changed it to check all files by default when incremental_files_only is false and files is empty.

  • 👍2