{"id":24484537,"url":"https://github.com/jarmos-san/shellcheck-precommit","last_synced_at":"2025-07-20T06:06:20.661Z","repository":{"id":115623505,"uuid":"473519120","full_name":"Jarmos-san/shellcheck-precommit","owner":"Jarmos-san","description":"✅ A better Pre-Commit hook to check your Shell scripts","archived":false,"fork":false,"pushed_at":"2023-09-05T01:26:05.000Z","size":41,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-08T23:35:04.615Z","etag":null,"topics":["pre-commit","pre-commit-hook","shell-script","shellcheck"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jarmos-san.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Jarmos-san"}},"created_at":"2022-03-24T08:32:59.000Z","updated_at":"2024-04-03T10:11:43.000Z","dependencies_parsed_at":"2025-01-21T13:38:34.633Z","dependency_job_id":"a08f32e9-c3eb-4a9d-b0f6-4cdaa3476868","html_url":"https://github.com/Jarmos-san/shellcheck-precommit","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Jarmos-san/shellcheck-precommit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jarmos-san%2Fshellcheck-precommit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jarmos-san%2Fshellcheck-precommit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jarmos-san%2Fshellcheck-precommit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jarmos-san%2Fshellcheck-precommit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jarmos-san","download_url":"https://codeload.github.com/Jarmos-san/shellcheck-precommit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jarmos-san%2Fshellcheck-precommit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266076095,"owners_count":23872730,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pre-commit","pre-commit-hook","shell-script","shellcheck"],"created_at":"2025-01-21T13:34:42.904Z","updated_at":"2025-07-20T06:06:20.635Z","avatar_url":"https://github.com/Jarmos-san.png","language":null,"funding_links":["https://github.com/sponsors/Jarmos-san","https://ko-fi.com/H2H567ZQH"],"categories":[],"sub_categories":[],"readme":"# ✅ ShellCheck Pre-Commit Hook\n\n[![Code Quality Checks](https://github.com/Jarmos-san/shellcheck-precommit/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/Jarmos-san/shellcheck-precommit/actions/workflows/main.yml)\n![GitHub repo size](https://img.shields.io/github/repo-size/Jarmos-san/shellcheck-precommit?label=Repo%20Size\u0026logo=github\u0026style=flat-square)\n![GitHub](https://img.shields.io/github/license/Jarmos-san/shellcheck-precommit?color=github\u0026label=License\u0026logo=github\u0026style=flat-square)\n![Twitter Follow](https://img.shields.io/twitter/follow/Jarmosan?style=social)\n\nThis is the **unofficial**\n[pre-commit hook](https://pre-commit.com/#adding-pre-commit-plugins-to-your-project)\nfor [ShellCheck](https://www.shellcheck.net/), the static analysis tool for\nshell scripts.\n\n**NOTE**: Here's the\n[official](https://github.com/koalaman/shellcheck-precommit) pre-commit hook for\nShellCheck in case you prefer using that.\n\n## 📜 Usage Guide\n\nLike any other [pre-commit](https://pre-commit.com) hooks adding this specific\nhook is as easy as configuring your project's `.pre-commit-config.yaml` file.\nSimply add the following content to it \u0026 you're good to go!\n\n```yaml\nrepos:\n  - repo: https://github.com/Jarmos-san/shellcheck-precommit\n    rev: v0.1.0\n    hooks:\n      - id: shellcheck-system\n      # args: [-S SEVERITY]\n\n      # use either shfmt or shellcheck to avoid clashing styling guides\n      # id: shfmt-system\n```\n\n## 🗂️ Difference Between the Official Hook\n\nThe official hook provided by the author of ShellCheck uses\n[Docker](https://www.docker.com/) to build the tool. At the time of creating\nthis hook, I don't have Docker for certain unforeseen reasons. Hence, it's\nnecessary for me to use the tool when installed through a system package\nmanager.\n\nThat said, this hook will have Docker support as well in the future but not any\ntime soon.\n\nTLDR: Use the official hook if you need explicit Docker support\n\n## 🎆 Features To-Be-Added Later\n\nThis hook isn't complete yet \u0026 I would prefer it to be a one-stop solution for\nall \"_shellcheck_\" requirements. As such following features will be added at\nsome point in time considering I continue to have the interest \u0026 availability of\ntime.\n\n- Support both [ShellCheck](https://www.shellcheck.net) \u0026\n  [`shfmt`](https://github.com/mvdan/sh#shfmt) for the user to choose either\n  one.\n- Allow Docker support for both the tools of choice!\n- Enable an option to build `shfmt` if the user wants to.\n\n## 👋 Supporting the Project\n\nThe project however small it maybe tries to adhere to the community's needs.\nHence, it wouldn't be in the position it is today, so feel free to support the\nproject.\n\nThat said, following are some ways you can support the project:\n\n1. I don't always have to time iron out all irregularities of the project, so if\n   you stumble across a bug or two, please feel free to either report or send a\n   bug fix PR.\n2. If the project helped you in any way or if you're using it to build a\n   commercial project, consider sending a token appreciation (like a book or\n   something).\n3. Feel free to the star the project and/or share it with people you know will\n   find it helpful. Spreading word about the project around the community is\n   equally as helpful as the other tasks mentioned above.\n\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H567ZQH)\n\n## 📄 Licensing Terms \u0026 Conditions\n\nThis project is licensed under the terms \u0026 conditions (T\u0026Cs) of the MIT License. But for more details on the same, refer to the [LICENSE](./LICENSE) document.\n\nAdditionally, the following tools used with this project has their own T\u0026Cs and respective license. So, please refer to those in the URLs shared below:\n\n- [pre-commit](https://github.com/pre-commit/pre-commit)\n- [shellcheck](https://github.com/koalaman/shellcheck)\n\n_...more such tools will be added as \u0026 when they're provided._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjarmos-san%2Fshellcheck-precommit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjarmos-san%2Fshellcheck-precommit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjarmos-san%2Fshellcheck-precommit/lists"}