"https://cdn.gruntwork.io/gruntwork-website/"

{"index":{"js":"https://cdn.gruntwork.io/gruntwork-website/index.bundle.c7884255553b53fbca3a.js","map":"https://cdn.gruntwork.io/gruntwork-website/index.bundle.1b14c1b7d19f1f5eb35d6e118e838255.map"},"styles":{"css":"https://cdn.gruntwork.io/gruntwork-website/styles.bundle.f22938926651ddec7c49.css","js":"https://cdn.gruntwork.io/gruntwork-website/styles.bundle.e782420e74a20dcb8691.js","map":"https://cdn.gruntwork.io/gruntwork-website/styles.bundle.d5e2af49807c6ca33f8367d621ece507.map"},"vendors":{"css":"https://cdn.gruntwork.io/gruntwork-website/vendors.bundle.29f7d0366a0978763f96.css","js":"https://cdn.gruntwork.io/gruntwork-website/vendors.bundle.fa8174a130797d75d12c.js","map":"https://cdn.gruntwork.io/gruntwork-website/vendors.bundle.57243d94deeeb29d5061288a338b4eb6.map"}}

{"treedata":{"name":"root","toggled":true,"children":[{"name":".gitignore","path":".gitignore","sha":"b2bebb4fecee004fc5bd8d86af4eb8c161980050"},{"name":".pre-commit-hooks.yaml","path":".pre-commit-hooks.yaml","sha":"cbd22582314561b27000efe2a152020903f39d4b"},{"name":"CODEOWNERS","path":"CODEOWNERS","sha":"cae10a12925d47fc51cdf0ac58b9589854103b94"},{"name":"LICENSE","path":"LICENSE","sha":"7a4a3ea2424c09fbe48d455aed1eaa94d9124835"},{"name":"NOTICE","path":"NOTICE","sha":"c40e9bf1d01d32adc60f0e375bf55224002020ec"},{"name":"README.md","path":"README.md","sha":"f54ef3eb56b7080e6f870a20a57719ad9265aa14","toggled":true},{"name":"hooks","children":[{"name":"gofmt.sh","path":"hooks/gofmt.sh","sha":"b13e03ca66e47e983066e3d6ca2898cc4d42d46d"},{"name":"goimports.sh","path":"hooks/goimports.sh","sha":"1e77fb9645b7f54fe80ef500f5329ba79a267725"},{"name":"golint.sh","path":"hooks/golint.sh","sha":"e74ea4da285fee9d45b4cac6426657cfc504de6d"},{"name":"helmlint.sh","path":"hooks/helmlint.sh","sha":"98bce6e892b2e7f224bd0e50fd80695efa7eebc4"},{"name":"shellcheck.sh","path":"hooks/shellcheck.sh","sha":"027d0966dfeffe4f380f3c038d6f0b359ace8864"},{"name":"terraform-fmt.sh","path":"hooks/terraform-fmt.sh","sha":"f10ab0f48ba085f550aeb8dd04bfa4774e44fb42"},{"name":"terraform-validate.sh","path":"hooks/terraform-validate.sh","sha":"6752756eb538faa71491f93ff21493506243f2a9"},{"name":"tflint.sh","path":"hooks/tflint.sh","sha":"e9d4b497218a010cd83d41455eb4ba5cb0e45b84"},{"name":"yapf.sh","path":"hooks/yapf.sh","sha":"a7029349698bd8038a99559e0e3cb20b44030ed7"}]}]},"detailsContent":"<p><a href=\"https://gruntwork.io/?ref=repo_pre-commit\" class=\"preview__body--description--blue\" target=\"_blank\"><img src=\"https://img.shields.io/badge/maintained%20by-gruntwork.io-%235849a6.svg\" alt=\"Maintained by Gruntwork.io\" class=\"preview__body--diagram\"></a></p>\n<h1 class=\"preview__body--title\" id=\"pre-commit-hooks\">Pre-commit hooks</h1><div class=\"preview__body--border\"></div><p>This repo defines Git pre-commit hooks intended for use with <a href=\"http://pre-commit.com/\" class=\"preview__body--description--blue\" target=\"_blank\">pre-commit</a>. The currently\nsupported hooks are:</p>\n<ul>\n<li><strong>terraform-fmt</strong>: Automatically run <code>terraform fmt</code> on all Terraform code (<code>*.tf</code> files).</li>\n<li><strong>terraform-validate</strong>: Automatically run <code>terraform validate</code> on all Terraform code (<code>*.tf</code> files).</li>\n<li><strong>tflint</strong>: Automatically run <a href=\"https://github.com/terraform-linters/tflint\" class=\"preview__body--description--blue\" target=\"_blank\"><code>tflint</code></a> on all Terraform code (<code>*.tf</code> files).</li>\n<li><strong>shellcheck</strong>: Run <a href=\"https://www.shellcheck.net/\" class=\"preview__body--description--blue\" target=\"_blank\"><code>shellcheck</code></a> to lint files that contain a bash <a href=\"https://en.wikipedia.org/wiki/Shebang_(Unix)\" class=\"preview__body--description--blue\" target=\"_blank\">shebang</a></li>\n<li><strong>gofmt</strong>: Automatically run <code>gofmt</code> on all Golang code (<code>*.go</code> files).</li>\n<li><strong>golint</strong>: Automatically run <code>golint</code> on all Golang code (<code>*.go</code> files)</li>\n<li><strong>yapf</strong>: Automatically run <a href=\"https://github.com/google/yapf\" class=\"preview__body--description--blue\" target=\"_blank\"><code>yapf</code></a> on all python code (<code>*.py</code> files).</li>\n<li><strong>helmlint</strong> Automatically run <a href=\"https://github.com/helm/helm/blob/master/docs/helm/helm_lint.md\" class=\"preview__body--description--blue\" target=\"_blank\"><code>helm lint</code></a> on your\nhelm charts.</li>\n</ul>\n<h2 class=\"preview__body--subtitle\" id=\"general-usage\">General Usage</h2>\n<p>In each of your repos, add a file called <code>.pre-commit-config.yaml</code> with the following contents:</p>\n<pre>repos:\n - repo: https://github.com/gruntwork-io/pre-commit\n rev: &lt;VERSION&gt; <span class=\"hljs-comment\"># Get the latest from: https://github.com/gruntwork-io/pre-commit/releases</span>\n hooks:\n - id: <span class=\"hljs-keyword\">terraform</span>-fmt\n - id: <span class=\"hljs-keyword\">terraform</span>-validate\n - id: tflint\n - id: shellcheck\n - id: gofmt\n - id: golint\n</pre>\n<p>Next, have every developer:</p>\n<ol>\n<li>Install <a href=\"http://pre-commit.com/\" class=\"preview__body--description--blue\" target=\"_blank\">pre-commit</a>. E.g. <code>brew install pre-commit</code>.</li>\n<li>Run <code>pre-commit install</code> in the repo.</li>\n</ol>\n<p>That’s it! Now every time you commit a code change (<code>.tf</code> file), the hooks in the <code>hooks:</code> config will execute.</p>\n<h2 class=\"preview__body--subtitle\" id=\"running-against-all-files-at-once\">Running Against All Files At Once</h2>\n<h3 class=\"preview__body--subtitle\" id=\"example-formatting-all-files\">Example: Formatting all files</h3>\n<p>If you'd like to format all of your code at once (rather than one file at a time), you can run:</p>\n<pre>pre-commit run <span class=\"hljs-keyword\">terraform</span>-fmt --all-files\n</pre>\n<h3 class=\"preview__body--subtitle\" id=\"example-enforcing-in-ci\">Example: Enforcing in CI</h3>\n<p>If you'd like to enforce all your hooks, you can configure your CI build to fail if the code doesn't pass checks by\nadding the following to your build scripts:</p>\n<pre>pip <span class=\"hljs-keyword\">install</span> pre-<span class=\"hljs-keyword\">commit</span>\npre-<span class=\"hljs-keyword\">commit</span> <span class=\"hljs-keyword\">install</span>\npre-<span class=\"hljs-keyword\">commit</span> run <span class=\"hljs-comment\">--all-files</span>\n</pre>\n<p>If all the hooks pass, the last command will exit with an exit code of 0. If any of the hooks make changes (e.g.,\nbecause files are not formatted), the last command will exit with a code of 1, causing the build to fail.</p>\n<h2 class=\"preview__body--subtitle\" id=\"helm-lint-caveats\">Helm Lint Caveats</h2>\n<h3 class=\"preview__body--subtitle\" id=\"detecting-charts\">Detecting charts</h3>\n<p>The <code>helmlint</code> pre-commit hook runs <code>helm lint</code> on the charts that have been changed by the commit. It will run once per\nchanged chart that it detects.</p>\n<p>Note that charts are detected by walking up the directory tree of the changed file and looking for a <code>Chart.yaml</code> file\nthat exists on the path.</p>\n<h3 class=\"preview__body--subtitle\" id=\"linter-values-yaml\">linter_values.yaml</h3>\n<p><code>helm lint</code> requires input values to look for configuration errors in your helm chart. However, this means that the\nlinter needs a complete values file. Because we want to develop charts that define required values that the operator\nshould provide, we don't want to specify defaults for all the values the chart expects in the default <code>values.yaml</code>\nfile.</p>\n<p>Therefore, to support this, this pre-commit hook looks for a special <code>linter_values.yaml</code> file defined in the chart\npath. This will be combined with the <code>values.yaml</code> file before running <code>helm lint</code>. In your charts, you should define\nthe required values in <code>linter_values.yaml</code>.</p>\n<p>For example, suppose you had a helm chart that defined two input values: <code>containerImage</code> and <code>containerTag</code>. Suppose\nthat your chart required <code>containerImage</code> to be defined, but not <code>containerTag</code>. To enforce this, you created the\nfollowing <code>values.yaml</code> file for your chart:</p>\n<pre><span class=\"hljs-comment\"># values.yaml</span>\n\n<span class=\"hljs-comment\"># containerImage is required and defines which image to use</span>\n\n<span class=\"hljs-comment\"># containerTag specifies the image tag to use. Defaults to latest.</span>\ncontainerTag: latest\n</pre>\n<p>If you run <code>helm lint</code> on this chart, it will fail because somewhere in your chart you will reference\n<code>.Values.containerImage</code> which will be undefined with this <code>values.yaml</code> file. To handle this, you can define a\n<code>linter_values.yaml</code> file that defines <code>containerImage</code>:</p>\n<pre><span class=\"hljs-comment\"># linter_values.yaml</span>\ncontainerImage: nginx\n</pre>\n<p>Now when the pre-commit hook runs, it will call <code>helm lint</code> with both <code>linter_values.yaml</code> and <code>values.yaml</code>:</p>\n<pre><span class=\"hljs-selector-tag\">helm</span> <span class=\"hljs-selector-tag\">lint</span> <span class=\"hljs-selector-tag\">-f</span> <span class=\"hljs-selector-tag\">values</span><span class=\"hljs-selector-class\">.yaml</span> <span class=\"hljs-selector-tag\">-f</span> <span class=\"hljs-selector-tag\">linter_values</span><span class=\"hljs-selector-class\">.yaml</span> .\n</pre>\n<h2 class=\"preview__body--subtitle\" id=\"license\">License</h2>\n<p>This code is released under the Apache 2.0 License. Please see <a href=\"/repos/v0.1.1/pre-commit/LICENSE\" class=\"preview__body--description--blue\">LICENSE</a> and <a href=\"/repos/v0.1.1/pre-commit/NOTICE\" class=\"preview__body--description--blue\">NOTICE</a> for more details.</p>\n<p>Copyright © 2019 Gruntwork, Inc.</p>\n","repoName":"pre-commit","repoRef":"v0.1.1","serviceDescriptor":{"serviceName":"Pre-commit hooks","serviceRepoName":"pre-commit","serviceRepoOrg":"gruntwork-io","cloudProviders":["aws","gcp"],"description":"A collection of pre-commit hooks for Terraform, bash, Go, and more.","imageUrl":"grunt.png","licenseType":"subscriber","technologies":["Bash"],"compliance":[],"tags":[""]},"serviceCategoryName":"CI / CD","fileName":"README.md","filePath":"","title":"Repo Browser: Pre-commit hooks","description":"Browse the repos in the Gruntwork Infrastructure as Code Library."}