HeadspaceMeditation
diff --git a/‎.dockerignore
Lines changed: 3 additions & 0 deletions b/‎.dockerignore
Lines changed: 3 additions & 0 deletions
diff --git a/‎.editorconfig
Lines changed: 14 additions & 0 deletions b/‎.editorconfig
Lines changed: 14 additions & 0 deletions
diff --git a/‎.github/CODEOWNERS
Lines changed: 1 addition & 0 deletions b/‎.github/CODEOWNERS
Lines changed: 1 addition & 0 deletions
diff --git a/‎.github/CONTRIBUTING.md
Lines changed: 142 additions & 0 deletions b/‎.github/CONTRIBUTING.md
Lines changed: 142 additions & 0 deletions
diff --git a/‎.github/FUNDING.yml
Lines changed: 2 additions & 0 deletions b/‎.github/FUNDING.yml
Lines changed: 2 additions & 0 deletions
diff --git a/‎.github/ISSUE_TEMPLATE/bug_report_docker.md
Lines changed: 81 additions & 0 deletions b/‎.github/ISSUE_TEMPLATE/bug_report_docker.md
Lines changed: 81 additions & 0 deletions
diff --git a/‎.github/ISSUE_TEMPLATE/bug_report_local_install.md
Lines changed: 106 additions & 0 deletions b/‎.github/ISSUE_TEMPLATE/bug_report_local_install.md
Lines changed: 106 additions & 0 deletions
diff --git a/‎.github/ISSUE_TEMPLATE/feature_request.md
Lines changed: 29 additions & 0 deletions b/‎.github/ISSUE_TEMPLATE/feature_request.md
Lines changed: 29 additions & 0 deletions
@@ -0,0 +1,3 @@
+*
+!.dockerignore
+!Dockerfile
@@ -0,0 +1,14 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.{py,md},Dockerfile}]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
@@ -0,0 +1 @@
+* @maxymvlasov @yermulnik
@@ -0,0 +1,142 @@
+# Notes for contributors
+
+1. Python hooks are supported now too. All you have to do is:
+    1. add a line to the `console_scripts` array in `entry_points` in `setup.py`
+    2. Put your python script in the `pre_commit_hooks` folder
+
+Enjoy the clean, valid, and documented code!
+
+* [Run and debug hooks locally](#run-and-debug-hooks-locally)
+* [Run hook performance test](#run-hook-performance-test)
+  * [Run via BASH](#run-via-bash)
+  * [Run via Docker](#run-via-docker)
+  * [Check results](#check-results)
+  * [Cleanup](#cleanup)
+* [Add new hook](#add-new-hook)
+  * [Before write code](#before-write-code)
+  * [Prepare basic documentation](#prepare-basic-documentation)
+  * [Add code](#add-code)
+  * [Finish with the documentation](#finish-with-the-documentation)
+
+## Run and debug hooks locally
+
+```bash
+pre-commit try-repo {-a} /path/to/local/pre-commit-terraform/repo {hook_name}
+```
+
+I.e.
+
+```bash
+pre-commit try-repo /mnt/c/Users/tf/pre-commit-terraform terraform_fmt # Run only `terraform_fmt` check
+pre-commit try-repo -a ~/pre-commit-terraform # run all existing checks from repo
+```
+
+Running `pre-commit` with `try-repo` ignores all arguments specified in `.pre-commit-config.yaml`.
+
+If you need to test hook with arguments, follow [pre-commit doc](https://pre-commit.com/#arguments-pattern-in-hooks) to test hooks.
+
+For example, to test that the [`terraform_fmt`](../README.md#terraform_fmt) hook works fine with arguments:
+
+```bash
+/tmp/pre-commit-terraform/terraform_fmt.sh --args=-diff --args=-write=false test-dir/main.tf test-dir/vars.tf
+```
+
+## Run hook performance test
+
+To check is your improvement not violate performance, we have dummy execution time tests.
+
+Script accept next options:
+<!-- markdownlint-disable no-inline-html -->
+| #   | Name                               | Example value                                                            | Description                                          |
+| --- | ---------------------------------- | ------------------------------------------------------------------------ | ---------------------------------------------------- |
+| 1   | `TEST_NUM`                         | `200`                                                                   | How many times need repeat test                      |
+| 2   | `TEST_COMMAND`                     | `'pre-commit try-repo -a /tmp/159/pre-commit-terraform terraform_tfsec'` | Valid pre-commit command                             |
+| 3   | `TEST_DIR`                         | `'/tmp/infrastructure'`                                                  | Dir on what you run tests.                           |
+| 4   | `TEST_DESCRIPTION`                 | ```'`terraform_tfsec` PR #123:'```                                       | Text that you'd like to see in result                |
+| 5   | `RAW_TEST_`<br>`RESULTS_FILE_NAME` | `terraform_tfsec_pr123`                                                  | (Temporary) File where all test data will be stored. |
+<!-- markdownlint-enable no-inline-html -->
+
+> **Note:** To make test results repeatable and comparable, be sure that on the test machine nothing generates an unstable workload. During tests good to stop any other apps and do not interact with the test machine.
+>
+> Otherwise, for eg, when you watch Youtube videos during one test and not during other, test results can differ up to 30% for the same test.
+
+### Run via BASH
+
+```bash
+# Install deps
+sudo apt install -y datamash
+# Run tests
+./hooks_performance_test.sh 200 'pre-commit try-repo -a /tmp/159/pre-commit-terraform terraform_tfsec' '/tmp/infrastructure' '`terraform_tfsec` v1.51.0:' 'terraform_tfsec_pr159'
+```
+
+### Run via Docker
+
+```bash
+# Build `pre-commit-terraform` image
+docker build -t pre-commit-terraform --build-arg INSTALL_ALL=true .
+# Build test image
+docker build -t pre-commit-tests tests/
+# Run
+TEST_NUM=1
+TEST_DIR='/tmp/infrastructure'
+PRE_COMMIT_DIR="$(pwd)"
+TEST_COMMAND='pre-commit try-repo -a /pct terraform_tfsec'
+TEST_DESCRIPTION='`terraform_tfsec` v1.51.0:'
+RAW_TEST_RESULTS_FILE_NAME='terraform_tfsec_pr159'
+
+docker run -v "$PRE_COMMIT_DIR:/pct:rw" -v "$TEST_DIR:/lint:ro" pre-commit-tests \
+    $TEST_NUM "$TEST_COMMAND" '/lint' "$RAW_TEST_RESULTS_FILE_NAME" "$RAW_TEST_RESULTS_FILE_NAME"
+```
+
+### Check results
+
+Results will be located at `./test/results` dir.
+
+### Cleanup
+
+```bash
+sudo rm -rf tests/results
+```
+
+## Add new hook
+
+You can use [this PR](https://github.com/antonbabenko/pre-commit-terraform/pull/252) as an example.
+
+### Before write code
+
+1. Try to figure out future hook usage.
+2. Confirm the concept with [Anton Babenko](https://github.com/antonbabenko).
+
+### Prepare basic documentation
+
+1. Identify and describe dependencies in [Install dependencies](../README.md#1-install-dependencies) and [Available Hooks](../README.md#available-hooks) sections
+
+### Add code
+
+1. Based on prev. block, add hook dependencies installation to [Dockerfile](../Dockerfile).  
+    Check that works:
+    * `docker build -t pre-commit --build-arg INSTALL_ALL=true .`
+    * `docker build -t pre-commit --build-arg <NEW_HOOK>_VERSION=latest .`
+    * `docker build -t pre-commit --build-arg <NEW_HOOK>_VERSION=<1.2.3> .`
+2. Add new hook to [`.pre-commit-hooks.yaml`](../.pre-commit-hooks.yaml)
+3. Create hook file. Don't forget to make it executable via `chmod +x /path/to/hook/file`.
+4. Test hook. How to do it is described in [Run and debug hooks locally](#run-and-debug-hooks-locally) section.
+5. Test hook one more time.
+    1. Push commit with hook file to GitHub
+    2. Grab SHA hash of the commit
+    3. Test hook using `.pre-commit-config.yaml`:
+
+        ```yaml
+        repos:
+        - repo: https://github.com/antonbabenko/pre-commit-terraform # Your repo
+        rev: 3d76da3885e6a33d59527eff3a57d246dfb66620 # Your commit SHA
+        hooks:
+          - id: terraform_docs # New hook name
+            args:
+              - --args=--config=.terraform-docs.yml # Some args that you'd like to test
+        ```
+
+### Finish with the documentation
+
+1. Add hook description to [Available Hooks](../README.md#available-hooks).
+2. Create and populate a new hook section in [Hooks usage notes and examples](../README.md#hooks-usage-notes-and-examples).
@@ -0,0 +1,2 @@
+github: [antonbabenko]
+custom: https://www.paypal.me/antonbabenko
@@ -0,0 +1,81 @@
+---
+name: Docker bug report
+about: Create a bug report
+labels:
+- bug
+- area/docker
+---
+
+<!--
+Thank you for helping to improve pre-commit-terraform!
+
+Please be sure to search for open issues before raising a new one. We use issues
+for bug reports and feature requests. Please note, this template is for bugs
+report, not feature requests.
+-->
+
+### Describe the bug
+
+<!--
+Please let us know what behavior you expected and how terraform-docs diverged
+from that behavior.
+-->
+
+
+### How can we reproduce it?
+
+<!--
+Help us to reproduce your bug as succinctly and precisely as possible. Any and
+all steps or script that triggers the issue are highly appreciated!
+
+Do you have long logs to share? Please use collapsible sections, that can be created via:
+
+<details><summary>SECTION_NAME</summary>
+
+```bash
+YOUR_LOG_HERE
+```
+
+</details>
+-->
+
+
+### Environment information
+
+* OS:  
+
+<!-- I.e.:
+OS: Windows 10
+OS: Win10 with Ubuntu 20.04 on WSL2
+OS: MacOS
+OS: Ubuntu 20.04
+-->
+
+* `docker info`:
+
+<details><summary><code>command output</summary>
+
+```bash
+INSERT_OUTPUT_HERE
+```
+
+</details>
+
+* Docker image tag/git commit:  
+
+* Tools versions. Don't forget to specify right tag in command -  
+  `TAG=latest && docker run --entrypoint cat pre-commit:$TAG /usr/bin/tools_versions_info`
+
+```bash
+INSERT_OUTPUT_HERE
+```
+
+* `.pre-commit-config.yaml`:
+
+<details><summary>file content</summary>
+
+```bash
+INSERT_FILE_CONTENT_HERE
+```
+
+</details>
@@ -0,0 +1,106 @@
+---
+name: Local installation bug report
+about: Create a bug report
+labels:
+- bug
+- area/local_installation
+---
+
+<!--
+Thank you for helping to improve pre-commit-terraform!
+
+Please be sure to search for open issues before raising a new one. We use issues
+for bug reports and feature requests. Please note, this template is for bugs
+report, not feature requests.
+-->
+
+### Describe the bug
+
+<!--
+Please let us know what behavior you expected and how terraform-docs diverged
+from that behavior.
+-->
+
+
+### How can we reproduce it?
+
+<!--
+Help us to reproduce your bug as succinctly and precisely as possible. Any and
+all steps or script that triggers the issue are highly appreciated!
+
+Do you have long logs to share? Please use collapsible sections, that can be created via:
+
+<details><summary>SECTION_NAME</summary>
+
+```bash
+YOUR_LOG_HERE
+```
+
+</details>
+-->
+
+
+### Environment information
+
+* OS:  
+<!-- I.e.:
+OS: Windows 10
+OS: Win10 with Ubuntu 20.04 on WSL2
+OS: MacOS
+OS: Ubuntu 20.04
+-->
+
+* `uname -a` and/or `systeminfo | Select-String "^OS"` output:
+
+```bash
+INSERT_OUTPUT_HERE
+```
+
+<!-- I.e.:
+```bash
+PS C:\Users\vm> systeminfo | Select-String "^OS"
+
+OS Name:                   Microsoft Windows 10 Pro
+OS Version:                10.0.19043 N/A Build 19043
+OS Manufacturer:           Microsoft Corporation
+OS Configuration:          Standalone Workstation
+OS Build Type:             Multiprocessor Free
+
+$ uname -a
+Linux DESKTOP-C7315EF 5.4.72-microsoft-standard-WSL2 #1 SMP Wed Oct 28 23:40:43 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
+```
+-->
+
+* Tools availability and versions:
+
+<!--  For check all needed version run next script:
+
+$0 << EOF
+pre-commit --version                      2>/dev/null || echo "pre-commit SKIPPED"
+terraform --version | head -n 1           2>/dev/null || echo "terraform SKIPPED"
+python --version                          2>/dev/null || echo "python SKIPPED"
+python3 --version                         2>/dev/null || echo "python3 SKIPPED"
+echo -n "checkov " && checkov --version   2>/dev/null || echo "checkov SKIPPED"
+terraform-docs --version                  2>/dev/null || echo "terraform-docs SKIPPED"
+terragrunt --version                      2>/dev/null || echo "terragrunt SKIPPED"
+echo -n "terrascan " && terrascan version 2>/dev/null || echo "terrascan SKIPPED"
+tflint --version                          2>/dev/null || echo "tflint SKIPPED"
+echo -n "tfsec " && tfsec --version       2>/dev/null || echo "tfsec SKIPPED"
+EOF
+
+-->
+
+```bash
+INSERT_TOOLS_VERSIONS_HERE
+```
+
+
+* `.pre-commit-config.yaml`:
+
+<details><summary>file content</summary>
+
+```bash
+INSERT_FILE_CONTENT_HERE
+```
+
+</details>
@@ -0,0 +1,29 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+labels:
+- feature
+---
+
+<!--
+Thank you for helping to improve pre-commit-terraform!
+
+Please be sure to search for open issues before raising a new one. We use issues
+for bug reports and feature requests. Please note, this template is for feature
+requests, not bugs report.
+-->
+
+### What problem are you facing?
+
+<!--
+Please tell us a little about your use case - it's okay if it's hypothetical!
+Leading with this context helps frame the feature request so we can ensure we
+implement it sensibly.
+--->
+
+
+### How could pre-commit-terraform help solve your problem?
+
+<!--
+Let us know how you think pre-commit-terraform could help with your use case.
+-->
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+*`
	`2`	`+!.dockerignore`
	`3`	`+!Dockerfile`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+github: [antonbabenko]`
	`2`	`+custom: https://www.paypal.me/antonbabenko`