labcodes / labcodes/django-react-boilerplate
Migrate from `husky` to `pre-commit`
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 45
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
pre-commit is a framework for managing and maintaining multi-language pre-commit (and others) git hooks
pre-commit supports run javascript code via https://pre-commit.com/#node
pre-commit supports create hooks for the git pre-commit, pre-merge-commit, pre-push, prepare-commit-msg, commit-msg, post-checkout, post-commit, post-merge:
https://pre-commit.com/#pre-commit-install
https://pre-commit.com/#confining-hooks-to-run-at-certain-stages
- Create
.pre-commit-config.yamlon repository root.
The.pre-commit-config.yamlfile should contain:
repos:
- Append the pre-commit
eslinthook config to.pre-commit-config.yam. https://github.com/pre-commit/mirrors-eslint - Append the pre-commit
blackhook config to.pre-commit-config.yam.. https://github.com/psf/black#version-control-integration - Append the pre-commit
flake8hook config to.pre-commit-config.yam.. https://flake8.pycqa.org/en/latest/user/using-hooks.html#usage-with-the-pre-commit-git-hooks-framework - Add how to setup on README
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the repository's existing husky setup and README. Create the root .pre-commit-config.yaml, then use the linked eslint, black, and flake8 hook documentation to configure the listed hooks. Update the README with setup instructions and verify the configured hooks run as expected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, javascript, python
- Domain
- developer-experience, documentation, tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100