Tool for checking entry points in the pre-commit config with ShellCheck.
Project description
pre-commit-config-shellcheck is a tool for checking entry points in the pre-commit config with ShellCheck.
Installation
In order to use the tool you should first clone it from the source:
$ git clone https://github.com/Anadea/pre-commit-config-shellcheck.git
Then you should install project dependencies with
$ python ./setup.py install
or
$ pip install pre-commit-config-shellcheck
The installation is done and as simple as that.
Usage
To run the program you should start it from the terminal and provide a config file to check:
$ pre_commit_config_shellcheck.py .pre-commit-config.yaml
You could change a default ShellCheck call with directory access with the -s or --shellcheck argument:
$ pre_commit_config_shellcheck.py .pre-commit-config.yaml -s /bin/shellcheck
The output from tool usage is sent to the stdout or stderr depending on the operation result.
Usage as a pre-commit hook
Also, it can be used as a pre-commit hook out of the box. Just add it to yours .pre-commit-config.yaml:
- repo: "https://github.com/Anadea/pre-commit-config-shellcheck"
rev: "0.3.4"
hooks:
- id: "pre-commit-config-shellcheck"
Usage as GitHub action
Also, it can be used as a GitHub action out of the box. Just add it to yours workflow:
- name: "pre-commit-config-shellcheck"
uses: "actions/pre-commit-config-shellcheck@0.3.4"
id: "pre-commit-config-shellcheck"
with:
config: ".pre-commit-config.yaml"
Contributing
Install GNU Make
Install and configure pyenv and pyenv-virtualenv plugin
Install and configure direnv
Create environment config from the example
cp .env.example .env
Install development dependencies:
make install
Create your fix/feature branch:
git checkout -b my-new-fix-or-feature
Check code style and moreover:
make check
Run tests:
make test
Push to the branch:
git push origin my-new-fix-or-feature
Licensing
pre-commit-config-shellcheck uses the MIT license. Please check the MIT-LICENSE file for more details.
Contacts
Project Website: https://github.com/Anadea/pre-commit-config-shellcheck/
Author: Anadea
For contributors list see CONTRIBUTORS file.
Project details
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
Hashes for pre-commit-config-shellcheck-0.3.4.zip
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8103d9ab2b8553f91883ccb883535e92dd5ec2500cca8c97ba8f7d829aa83725 |
|
MD5 | 6ba246b543ef140637c23d22d2bdfbc1 |
|
BLAKE2b-256 | 3b09214fd44f7e7c8e95886484f3251b167fc23745ff7c4525184ad16c7a30e1 |
Hashes for pre_commit_config_shellcheck-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12c114e2ac3ca6378d2cb2a90f7a573480a99e100ef689eaa9a15c9edc82df63 |
|
MD5 | 7bf86d664a308b0344f713a76dcf4139 |
|
BLAKE2b-256 | 1d525de2d6e555f7b7f520fc5c13f723fde7824ab708effbc959edc2c6a8e4a9 |