Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a spellchecker #127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a spellchecker #127

wants to merge 1 commit into from

Conversation

villfa
Copy link
Contributor

@villfa villfa commented Nov 29, 2021

Hi,

What do you think about adding a spellchecker to the CI?

I don't have any experience with these tools in this particular context yet, but TypoCI/spellcheck-action was pretty easy to set up.

I also got inspiration from the php/doc-ru spellcheck workflow.

@Girgias
Copy link
Member

Girgias commented Nov 29, 2021

This looks like a good idea to me, I'll try to have a look at what the failures are.

Might prevent me from introducing loads of grammar mistakes, Which is always a positive.

@Girgias
Copy link
Member

Girgias commented Nov 30, 2021

Seems that we need to add --trace to possibly see which files are affected?

@villfa
Copy link
Contributor Author

villfa commented Nov 30, 2021

I don't think it's feasible just by changing the yaml configuration.

The error message gives this link: https://docs.github.com/en/rest/reference/checks#create-a-check-run
This part could explain the problem:

Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

I may be wrong but I think it is a permission issue.
That could also explain why I don't have this error with my fork : villfa#3

@TPXP
Copy link
Contributor

TPXP commented Dec 31, 2021

TypoCI is being shut down, as explained by its author here: https://mikerogers.io/2021/05/23/saying-goodbye-to-typo-ci

Also, there are other alternatives that don't require installing a Github App (thus will be easier to add confidently).

@Girgias
Copy link
Member

Girgias commented Dec 31, 2021

TypoCI is being shut down, as explained by its author here: https://mikerogers.io/2021/05/23/saying-goodbye-to-typo-ci

Also, there are other alternatives that don't require installing a Github App (thus will be easier to add confidently).

Oh, do you know of any and maybe could propose a PR?

@TPXP
Copy link
Contributor

TPXP commented Jan 1, 2022

There are a few alternatives on Github Actions marketplace, like this one https://github.com/marketplace/actions/github-spellcheck-action

Regarding CLI tools, hunspell or aspell could do the trick. In particular, it's easy to get a French dictonnary for those.

In both cases, I'm not sure if the action will add annotations to the source code file. Manual handling might be required for those, see https://github.com/Attest/annotations-action for an example.

@TPXP
Copy link
Contributor

TPXP commented Jan 1, 2022

Update: I may have spoken a bit too fast on this, it seems only the Github App was discontinued. TypoCI/spellcheck-action#129

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants