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.

Sign up for GitHub

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

Jump to bottom

Document how to use non-default dictionaries with pre-commit #206

Open
danielfdickinson opened this issue Aug 16, 2022 · 2 comments
Open

Document how to use non-default dictionaries with pre-commit #206

danielfdickinson opened this issue Aug 16, 2022 · 2 comments

Comments

@danielfdickinson
Copy link

This is to remind myself to create a Pull Request to include a nicely done up doc for the README (based on streetsidesoftware/cspell#3426) that explains how to use dictionaries not included with cspell-cli by default, when using cspell-cli as a pre-commit hook.
@danielfdickinson
Copy link
Author

@streetsidesoftware @Jason3S Would this make more sense as a separate file (e.g. docs/README-PRE-COMMIT.md), as reasonably complete docs for this could get a little long for the README?

@Jason3S
Copy link
Contributor

Jason3S commented Aug 17, 2022

@danielfdickinson,

Thank you for doing this.

A new doc and a link in the README would be ideal.

danielfdickinson added a commit to danielfdickinson/streetsidesoftware-cspell-cli that referenced this issue Aug 19, 2022
@danielfdickinson
Document using extra dictionaries with pre-commit
73ff949 
This closes streetsidesoftware#206 and stems from
streetsidesoftware/cspell#3426
where I had to dig around rather a lot to pull the pieces together.
Hopefully the docs make life easier for the next person who wants
to do this kind of thing.

Signed-off-by: Daniel F. Dickinson <[email protected]>
danielfdickinson added a commit to danielfdickinson/streetsidesoftware-cspell-cli that referenced this issue Aug 20, 2022
@danielfdickinson
Document using extra dictionaries with pre-commit
5206efb 
This closes streetsidesoftware#206 and stems from
streetsidesoftware/cspell#3426
where I had to dig around rather a lot to pull the pieces together.
Hopefully the docs make life easier for the next person who wants
to do this kind of thing.

Signed-off-by: Daniel F. Dickinson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Jason3S @danielfdickinson