💡: Add .pre-commit-hooks.yaml to enable cspell to be used directly with pre-commit

[abrahan-munro]

Problem

CSpell can be manually installed and set up as a local pre-commit hook (https://www.npmjs.com/package/cspell#git-commit-hooks, https://pre-commit.com/#repository-local-hooks).

Solution

But by adding an appropriate .pre-commit-hooks.yaml to the repo (https://pre-commit.com/#creating-new-hooks) it could be used in the usual way without installing (https://pre-commit.com/#2-add-a-pre-commit-configuration).

Alternatives

This seems to already be supported with cspell-cli, but it appears that won't use the vscode workspace dictionary and configuration: https://github.com/streetsidesoftware/cspell-cli#setup-pre-commit-hook

Additional Context

See the expired issue where this was previously requested, and attempted in a fork: https://github.com/streetsidesoftware/cspell/issues/56.

Code of Conduct

• [x] I agree to follow this project's Code of Conduct

[Jason3S]

@abrahan-munro,

Adding pre-commit-hooks.yaml to the CSpell monorepo doesn't work. It was tried and failed. I could go into the reasons why it doesn't work, but that is not the point here. The cspell-cli repo was created to address the issues of setting up pre-commit.

I guessing you were hoping it would fix another issue. Please be clear about that issue. What are you hoping for?

This seems to already be supported with cspell-cli, but it appears that won't use the vscode workspace dictionary and configuration: https://github.com/streetsidesoftware/cspell-cli#setup-pre-commit-hook

Some more details are required. What do you want it to do that it is not doing?