Trunk.io - custom linter: markdown-link-check

.. Trunk.io - custom linter: markdown-link-check README.md

Wrapper script to convert markdown-link-check stdout to lsp_json format for use by Trunk.io VSCode Extension

• ref: https://docs.trunk.io/check/custom-linters
• ref: https://github.com/tcort/markdown-link-check/tree/v3.10.0

File locations:

<repo>/.markdown-link-check.json
<repo>/.trunk/bin/markdown-link-check.js
<repo>/.trunk/trunk.yaml

.markdown-link-check.json

{
  "retryOn429": true,
  "retryCount": 5,
  "aliveStatusCodes": [200, 206, 403],
  "ignorePatterns": [
    {
      "pattern": "^http"
    }
  ]
}

markdown-link-check.js

#!/usr/bin/env node
'use strict';

/**
 * Wrapper script to convert markdown-link-check stdout to lsp_json format
 * for use by Trunk.io VSCode Extension
 * 
 * ref: https://github.com/tcort/markdown-link-check/tree/v3.10.0
 */

const fs = require('fs')
const { exec } = require('child_process');

const default_config = '.markdown-link-check.json'
const opts = process.argv.slice(2)

// add default config file if not specified
if (!opts.includes('--config')) {
  opts.unshift(default_config)
  opts.unshift('--config')
}

// check if config file exists
if (opts.includes('--config')) {
  // TODO: split opt if --config=some/file.json
  const k = opts.indexOf('--config')
  const v = k+1
  const file = opts[v]
  if (!fs.existsSync(file)) {
    // Fail if missing a custom config file
    if (default_config !== file) {
      console.log(`ERROR: missing custom config: ${file}`)
      process.exit(1)
    }
    // Remove default config opts
    opts[k] = opts[v] = ''
  }
}

const args = opts.filter((v) => v != '').join(' ')

exec(`markdown-link-check ${args}`, (err, stdout, stderr) => {
  if (err) {
    // NOTE: dead links are duplicated in stdout so grab those with Status codes
    const dead = [...stdout.matchAll(/\[✖\] (?<message>.*) \S Status: (?<status>.*)/g)]
    // NOTE: skipped URLs are defined in config. Much faster when only checking local links
    const skipped = [...stdout.matchAll(/\[\/\] (?<message>.*)/g)]
    // const live = [...stdout.match(/\[✓\] (?<message>.*)/g)]

    // Convert stdout text to lsp_json
    dead.forEach((v,i,a) => {
      const {status, message} = v.groups
      a[i] = {
        "message": `Dead link: ${status} ${message.replace('[✖] ', '')}`,
        "code": "link-dead",
        "source": "markdown-link-check",
        "severity": "Error",
        "range": {
          "start": {
            "line": 0,
            "character": 0
          },
          "end": {
            "line": 0,
            "character": 0
          }
        }
      }
    })

    skipped.forEach((v,i,a) => {
      const {message} = v.groups
      a[i] = {
        "message": `Skipped link: ${message.replace('[/] ', '')}`,
        "code": "link-skipped",
        "source": "markdown-link-check",
        "severity": "Warning",
        "range": {
          "start": {
            "line": 0,
            "character": 0
          },
          "end": {
            "line": 0,
            "character": 0
          }
        }
      }
    }) 

    // List all results
    const results = dead.concat(skipped)

    // Output lsp_json formatted results
    console.log(JSON.stringify(results))
    process.exit(1)
  }
  process.exit(0)
})

trunk.yaml

# NOTE: run trunk print-config to see complete config options
version: 0.1
cli:
  version: 0.9.0-beta
lint:
  # ref: https://docs.trunk.io/check/custom-linters
  linters:
    # https://github.com/tcort/markdown-link-check
    - name: markdown-link-check
      hold_the_line: false
      disable_upstream: true
      version_command:
        parse_regex: ${semver}
        run: markdown-link-check --version
      type: lsp_json
      files:
        - markdown
      good_without_config: true
      command:
        - ${workspace}/.trunk/bin/markdown-link-check.js
        - ${target}
      package: markdown-link-check
      runtime: node
      success_codes:
        - 0
        - 1
      direct_configs:
        - .markdown-link-check.json
  enabled:
    - markdown-link-check@3.10.0
  threshold:
    - linters: [markdown-link-check]
      level: LEVEL_HIGH

@metafeather they have a public plug-in repo now for folks to contribute

👋 Would love your contribution to https://github.com/trunk-io/plugins - we now support this!