{"id":21957071,"url":"https://github.com/trussworks/pre-commit-hooks","last_synced_at":"2025-04-23T15:50:03.277Z","repository":{"id":40495248,"uuid":"220111830","full_name":"trussworks/pre-commit-hooks","owner":"trussworks","description":"Common pre-commit hooks","archived":false,"fork":false,"pushed_at":"2024-10-14T10:59:23.000Z","size":30,"stargazers_count":6,"open_issues_count":5,"forks_count":2,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-10-31T13:23:50.582Z","etag":null,"topics":["adr-log","circleci","goreleaser","markdown-toc","mdspell","pre-commit"],"latest_commit_sha":null,"homepage":"https://github.com/trussworks/pre-commit-hooks","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trussworks.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}},"created_at":"2019-11-06T23:45:52.000Z","updated_at":"2022-03-08T16:27:07.000Z","dependencies_parsed_at":"2022-08-09T22:12:31.256Z","dependency_job_id":null,"html_url":"https://github.com/trussworks/pre-commit-hooks","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trussworks%2Fpre-commit-hooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trussworks%2Fpre-commit-hooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trussworks%2Fpre-commit-hooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trussworks%2Fpre-commit-hooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trussworks","download_url":"https://codeload.github.com/trussworks/pre-commit-hooks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227084491,"owners_count":17728711,"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":["adr-log","circleci","goreleaser","markdown-toc","mdspell","pre-commit"],"created_at":"2024-11-29T08:49:28.138Z","updated_at":"2024-11-29T08:49:28.920Z","avatar_url":"https://github.com/trussworks.png","language":"Shell","readme":"# Truss pre-commit hooks\n\n\u003c!-- mdformat-toc start --slug=github --no-anchors --maxlevel=3 --minlevel=1 --\u003e\n\n- [Truss pre-commit hooks](#truss-pre-commit-hooks)\n  - [circleci-validate](#circleci-validate)\n  - [gen-docs](#gen-docs)\n  - [goreleaser-check](#goreleaser-check)\n  - [markdown-toc](#markdown-toc)\n  - [mdspell](#mdspell)\n  - [spelling-sort](#spelling-sort)\n  - [hadolint](#hadolint)\n\n\u003c!-- mdformat-toc end --\u003e\n\n## circleci-validate\n\nValidate CircleCI config yaml located in `.circleci/config.yml`. In order for this to run you will need to install\nthe `circleci` CLI tool locally with:\n\n```sh\nbrew install circleci\n```\n\nThe script will not run the validation if the environment variable `CI` is set, which means you can safely run this\non CircleCI and it will be a no-op.\n\n## gen-docs\n\nGenerate a Docs Index using [adr-log](https://www.npmjs.com/package/adr-log). It will modify files with comments in it\nper the docs on that module.\n\nBy default it will only look in the `docs/` directory of your repo. You can pass in different directories by using\nthe `args` parameter like this: `args: [\"docs/adr\", \"docs/rfc\"]`\n\n## goreleaser-check\n\nValidate goreleaser config yaml located at `.goreleaser.yml`. In order for this to run you will need to install\nthe `goreleaser` CLI tool locally with:\n\n```sh\nbrew install goreleaser\n```\n\n## markdown-toc\n\nGenerate a Table of Contents using [markdown-toc](https://www.npmjs.com/package/markdown-toc). It will modify files\nwith comments in it per the docs on that module.\n\n## mdspell\n\nRun spellcheck on markdown files using [markdown-spellcheck](https://www.npmjs.com/package/markdown-spellcheck). It\nwill ignore words listed in a `.spelling` file in your repo.\n\n## spelling-sort\n\nRun `sort` on the `.spelling` file used by the `markdown-spellcheck` tool. This keeps the file tidy as it is used.\n\n## hadolint\n\nRun the [hadolint](https://github.com/hadolint/hadolint) Dockerfile linter\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrussworks%2Fpre-commit-hooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrussworks%2Fpre-commit-hooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrussworks%2Fpre-commit-hooks/lists"}