mirror of
https://github.com/mruby/mruby
synced 2026-06-08 16:11:16 +00:00
Remove misspell and update CONTRIBUTING.md
It looks like `misspell` is no longer maintained and the last commit was on `Mar 9, 2018`. We already run `codespell` and it is an active project with the last commit 5 days ago. Also updated the CONTRIBUTING guide with more information on `pre-commit` as well as listed `codespell` as the spell checker. https://github.com/codespell-project/codespell https://github.com/client9/misspell https://github.com/client9/misspell/issues/197
This commit is contained in:
@@ -6,16 +6,6 @@ permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
misspell:
|
||||
name: Check spelling with misspell
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
|
||||
uses: actions/checkout@v3
|
||||
- name: Install
|
||||
run: wget -O - -q https://git.io/misspell | sh -s -- -b .
|
||||
- name: Run misspell
|
||||
run: git ls-files --empty-directory | xargs ./misspell -error
|
||||
pre-commit:
|
||||
name: Run pre-commit
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
+9
-16
@@ -26,8 +26,8 @@ A framework for managing and maintaining multi-language `pre-commit` hooks.
|
||||
You need to first install `pre-commit` and then install the `pre-commit` hooks with `pre-commit install`.
|
||||
Now `pre-commit` will run automatically on git commit!
|
||||
|
||||
It's usually a good idea to run the hooks against all the files when adding new hooks (usually `pre-commit` will only run on the changed files during git hooks).
|
||||
Use `pre-commit run --all-files` to check all files.
|
||||
It's usually a good idea to run the hooks against all the files when adding new hooks (usually `pre-commit`
|
||||
will only run on the changed files during git hooks). Use `pre-commit run --all-files` to check all files.
|
||||
|
||||
To run a single hook use `pre-commit run --all-files <hook_id>`
|
||||
|
||||
@@ -37,12 +37,16 @@ Sometimes you might need to skip one or more hooks which can be done with the `S
|
||||
|
||||
`$ SKIP=yamllint git commit -m "foo"`
|
||||
|
||||
For convenience, we have added `pre-commit run --all-files` and `pre-commit autoupdate`
|
||||
For convenience, we have added `pre-commit run --all-files`, `pre-commit install` and `pre-commit autoupdate`
|
||||
to both the Makefile and the Rakefile. Run them with:
|
||||
|
||||
- `make check` or `rake check`
|
||||
- `make checkinstall` or `rake checkinstall`
|
||||
- `make checkupdate` or `rake checkupdate`
|
||||
|
||||
To configure `pre-commit` you can modify the config file [.pre-commit-config.yaml](.pre-commit-config.yaml).
|
||||
We use [GitHub Actions](.github/workflows/lint.yml) to run `pre-commit` on every pull request.
|
||||
|
||||
### pre-commit quick links
|
||||
|
||||
- [Quick start](https://pre-commit.com/#quick-start)
|
||||
@@ -52,19 +56,8 @@ to both the Makefile and the Rakefile. Run them with:
|
||||
|
||||
## Spell Checking
|
||||
|
||||
We are running [misspell](https://github.com/client9/misspell) which is mainly written in
|
||||
[Golang](https://golang.org/) to check spelling with [GitHub Actions](.github/workflows/lint.yml).
|
||||
Correct commonly misspelled English words quickly with `misspell`. You can run `misspell` locally
|
||||
against all files with:
|
||||
|
||||
```bash
|
||||
find . -type f | xargs ./misspell -error
|
||||
```
|
||||
|
||||
Notable `misspell` help options or flags are:
|
||||
|
||||
- `-i` string: ignore the following corrections, comma separated
|
||||
- `-w`: Overwrite file with corrections (default is just to display)
|
||||
We are using `pre-commit` to run [codespell](https://github.com/codespell-project/codespell)
|
||||
to check code for common misspellings. We have a small custom dictionary file [codespell.txt](codespell.txt).
|
||||
|
||||
## Coding conventions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user