chore: Use pre-commit framework (#604)

* Add pre-commit, prettier configs and editorconfig

* Remove `check-toml` hook

* Add isort config

* Add codespell config

* Update hooks

* Remove prettierignore

* Add shellcheck config

* Add lint workflow

* Add pre-commit autoupdate workflow

* Remove path constraints from lint workflow

* Fix CI

* Add guide to CONTRIBUTING.md

* Fix (probably) shfmt

* Fix (probably) shfmt

* Fix (probably) shfmt
This commit is contained in:
Lev
2021-12-10 11:48:00 +03:00
committed by GitHub
parent 65f6228be8
commit 2ac2b7ce43
5 changed files with 151 additions and 8 deletions

View File

@@ -10,12 +10,35 @@ On each PR that contains changes relevant to Docker builds, images are being bui
> :evergreen_tree: Please be considerate when pushing commits and opening PR for multiple branches, as the process of building images uses energy and contributes to global warming.
>
## Lint
We use `pre-commit` framework to lint the codebase before committing.
First, you need to install pre-commit with pip:
```shell
shellcheck example.sh
pip install pre-commit
```
Also you can use brew if you're on Mac:
```shell
brew install pre-commit
```
To setup _pre-commit_ hook, run:
```shell
pre-commit install
```
To run all the files in repository, run:
```shell
pre-commit run --all-files
```
## Build
```shell