Merge pull request #10 from lumapps/chore/add_dev_requirements

chore(local): add quality controls

Author: Anis

.gitignore

@@ -0,0 +1 @@
+venv

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+---
+repos:
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.24.2
+    hooks:
+      - id: yamllint
+        args: [-c=./local/yamllint_config.yaml]
+
+  - repo: https://github.com/frnmst/md-toc
+    rev: master  # or a specific git tag from md-toc
+    hooks:
+      - id: md-toc
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: debug-statements
+      - id: check-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: (.github/CODEOWNERS|validator.bats)

Makefile

@@ -0,0 +1,18 @@
+# Use a standard bash shell, avoid zsh or fish
+SHELL:=/bin/bash
+
+# Select the default target, when you are simply running "make"
+.DEFAULT_GOAL:=lint
+
+# local executables
+pip:=./venv/bin/pip
+pre-commit=./venv/bin/pre-commit
+
+.PHONY: lint venv
+
+venv:
+	python3.7 -m venv venv
+	$(pip) install pre-commit
+
+lint:
+	$(pre-commit) run --all-files

action.yml

@@ -1,5 +1,7 @@
+---
 name: 'Commit message validator'
-description: 'Enforce angular commit message convention with minimal dependancy only git and bash.'
+description: >
+  Enforce angular commit message convention with minimal dependency only git and bash.
 author: 'Sébastien Boulle'
 branding:
   icon: 'check-square'
@@ -23,7 +25,9 @@ runs:
       shell: bash
 
     - name: Validation
-      run: ${{ github.action_path }}/check.sh ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}
+      run: |
+        ${{ github.action_path }}/check.sh \
+        ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}
       env:
         COMMIT_VALIDATOR_NO_JIRA: ${{ inputs.no_jira }}
         COMMIT_VALIDATOR_ALLOW_TEMP: ${{ inputs.allow_temp }}

local/yamllint_config.yaml

@@ -0,0 +1,9 @@
+---
+extends: default
+ignore: |
+    .github/workflows/
+    venv/
+rules:
+    line-length:
+        max: 120
+    comments-indentation: disable