chore: add markdownlint and format component changelogs (#3587)

* chore: add markdownlint and format component changelogs

Author: castastrophe

.eslintrc

@@ -144,6 +144,30 @@
 				]
 			}
 		},
+		{
+			"files": ["tokens/dist/**/*.json"],
+			"rules": {
+				"jsonc/sort-keys": [
+					"warn",
+					{
+						"pathPattern": "^$",
+						"order": { "type": "asc" }
+					},
+					{
+						"pathPattern": ".*",
+						"order": [
+							"prop",
+							"ref",
+							"value",
+							"light",
+							"dark",
+							"medium",
+							"large"
+						]
+					}
+				]
+			}
+		},
 		{
 			"files": [
 				"components/*/stories/*.js",

.github/workflows/development.yml

@@ -85,6 +85,8 @@ jobs:
             styles_modified_files: ${{ steps.changed-files.outputs.styles_modified_files }}
             eslint_added_files: ${{ steps.changed-files.outputs.eslint_added_files }}
             eslint_modified_files: ${{ steps.changed-files.outputs.eslint_modified_files }}
+            mdlint_added_files: ${{ steps.changed-files.outputs.mdlint_added_files }}
+            mdlint_modified_files: ${{ steps.changed-files.outputs.mdlint_modified_files }}
             plugins_modified_files: ${{ steps.changed-files.outputs.plugins_modified_files }}
             plugins_added_files: ${{ steps.changed-files.outputs.plugins_added_files }}
         permissions:
@@ -102,6 +104,17 @@ jobs:
                         - components/*/themes/express.css
                       eslint:
                         - components/*/stories/*.js
+                      mdlint:
+                        - *.md
+                        - .storybook/*.md
+                        - .storybook/*/*.md
+                        - .storybook/*/*.mdx
+                        - components/*/*.md
+                        - components/*/stories/*.mdx
+                        - plugins/*/*.md
+                        - tokens/*.md
+                        - tools/*/*.md
+                        - ui-icons/*.md
                       plugins:
                         - plugins/**/*
 

.github/workflows/lint.yml

@@ -18,6 +18,12 @@ on:
             eslint_modified_files:
                 type: string
                 required: false
+            mdlint_added_files:
+                type: string
+                required: false
+            mdlint_modified_files:
+                type: string
+                required: false
     workflow_call:
         inputs:
             styles_added_files:
@@ -32,6 +38,12 @@ on:
             eslint_modified_files:
                 type: string
                 required: false
+            mdlint_added_files:
+                type: string
+                required: false
+            mdlint_modified_files:
+                type: string
+                required: false
 
 permissions:
     contents: read
@@ -104,3 +116,12 @@ jobs:
                   filter_mode: diff_context
                 #   eslint_flags: "components/*/stories/*.js"
                   eslint_flags: "${{ inputs.eslint_added_files }} ${{ inputs.eslint_modified_files }}"
+
+            - name: Run markdownlint on documentation
+              uses: reviewdog/[email protected]
+              with:
+                reporter: github-pr-review
+                filter_mode: diff_context
+                fail_level: error
+                markdownlint_config: "${{ github.workspace }}/.markdownlint.json"
+                markdownlint_input: "${{ inputs.mdlint_added_files }} ${{ inputs.mdlint_modified_files }}"

.markdownlint.json

@@ -0,0 +1,24 @@
+{
+    "extends": "markdownlint/style/prettier",
+    "first-line-h1": false,
+	"no-inline-html": false,
+    "no-bare-urls": false,
+    "no-duplicate-heading": {
+      "siblings_only": true
+    },
+    "code-block-style": {
+      "style": "fenced"
+    },
+    "code-fence-style": {
+      "style": "backtick"
+    },
+    "emphasis-style": {
+      "style": "underscore"
+    },
+    "strong-style": {
+      "style": "asterisk"
+    },
+    "ul-style": {
+      "style": "dash"
+    }
+}