https://github.com/boozt-platform/lefthook
A collection of lefthook linting scripts for various development tools.
https://github.com/boozt-platform/lefthook
boozt-platform git hooks lefthook pre-commit
Last synced: 3 months ago
JSON representation
A collection of lefthook linting scripts for various development tools.
- Host: GitHub
- URL: https://github.com/boozt-platform/lefthook
- Owner: boozt-platform
- License: mit
- Created: 2024-02-26T11:29:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T10:28:02.000Z (over 1 year ago)
- Last Synced: 2026-04-04T10:54:14.102Z (3 months ago)
- Topics: boozt-platform, git, hooks, lefthook, pre-commit
- Language: Shell
- Homepage: https://github.com/orgs/boozt-platform
- Size: 86.9 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: docs/CODEOWNERS
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
[
][homepage]
[][releases]
[][license]
# lefthook
Various organizational hooks based on the [lefthook](https://github.com/evilmartians/lefthook)
for development and continuous integration. Hooks enforce consistent practices
across all commits and deployments.
## Table of Contents
- [How to Use It](#how-to-use-it)
- [Available Hooks](#available-hooks)
- [About Boozt](#about-boozt)
- [Reporting Issues](#reporting-issues)
- [Contributing](#contributing)
- [License](#license)
## How to Use It
Create a new file `.lefthook.yaml` in your project's root folder and use the
example content below:
```yaml
# .lefthook.yaml
---
remotes:
- git_url: https://github.com/boozt-platform/lefthook.git
ref: v1.3.0
configs:
# lint commit messages based by the conventional commits
- hooks/commitlint/.lefthook.yaml
# lint Dockerfiles
- hooks/hadolint/.lefthook.yaml
# lint shell scripts
- hooks/shellcheck/.lefthook.yaml
# check if the license headers are present in the files
- hooks/license-checker/.lefthook.yaml
# lint the markdown (.md) files
- hooks/markdown-lint/.lefthook.yaml
# A linter for YAML files.
- hooks/yamllint/.lefthook.yaml
# validate the JSON files
- hooks/jsonlint/.lefthook.yaml
# terraform validation, fmt and tests
- hooks/terraform/.lefthook.yaml
```
Run `lefthook install` (follow the [installation guide](https://github.com/evilmartians/lefthook/blob/master/docs/install.md)
if the lefthook command is not present on the system).
## Available Hooks
- [commitlint](./hooks/commitlint/) (**commit-msg**) - Lint commit messages
based by the conventional commits
- [hadolint](./hooks/hadolint/) (**pre-commit**) - A smarter Dockerfile linter
- [shellcheck](./hooks/shellcheck/) (**pre-commit**) - a static analysis tool
for shell scripts
- [license-checker](./hooks/license-checker/) (**pre-commit**) - Checks if the
license headers are present in the Git staged files with possibility to exclude
certain files or file extensions using Regular Expression pattern.
- [jsonlint](./hooks/jsonlint/) (**pre-commit**) - Validation tool for JSON files.
- [yamllint](./hooks/yamllint/) (**pre-commit**) - A linter for YAML files.
- [markdown-lint](./hooks/markdown-lint/) (**pre-commit**) - is a static
analysis tool for *.md files.
- [terraform](./hooks/terraform/)
- **pre-commit**: Formats and validates Terraform configuration files.
Generates documentation.
- **pre-push**: Runs tests to ensure Terraform configurations are correct.
## About Boozt
Boozt is a leading and fast-growing Nordic technology company selling fashion
and lifestyle online mainly through its multi-brand webstore [Boozt.com][boozt]
and [Booztlet.com][booztlet].
The company is focused on using cutting-edge, in-house developed technology to
curate the best possible customer experience.
With offices in Sweden, Denmark, Lithuania and Poland, we pride ourselves in
having a diverse team, consisting of 1100+ employees and 38 nationalities.
See our [Medium][blog] blog page for technology-focused articles. Would you
like to make your mark by working with us at Boozt? Take a look at our
[latest hiring opportunities][careers].
## Reporting Issues
Please provide a clear and concise description of the problem or the feature
you're missing along with any relevant context or screenshots.
Check existing issues before reporting to avoid duplicates.
Please follow the [Issue Reporting Guidelines][issues] before opening a new issue.
## Contributing
Contributions are highly valued and very welcome! For the process of reviewing
changes, we use [Pull Requests][pull-request]. For a detailed information
please follow the [Contribution Guidelines][contributing]
## License
[][license]
This project is licensed under the MIT. Please see [LICENSE][license] for
full details.
[homepage]: https://github.com/boozt-platform/lefthook
[releases]: https://github.com/boozt-platform/lefthook/releases
[issues]: https://github.com/boozt-platform/lefthook/issues
[pull-request]: https://github.com/boozt-platform/lefthook/pulls
[contributing]: ./docs/CONTRIBUTING.md
[license]: ./LICENSE
[boozt]: https://www.boozt.com/
[booztlet]: https://www.booztlet.com/
[blog]: https://medium.com/boozt-tech
[careers]: https://careers.booztgroup.com/