feat(pre-commit): adds pre-commit, and fixes based on pre-commit feedback

.github/workflows/close-issue.yml

@@ -9,4 +9,4 @@ jobs:
     uses: specklesystems/github-actions/.github/workflows/project-add-issue.yml@main
     secrets: inherit
     with:
-      issue-id: ${{ github.event.issue.node_id }}
+      issue-id: ${{ github.event.issue.node_id }}

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v3.0.0-alpha.4'
+    hooks:
+      - id: prettier
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 'v4.4.0'
+    hooks:
+      - id: check-yaml
+        exclude: 'deploy/helm'
+      - id: check-merge-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-vcs-permalinks
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+        exclude: 'deploy/helm/README.md'
+
+  - repo: https://github.com/syntaqx/git-hooks
+    rev: 'v0.0.17'
+    hooks:
+      - id: circleci-config-validate
+
+  - repo: https://github.com/Jarmos-san/shellcheck-precommit
+    rev: 'v0.2.0'
+    hooks:
+      - id: shellcheck-system
+
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: v1.11.0
+    hooks:
+      - id: helm-docs
+        args:
+          - --chart-search-root=charts
+
+ci:
+  autoupdate_schedule: weekly

.prettierignore

@@ -0,0 +1,2 @@
+.github
+charts

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "semi": false,
+  "endOfLine": "auto",
+  "bracketSpacing": true,
+  "vueIndentScriptAndStyle": false,
+  "htmlWhitespaceSensitivity": "ignore",
+  "printWidth": 88,
+  "singleQuote": true
+}

README.md

@@ -23,20 +23,20 @@ Comprehensive developer and user documentation can be found in our:
 1. Edit the file `./example/values.yaml` to include your API key for seq.
 1. Run the following command to install the helm chart in your kubernetes cluster. Note that this will create a new namespace named `seq-input-gelf`:
 
-    ```shell
+   ```shell
-    helm upgrade seq-input-gelf \
+   helm upgrade seq-input-gelf \
-    ./charts/seq-input-gelf \
+   ./charts/seq-input-gelf \
-    --create-namespace \
+   --create-namespace \
-    --namespace seq-input-gelf \
+   --namespace seq-input-gelf \
-    --install \
+   --install \
-    --values ./example/values.yaml
+   --values ./example/values.yaml
-    ```
+   ```
 
 1. Verify that the deployment has successfully [rolled out](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#deployment-status):
 
-    ```shell
+   ```shell
-    kubectl rollout status deployment/seq-input-gelf --namespace seq-input-gelf
+   kubectl rollout status deployment/seq-input-gelf --namespace seq-input-gelf
-    ```
+   ```
 
 ### Developing & Debugging