From 0834c660fb543d7736d2084ad92e8a3bf62f2d16 Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Fri, 1 Jan 2021 19:22:25 +0200
Subject: [PATCH] pre-commit.

Add common Docker checks, address some issues.
---
 .pre-commit-config.yaml | 49 +++++++++++++++++++++++++++++++++++++++++
 Dockerfile              |  1 +
 README.md               | 14 ++++++------
 3 files changed, 57 insertions(+), 7 deletions(-)
 create mode 100644 .pre-commit-config.yaml

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..b5c5f82
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,49 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks.git
+    rev: v3.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: trailing-whitespace
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v0.14.3
+    hooks:
+      - id: detect-secrets
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.25.0
+    hooks:
+      - id: yamllint
+
+  - repo: https://github.com/amperser/proselint/
+    rev: 0.10.2
+    hooks:
+      - id: proselint
+        types: [plain-text]
+        exclude: LICENSE|example
+
+  - repo: https://github.com/executablebooks/mdformat.git
+    rev: 0.5.3
+    hooks:
+      - id: mdformat
+        exclude: example
+
+  - repo: https://git.shore.co.il/nimrod/shell-pre-commit.git
+    rev: v0.6.0
+    hooks:
+      - id: shell-lint
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py.git
+    rev: v0.7.1.1
+    hooks:
+      - id: shellcheck
+
+  - repo: https://git.shore.co.il/nimrod/docker-pre-commit.git/
+    rev: v0.3.0
+    hooks:
+      - id: hadolint
+      - id: docker-compose
diff --git a/Dockerfile b/Dockerfile
index 72ffce2..746a692 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -4,6 +4,7 @@ RUN go get github.com/spelufo/on-change && \
 
 FROM debian:buster-slim
 COPY --from=golang /go/bin/on-change /go/bin/ttyrec2gif /usr/local/bin/
+# hadolint ignore=DL3008
 RUN apt-get update && \
     DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
         ca-certificates \
diff --git a/README.md b/README.md
index 6cf40fc..e7a5df5 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,11 @@ Markdown or DOT).
 
 ## Usage
 
-`docker run --rm -itv "$PWD:/volume" adarnimrod/presentation`
+`docker run --rm -itv ג€œ$PWD:/volumeג€œ adarnimrod/presentation`
 
 Will watch the current directory and run `make` whenever a file changes. One can
-add a shell alias `alias presentation='docker run --rm -itv "$PWD:/volume"
-adarnimrod/presentation'` for easier use.
+add a shell alias
+`alias presentation='docker run --rm -itv ג€œ$PWD:/volumeג€œ adarnimrod/presentation'` for easier use.
 
 See the example folder for more details.
 
@@ -31,7 +31,7 @@ This software is licensed under the MIT license (see `LICENSE.txt`).
 
 ## Author Information
 
-Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my [website](
-https://www.shore.co.il/). Patches are welcome via [`git send-email`](
-http://git-scm.com/book/en/v2/Git-Commands-Email). The repository is located
-at: <https://www.shore.co.il/git/>.
+Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my
+[website](https://www.shore.co.il/). Patches are welcome via
+[`git send-email`](http://git-scm.com/book/en/v2/Git-Commands-Email). The repository
+is located at: <https://git.shore.co.il/expore/>.
-- 
GitLab