List of pre-commit hooks meant to format your source code.
Project description
Language Formatters Pre Commit Hooks
About
This package provides utilities for ensuring that your code is nicely formatted by using pre-commit hooks
List of pretty-format hooks
pretty-format-golangpretty-format-inipretty-format-javapretty-format-kotlinpretty-format-rustpretty-format-tomlpretty-format-yaml
⚠: the list above could be out-of-sync respect the exposed pre-commit hooks.
Please refer to .pre-commit-hooks.yaml for a more updated list.
Example Usage
Add a similar snippet into your .pre-commit-config.yaml file
- repo: git@github.com:macisamuele/language-formatters-pre-commit-hooks
rev: ${LATEST_SHA_OR_VERSION}
hooks:
- id: pretty-format-java
args: [--autofix]
- id: pretty-format-kotlin
args: [--autofix]
- id: pretty-format-yaml
args: [--autofix, --indent, '2']
Development
This tool uses tox as main tool to build virtual environments.
To get started will be enough to run make development.
If you have aactivator installed this step will happen automatically.
Contributing
Contributions are always welcome.
- Fork the project ( http://github.com/macisamuele/language-formatters-pre-commit-hooks/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Add your modifications
- Push to the branch (
git push origin my-new-feature) - Create new Pull Request
License
language-formatters-pre-commit-hooks is licensed with Apache License version 2.0.
Changelog
1.4.0 (2020-05-20)
- Improve handling of multi-document YAML files. PR #3 - @dan-cohn thanks for your contribution
pretty-format-javadoes default to Google style. Add--aospargument for Android Open Source Project style. PR #8 - @ChenAndrew thanks for your contribution.- Update GoogleJavaFormatter to 1.8
1.3.2 (2020-01-25)
- Definitive packaging fix
1.3.1 (2020-01-24)
- Update Packaging informations
:warning: This version broke module retrieval (:disappointed:) while improving quality of PyPi uploaded information. You're recommended to use a more recent version of the library.
1.3.0 (2020-01-24)
- Update KTLint to 0.36.0
- Enhange
pretty-format-yamlto deal with YAML files containing primitive types only - PR #1 - @dan-cohn thanks for your contribution
1.2.5 (2019-11-22)
- Update KTLint to 0.35.0
1.2.4 (2019-07-19)
- Update KTLint to 0.34.0 and fix KTLint GitHub link
1.2.3 (2019-02-14)
- Update Google Java Formatter to 1.7 and KTlint to 0.30.0
1.2.2 (2018-11-20)
- pretty-format-rust fails if
cargo fmtfails
1.2.1 (2018-11-20)
- no-diff release
1.2.0 (2018-11-20)
- Bump KTlint to 0.29.0
- Remove duplicated filenames from command execution
1.1.3 (2018-09-02)
- Last fix to cargo invocations to use the environmentally defined toolchain
1.1.2 (2018-09-02)
- Bump KTlint to 0.27.0
1.1.1 (2018-09-02)
- Ensure that generated files end with a new line
- Allow rust toolchain customization via
RUST_TOOLCHAINenvironment variable
1.1.0 (2018-07-29)
- Add pretty formatters for INI, Rust and TOML files
1.0.1 (2018-07-20)
- Improve detection of modified files from kotlin formatter
1.0.0 (2018-07-20)
- Initial release: added pretty formatters for Golang, Java, Kotlin and YAML
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file language_formatters_pre_commit_hooks-1.4.0.tar.gz.
File metadata
- Download URL: language_formatters_pre_commit_hooks-1.4.0.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2760d0769c96f6a41c77182f501674d3d17cfeff826882f8d74055db27c982c3 |
|
| MD5 | 0e86b8bd46df4c782269f0b6c3b8b53d |
|
| BLAKE2b-256 | b7f0dabe01dc535c1d06d324fa341db974265cf213546671c61a227b8dfc3dc9 |
File details
Details for the file language_formatters_pre_commit_hooks-1.4.0-py2.py3-none-any.whl.
File metadata
- Download URL: language_formatters_pre_commit_hooks-1.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 17.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 61adabef7d03692a68643544d255974b389cc9b2f146157e20e09112472918ff |
|
| MD5 | 0a6c300a9dbd2cdaa56d41207df1b1cb |
|
| BLAKE2b-256 | 33785c55b8a16d37a6fa9364a37c8929b9aef217e2465816389f7a950fc44520 |
