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 pre-commit support #43

Open
rdturnermtl opened this issue Feb 11, 2020 · 0 comments
Open

Add pre-commit support #43

rdturnermtl opened this issue Feb 11, 2020 · 0 comments

Comments

@rdturnermtl
Copy link

It would be nice if scspell supported the pre-commit tool as has been done with codespell.

We just need to add a .pre-commit-hooks.yaml file at the top level. It would look something like:

-   id: scspell
    name: scspell
    description: 'spell checking'
    entry: scspell
    args: [--report-only]
    language: python
    types: [text]

The user would then need to add their source controlled dictionaries. The user .pre-commit-config.yaml would use a:

- repo: https://github.com/myint/scspell
  rev: [new version #]
  hooks:
    - id: scspell
      args: [--use-builtin-base-dict,--override-dictionary=/path/to/dictionary_file.txt]

Hopefully this configuration would make things "stateless" enough that it could be run across different machines without any issue.

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

No branches or pull requests

1 participant