[skip changelog] Add linting/formatting tasks and CI checks for docs and config files

Author: silvanocerza

.editorconfig

@@ -15,7 +15,7 @@ indent_size = 4
 indent_style = space
 indent_size = 4
 
-[*.yml,*.tmpl]
+[*.yml,*.yaml,*.tmpl]
 indent_style = space
 indent_size = 2
 

.github/workflows/verify-formatting.yaml

@@ -0,0 +1,37 @@
+name: 'Verify files formatting'
+
+on:
+  push:
+    paths:
+      - '**/*.md'
+      - '**/*.yml'
+      - '**/*.yaml'
+      - '.prettierrc'
+      - '.prettierignore'
+      - '!.github/ISSUE_TEMPLATE/**/*'
+      - '!.github/PULL_REQUEST_TEMPLATE.md'
+  pull_request:
+    paths:
+      - '**/*.md'
+      - '**/*.yml'
+      - '**/*.yaml'
+      - '.prettierrc'
+      - '.prettierignore'
+      - '!.github/ISSUE_TEMPLATE/**/*'
+      - '!.github/PULL_REQUEST_TEMPLATE.md'
+
+jobs:
+  verify-formatting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Install Taskfile
+        uses: Arduino/actions/setup-taskfile@master
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Verify formatting of all files
+        run: task docs:check config:check

.prettierignore

@@ -0,0 +1,9 @@
+# IDE files
+.idea/
+.vscode/
+.vs/
+.ionide/
+
+# GitHub templates
+.github/ISSUE_TEMPLATE/**/*
+.github/PULL_REQUEST_TEMPLATE.md

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "singleQuote": true
+}

Taskfile.yml

@@ -49,6 +49,16 @@ tasks:
     cmds:
       - mkdocs serve
 
+  docs:check:
+    desc: Run documentation linting
+    cmds:
+      - npx {{ .PRETTIER }} --check "**/*.md"
+
+  docs:format:
+    desc: Automatically formats documentation
+    cmds:
+      - npx {{ .PRETTIER }} --write "**/*.md"
+
   protoc:
     desc: Compile protobuf definitions
     cmds:
@@ -105,6 +115,18 @@ tasks:
       - "'{{.GOLINTBIN}}' {{.GOLINTFLAGS}} {{ default .DEFAULT_TARGETS .TARGETS }}"
       - task: i18n:check
       - task: python:check
+      - task: docs:check
+      - task: config:check
+
+  config:check:
+    desc: Check linting of configuration and supporting files
+    cmds:
+      - npx {{ .PRETTIER }} --check "**/*.{yml,yaml}"
+
+  config:format:
+    desc: Automatically formats configuration and supporting files
+    cmds:
+      - npx {{ .PRETTIER }} --write "**/*.{yml,yaml}"
 
   python:check:
     desc: Linting for Python files
@@ -183,3 +205,4 @@ vars:
   DOCS_VERSION: dev
   DOCS_ALIAS: ""
   DOCS_REMOTE: "origin"
+  PRETTIER: [email protected]