Format and lint markdown files

.github/workflows/markdownlint.yml

@@ -0,0 +1,35 @@
+name: markdownlint
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - "**.md"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: latest
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          yarn install --immutable --immutable-cache --check-cache
+
+      - name: Check
+        run: |
+          yarn run markdownlint:check

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## next
 
-- Updates TextMate grammar
+- Update TextMate grammar
 
 ## 1.15.0
 
@@ -69,7 +69,7 @@
 
 - Generate `<builddir>/meson-vscode.env` to be used in `launch.json`'s `envFile`
   to run programs using Meson's developper environment. See
-  https://mesonbuild.com/Commands.html#devenv
+  [meson devenv](https://mesonbuild.com/Commands.html#devenv).
 
 ## 1.7.1
 

README.md

@@ -1,4 +1,4 @@
-# Meson for VisualStudio Code
+# Meson for Visual Studio Code
 
 This extension provides support for [Meson](http://mesonbuild.com/) in
 [Visual Studio Code](https://code.visualstudio.com/). This language grammar was
@@ -9,7 +9,7 @@ support more features, including code from the VSCode
 [grammar](https://github.com/microsoft/vscode/blob/main/extensions/python/syntaxes/MagicPython.tmLanguage.json)
 for Python.
 
-Meson logo by @jpakkane,
+Meson logo by [Jussi Pakkanen](https://github.com/jpakkane),
 [licensed for use by this project](http://mesonbuild.com/legal.html). Icons from
 the [Material Design Icons](https://materialdesignicons.com/) project.
 
@@ -18,17 +18,24 @@ the [Material Design Icons](https://materialdesignicons.com/) project.
 - Syntax Highlighting
 - Automatic Task Provider
 - Code Snippets
-- Linting\*
-- Formatting\*
+- Linting[^0]
+- Formatting[^1]
 - Generate environment file to be used in launch.json:
   `"envFile": "${workspaceFolder}/${config:mesonbuild.buildFolder}/meson-vscode.env"`
   See [Meson devenv](https://mesonbuild.com/Commands.html#devenv)
-- Configure Intellisense to use `compile_commands.json` generated by Meson
+- Configure Intellisense to use the `compile_commands.json` generated by Meson
 
 \* - requires an installation of [muon](https://muon.build).
 
-# New extension ID
+## New Extension ID
 
 If you come from a previous installation, please make sure you are on the
 **mesonbuild.mesonbuild** extension. There are 3 variants/versions of this
 extension on the store, and only that one is released from this repository.
+
+[^0]:
+    Requires an installation of
+    [Swift-MesonLSP](https://github.com/JCWasmx86/Swift-MesonLSP) or
+    [muon](https://muon.build).
+
+[^1]: Requires an installation of muon.

package.json

@@ -416,6 +416,7 @@
   },
   "scripts": {
     "compile": "tsc -p ./",
+    "markdownlint:check": "markdownlint-cli2 **.md",
     "postinstall": "husky install",
     "prettier:check": "prettier --check **.md **.ts **.yml **.json",
     "vscode:prepublish": "npm run compile",
@@ -428,6 +429,7 @@
     "@types/which": "^3.0.0",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.1",
+    "markdownlint-cli2": "^0.10.0",
     "prettier": "^3.0.3",
     "typescript": "^5.2.2",
     "vscode-oniguruma": "^2.0.1",