tools/lint-md/lint-md.mjs - main - githubmirror/node

tools/lint-md/lint-md.mjs
60 строк2 KB
1ilsang
tools: consolidate 'introduced_in' check for docs
20 фев 2025, 15:28
20 фев 2025, 15:2803fdde5
import fs from 'node:fs';
import { parseArgs } from 'node:util';

import { unified } from 'unified';
import remarkParse from 'remark-parse';
import remarkStringify from 'remark-stringify';
import presetLintNode from 'remark-preset-lint-node';
import { read } from 'to-vfile';
import { reporter } from 'vfile-reporter';

const { values: { format }, positionals: paths } = parseArgs({
  options: {
    format: { type: 'boolean', default: false },
  },
  allowPositionals: true,
});

if (!paths.length) {
  console.error('Usage: lint-md.mjs [--format] <path> [<path> ...]');
  process.exit(1);
}

const linter = unified()
  .use(remarkParse)
  .use(presetLintNode)
  .use(remarkStringify);

paths.forEach(async (path) => {
  const file = await read(path);
  // We need to calculate `fileContents` before running `linter.process(files)`
  // because `linter.process(files)` mutates `file` and returns it as `result`.
  // So we won't be able to use `file` after that to see if its contents have
  // changed as they will have been altered to the changed version.
  const fileContents = file.toString();
  const result = await linter.process(file);
  const isDifferent = fileContents !== result.toString();

  if (path.startsWith('doc/api/')) {
    if (!fileContents.includes('introduced_in')) {
      console.error(`${path} is missing an 'introduced_in' version. Please add one.`);
      process.exitCode = 1;
    }
  }

  if (format) {
    if (isDifferent) {
      fs.writeFileSync(path, result.toString());
    }
  } else {
    if (isDifferent) {
      process.exitCode = 1;
      const cmd = process.platform === 'win32' ? 'vcbuild' : 'make';
      console.error(`${path} is not formatted. Please run '${cmd} format-md'.`);
    }
    if (result.messages.length) {
      process.exitCode = 1;
      console.error(reporter(result));
    }
  }
});