cspell github action

[stanislav-tkach]

It would be nice to have the github action that simplifies the usage of cspell on CI.

[Jason3S]

That is a great idea.

[Jason3S]

A github action is a good idea. It will take a bit of work.
In the mean time: lint.yml

name: lint
on: # rebuild any PRs and main branch changes
  pull_request:
  push:

jobs:
  cspell:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - run: npx cspell "**/{*.ts,*.md}"

[adamralph]

@Jason3S should the link be to cspell.yml?

[nschonni]

There is an Action repo here https://github.com/streetsidesoftware/cspell-action but I don't know if there is more work needed for it

[adamralph]

Is it worth maintaining an action just to wrap npx cspell?

[nschonni]

Depends how it's implemented. If there is a dedicated action, it can do things like streetsidesoftware/cspell-action#9

[Jason3S]

https://github.com/streetsidesoftware/cspell-action is still a work in progress.

Someone else has made a simple version:
simple-cspell · Actions · GitHub Marketplace

[Jason3S]

cspell-action can be found at:
cspell-action · Actions · GitHub Marketplace or
https://github.com/streetsidesoftware/cspell-action

Please try it out. Feedback welcome.

[stanislav-tkach]

Thanks!

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.