eslint-config-alloy/scripts/rulesCoverage.ts

AlloyTeam ESLint 规则

/* eslint-disable @typescript-eslint/no-require-imports */
import fs from 'fs';
import path from 'path';

import { NAMESPACE_CONFIG, NAMESPACES } from '../config';

/** 可用的规则（去除废弃的和 Prettier 的规则） */
let activeRules: string[] = [];
let deprecatedRules: string[] = [];
// https://github.com/prettier/eslint-config-prettier/pull/217
const prettierRules = [...Object.keys(require('eslint-config-prettier').rules), 'vue/quote-props'];
const vue2Rules = [
  'vue/no-custom-modifiers-on-v-model',
  'vue/no-multiple-template-root',
  'vue/no-v-for-template-key',
  'vue/no-v-for-template-key-on-child',
  'vue/no-v-model-argument',
  'vue/valid-v-bind-sync',
];

// 填充 deprecatedRules 和 activeRules
Object.values(NAMESPACE_CONFIG).forEach(({ rulePrefix, pluginName }) => {
  const ruleEntries = pluginName
    ? Object.entries<any>(require(pluginName).rules)
    : Array.from<any>(require('eslint/lib/rules').entries());
  ruleEntries.forEach(([ruleName, ruleValue]) => {
    const fullRuleName = rulePrefix + ruleName;
    if (ruleValue.meta.deprecated) {
      deprecatedRules.push(fullRuleName);
      return;
    }
    if (prettierRules.includes(fullRuleName)) {
      return;
    }
    if (vue2Rules.includes(fullRuleName)) {
      return;
    }
    activeRules.push(fullRuleName);
  });
});

const errors: string[] = [];
/** 可用的规则中，未使用的规则 */
const remainingRules = [...activeRules];

/**
 * 通过分析 test 目录下的文件，找出
 * 1. 使用了已废弃的规则
 * 2. 使用了 Prettier 的规则
 * 3. 可用的规则没有被使用
 */
NAMESPACES.forEach((namespace) => {
  fs.readdirSync(path.resolve(__dirname, '../test', namespace))
    .filter((ruleName) => fs.lstatSync(path.resolve(__dirname, '../test', namespace, ruleName)).isDirectory())
    .forEach((ruleName) => {
      const fullRuleName = NAMESPACE_CONFIG[namespace].rulePrefix + ruleName;
      if (deprecatedRules.includes(fullRuleName)) {
        errors.push(`${fullRuleName} is deprecated, please REMOVE it`);
        return;
      }
      if (prettierRules.includes(fullRuleName)) {
        errors.push(`${fullRuleName} is ignored by prettier, please REMOVE it`);
        return;
      }
      if (vue2Rules.includes(fullRuleName)) {
        errors.push(`${fullRuleName} is ignored by vue2, please REMOVE it`);
        return;
      }
      if (activeRules.includes(fullRuleName)) {
        remainingRules.splice(remainingRules.indexOf(fullRuleName), 1);
        return;
      }
    });
});

if (remainingRules.length > 0) {
  errors.push(
    `Missing rules: ${remainingRules
      .map((ruleName) => `\n  - ${ruleName} ${getDocsUrlFromRuleName(ruleName)}`)
      .join('')}`,
  );
  //   remainingRules.forEach((ruleName) => {
  //     fs.mkdirSync(path.resolve(__dirname, '../test', ruleName));
  //     fs.writeFileSync(
  //       path.resolve(__dirname, '../test', ruleName, '.eslintrc.js'),
  //       `module.exports = {
  //   rules: {
  //     /**
  //      *
  //      */
  //     '${ruleName.split('/')[1]}': 'off',
  //   },
  // };
  // `,
  //       'utf-8',
  //     );
  //   });
}

if (errors.length > 0) {
  throw new Error(errors.map((error) => `\n- ${error}`).join(''));
}

function getDocsUrlFromRuleName(ruleName: string) {
  for (const namespaceConfig of Object.values(NAMESPACE_CONFIG).reverse()) {
    const { rulePrefix, getDocsUrl } = namespaceConfig;
    if (ruleName.startsWith(rulePrefix)) {
      return getDocsUrl(ruleName);
    }
  }
}