MNT Move linting to a dedicated repository

.github/workflows/ci.yml → .github/workflows/lint-docs.yml

@@ -13,38 +13,43 @@ jobs:
       # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast
       fail-fast: false
       matrix:
-        script: [ 'lint-md', 'lint-js', 'lint-php' ]
-    name: ${{ matrix.script }}
+        lint_lang: [ 'lint-md', 'lint-js', 'lint-php' ]
+    name: ${{ matrix.lint_lang }}
     steps:
 
       - name: Checkout code
         uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
 
+      - name: Install PHP
+        uses: shivammathur/setup-php@1a18b2267f80291a81ca1d33e7c851fe09e7dfc4 # v2.22.0
+        with:
+          php-version: 8.1
+
+      - name: Install composer dependencies
+        run: composer install --prefer-dist --no-progress --ansi --no-interaction --optimize-autoloader
+
       - name: Read .nvmrc
+        if: ${{ matrix.lint_lang == 'lint-md' || matrix.lint_lang == 'lint-js' }}
         id: read-nvm
         run: |
-          NPM_VERSION=$(cat .nvmrc)
+          NPM_VERSION=$(cat vendor/silverstripe/documentation-lint/.nvmrc)
           echo "version=$NPM_VERSION" >> $GITHUB_OUTPUT
 
       - name: Install NPM
+        if: ${{ matrix.lint_lang == 'lint-md' || matrix.lint_lang == 'lint-js' }}
         uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3.8.2
         with:
           node-version: ${{ steps.read-nvm.outputs.version }}
 
-      - name: Install yarn dependencies
+      - name: Install yarn
+        if: ${{ matrix.lint_lang == 'lint-md' || matrix.lint_lang == 'lint-js' }}
         run: |
           npm install --global yarn
-          yarn install
-
-      - name: Install PHP
-        if: ${{ matrix.script == 'lint-php' }}
-        uses: shivammathur/setup-php@1a18b2267f80291a81ca1d33e7c851fe09e7dfc4 # v2.22.0
-        with:
-          php-version: 8.1
-
-      - name: Install composer dependencies
-        if: ${{ matrix.script == 'lint-php' }}
-        run: composer install --prefer-dist --no-progress --ansi --no-interaction --optimize-autoloader
 
       - name: Run lint
-        run: yarn ${{ matrix.script }}
+        run: |
+          # Get the correct flag for tha language, e.g. "--md"
+          LINT_LANG=${{ matrix.lint_lang }}
+          FLAG="--${LINT_LANG#lint-}"
+          # Run the script
+          vendor/bin/ss-docs-lint $FLAG

.gitignore

@@ -1,3 +1,2 @@
-/node_modules/
 /vendor/
 composer.lock

.ss-docs-lint

@@ -0,0 +1 @@
+en/

composer.json

@@ -12,17 +12,16 @@
     ],
     "authors": [
         {
-            "name": "SilverStripe",
+            "name": "Silverstripe",
             "homepage": "https://silverstripe.com"
         },
         {
-            "name": "The SilverStripe Community",
+            "name": "The Silverstripe Community",
             "homepage": "https://silverstripe.org"
         }
     ],
     "require-dev": {
-        "silverstripe/markdown-php-codesniffer": "^1",
-        "slevomat/coding-standard": "^8.14"
+        "silverstripe/documentation-lint": "^1"
     },
     "config": {
         "allow-plugins": {