GitHub - detailyang/pre-commit-shell: :beers: pre commit wrapper shellcheck

pre-commit-shell

pre-commit-shell is a pre-commit component, which wrapper shellcheck to check shell scripts:)

Table of Contents

• Requirements
• Install
• Contributing
• License
• Author

Requirements

pre-commit-shell requires the following to run:

• pre-commit
• shellcheck

Install

1. create .pre-commit-config.yaml in you git project
2. pre-commit install
3. enjoy it

example .pre-commit-config.yaml as following:

-   repo: git://github.com/detailyang/pre-commit-shell
    rev: v1.0.6
    hooks:
    - id: shell-lint
      args: [--format=json]

Contributing

To contribute to pre-commit-shell, clone this repo locally and commit your code on a separate branch.

Author

GitHub @detailyang

License

pre-commit-shell is licensed under the MIT license.