cube-js / cube-js/cube

Add precommit hooks

Open
#324 3 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
Rust
Stars
20.8k
Forks
2.1k
Avg merge
1d 2h
Merged PRs (30d)
181

Description

**Is your feature request related to a problem? Please describe.**
It would be a better developer experience if lint checks were run as a Git precommit hook, as opposed to the somewhat longer feedback loop of a CI failure.

**Describe the solution you'd like**
Many such tools/toolchains exist on NPM, `lint-staged` and `husky` being the most popular.

`lint-staged` allows for linting only staged files, and `husky` sets up Git precommit hooks in your project.

Additionally, tools such as `commitlint` can be used to enforce Git commit message styles (in this case, conventional commits) while `commitizen` can be used to provide a CLI wizard for commit messages.

**Additional context**
`lint-staged`: https://github.com/okonet/lint-staged
`husky`: https://github.com/typicode/husky
`commitlint`: https://github.com/conventional-changelog/commitlint
`commitizen`: https://github.com/commitizen/cz-cli

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.