[housekeeping] GH Action markdown table formatting (discord#6376)

* Add markdown table format check to GH Actions

* Check in all docs folders for .md and .mdx

* Support globstar in bash command

* chore(actions): install markdown-table-formatter via package.json (#2)

adds the possibility to run it locally (check & fix)

* Move docs format check into its own workflow

---------

Co-authored-by: Lala Sabathil <[email protected]>

Author: colinloretz

.github/workflows/docs.yaml

@@ -0,0 +1,29 @@
+name: Verify Docs Formatting
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  markdown_tables:
+    name: Check Markdown Tables
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install Node v16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check Markdown Tables
+        run: |
+          shopt -s globstar
+          npx markdown-table-formatter docs/**/*.{md,mdx} --check
+        shell: bash

.github/workflows/test.yaml

@@ -45,4 +45,4 @@ jobs:
         run: npm run build
 
       - name: Run Link Checks
-        run: npm run test:links
+        run: npm run test:links

package-lock.json

@@ -20,7 +20,9 @@
 		"build": "tsc --build",
 		"lint": "eslint ci",
 		"lint:fix": "eslint ci --fix",
-		"test:links": "node dist/ci/checkLinks.js"
+		"test:links": "node dist/ci/checkLinks.js",
+		"test:tables": "npx markdown-table-formatter docs/**/*.{md,mdx} --check",
+		"fix:tables": "npx markdown-table-formatter docs/**/*.{md,mdx}"
 	},
 	"devDependencies": {
 		"@actions/core": "^1.9.1",
@@ -32,6 +34,7 @@
 		"eslint-config-marine": "^9.0.6",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-prettier": "^4.0.0",
+		"markdown-table-formatter": "^1.4.0",
 		"prettier": "^2.4.1",
 		"typescript": "^4.4.3"
 	}