gitlabhq/scripts/frontend/lint_docs_links.mjs

#!/usr/bin/env node

import { ESLint } from 'eslint';
import pluginVue from 'eslint-plugin-vue';
import localRules from 'eslint-plugin-local-rules';

const RULE_REQUIRE_VALID_HELP_PAGE_PATH = 'local-rules/require-valid-help-page-path';
const RULE_VUE_REQUIRE_VALID_HELP_PAGE_LINK_COMPONENT =
  'local-rules/vue-require-valid-help-page-link-component';
const RULES = [RULE_REQUIRE_VALID_HELP_PAGE_PATH, RULE_VUE_REQUIRE_VALID_HELP_PAGE_LINK_COMPONENT];

function createESLintInstance(overrideConfig) {
  return new ESLint({ overrideConfigFile: true, overrideConfig, fix: false });
}

function lint(eslint, filePaths) {
  return eslint.lintFiles(filePaths);
}

function outputLintingResults(results) {
  const outdatedLinksErrors = results.reduce((acc, result) => {
    const errors = result.messages.filter((message) => RULES.includes(message.ruleId));
    if (errors.length) {
      acc.push({
        ...result,
        messages: errors,
        errorCount: errors.length,
        suppressedMessages: [],
        fatalErrorCount: 0,
        warningCount: 0,
        fixableErrorCount: 0,
        fixableWarningCount: 0,
      });
    }
    return acc;
  }, []);
  return outdatedLinksErrors;
}

async function lintFiles(filePaths) {
  console.log(
    `Running ESLint with the following rules enabled:${RULES.map((rule) => `\n* ${rule}`).join('')}`,
  );

  /** @type { import("eslint").Linter.Config } */
  const overrideConfig = [
    ...pluginVue.configs['flat/base'],
    {
      languageOptions: {
        ecmaVersion: 'latest',
        sourceType: 'module',
      },
      plugins: {
        'local-rules': localRules,
      },
    },
    {
      files: ['**/*.vue'],
      rules: {
        [RULE_REQUIRE_VALID_HELP_PAGE_PATH]: 'error',
        [RULE_VUE_REQUIRE_VALID_HELP_PAGE_LINK_COMPONENT]: 'error',
      },
    },
    {
      files: ['**/*.{js,mjs}'],
      rules: {
        [RULE_REQUIRE_VALID_HELP_PAGE_PATH]: 'error',
      },
    },
  ];

  const eslint = createESLintInstance(overrideConfig);
  const results = await lint(eslint, filePaths);
  const formatter = await eslint.loadFormatter();
  const errors = outputLintingResults(results);

  if (errors.length > 0) {
    console.log(formatter.format(errors));
    process.exitCode = 1;
  } else {
    console.log('No issues found!');
  }
}

lintFiles(['./{,ee/}app/assets/javascripts/**/*{.js,.vue}']);