✅ ShellCheck Pre-Commit Hook

This is the unofficial pre-commit hook for ShellCheck, the static analysis tool for shell scripts.

NOTE: Here's the official pre-commit hook for ShellCheck in case you prefer using that.

📜 Usage Guide

Like any other pre-commit hooks adding this specific hook is as easy as configuring your project's .pre-commit-config.yaml file. Simply add the following content to it & you're good to go!

repos:
  - repo: https://github.com/Jarmos-san/shellcheck-precommit
    rev: v0.1.0
    hooks:
      - id: shellcheck-system
      # args: [-S SEVERITY]

      # use either shfmt or shellcheck to avoid clashing styling guides
      # id: shfmt-system

🗂️ Difference Between the Official Hook

The official hook provided by the author of ShellCheck uses Docker to build the tool. At the time of creating this hook, I don't have Docker for certain unforeseen reasons. Hence, it's necessary for me to use the tool when installed through a system package manager.

That said, this hook will have Docker support as well in the future but not any time soon.

TLDR: Use the official hook if you need explicit Docker support

🎆 Features To-Be-Added Later

This hook isn't complete yet & I would prefer it to be a one-stop solution for all "shellcheck" requirements. As such following features will be added at some point in time considering I continue to have the interest & availability of time.

• Support both ShellCheck & shfmt for the user to choose either one.
• Allow Docker support for both the tools of choice!
• Enable an option to build shfmt if the user wants to.

👋 Supporting the Project

The project however small it maybe tries to adhere to the community's needs. Hence, it wouldn't be in the position it is today, so feel free to support the project.

That said, following are some ways you can support the project:

1. I don't always have to time iron out all irregularities of the project, so if you stumble across a bug or two, please feel free to either report or send a bug fix PR.
2. If the project helped you in any way or if you're using it to build a commercial project, consider sending a token appreciation (like a book or something).
3. Feel free to the star the project and/or share it with people you know will find it helpful. Spreading word about the project around the community is equally as helpful as the other tasks mentioned above.

📄 Licensing Terms & Conditions

This project is licensed under the terms & conditions (T&Cs) of the MIT License. But for more details on the same, refer to the LICENSE document.

Additionally, the following tools used with this project has their own T&Cs and respective license. So, please refer to those in the URLs shared below:

• pre-commit
• shellcheck

...more such tools will be added as & when they're provided.