docs icon indicating copy to clipboard operation
docs copied to clipboard

Integrate spell checker into GitHub workflows

Open viachaslavic opened this issue 1 year ago • 1 comments

Add typos-action for changed files in PR's . Exceptions can be added to the _typos.toml config file.

viachaslavic avatar Dec 17 '24 01:12 viachaslavic

The current implementation of this action will display found errors in the workflow log. I think to wait for an update with a code suggestion in Sarif format.

viachaslavic avatar Dec 18 '24 08:12 viachaslavic

Could help #297

gouchi avatar Apr 08 '25 08:04 gouchi

@viachaslavic Should be good now that Sarif report has been integrated in Typos ?

Thank you.

gouchi avatar Nov 16 '25 13:11 gouchi

@gouchi Yes, the format itself is implemented, but I was thinking of waiting for integration into github-action so that a comment with the spell checking result would be automatically added to pull requests.

In fact, you can already merge it without this feature. In which case the results can be viewed in the annotations by going to Typos Action (for example, as in this PR)

viachaslavic avatar Nov 17 '25 17:11 viachaslavic

@fpscan We should merge this PR ;)

Thank you.

gouchi avatar Nov 17 '25 21:11 gouchi