It’s not clear which languages can’t be used for local hooks

Open
#797 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python, ruby
Domain
documentation

Research direction

Start with the repository local hooks section and the linked language descriptions for python, ruby, and dotnet. Compare how support for additional_dependencies is documented, then clarify which languages can be used for local hooks and make the result unambiguous for dotnet and other languages.

Written by the indexing model from the issue text.

Description

According the repository local hooks section,

local hooks can use any language which supports additional_dependencies or docker_image / fail / pygrep / script / system.

It’s not clear to me which languages can’t be used. For example, the descriptions for both python and ruby don’t explicitly mention that those languages support additional_dependencies, but they do indeed support additional_dependencies. This makes me question whether or not you can create (for example) a local dotnet hook. The description for dotnet doesn’t explicitly say that additional_dependencies is supported, but it also doesn’t say that additional_dependencies isn’t supported.

Dominant language
Python
Stars
208
Forks
307
Avg merge
20h 3m
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pre-commit/pre-commit.com

All issues in pre-commit/pre-commit.com

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.