如何用ESLint强制解构对象使用内联类型而非单独类型定义？

目前确实没有现成的ESLint规则直接实现这个要求，你可以通过以下几种方式解决：

1. 自定义TypeScript ESLint规则 #

这是最彻底的方案，可以自动检测并强制规范。核心思路是：

• 检测函数参数中解构对象的类型注解是否引用了单独定义的type或interface
• 若检测到，抛出错误提示，并可实现自动修复（将单独类型的内容替换为内联注解）

简化的规则示例 #

import { ESLintUtils } from '@typescript-eslint/utils';

const createRule = ESLintUtils.RuleCreator(() => '');

export default createRule({
  name: 'no-separate-destructured-type',
  meta: {
    type: 'suggestion',
    docs: {
      description: '强制解构对象使用内联类型定义，禁止引用单独的type/interface'
    },
    fixable: 'code',
    schema: []
  },
  defaultOptions: [],
  create(context) {
    return {
      // 匹配解构对象的类型注解引用
      'FunctionDeclaration > Parameter > ObjectPattern > TSTypeAnnotation > TSTypeIdentifier'(node) {
        const typeName = node.name;
        const scope = context.getScope();
        const typeDef = scope.variables.find(v => v.name === typeName)?.defs[0];

        // 检查是否是单独定义的type或interface
        if (typeDef?.type === 'TypeAlias' || typeDef?.type === 'Interface') {
          context.report({
            node,
            message: '请使用内联类型注解替代单独定义的type/interface',
            fix(fixer) {
              // 自动修复：将类型内容替换为内联形式
              if (typeDef.node.type?.body) {
                const typeEntries = typeDef.node.type.body.body.map(member => 
                  `${member.key.name}: ${member.type.typeAnnotation.type.type}`
                ).join(', ');
                return fixer.replaceText(node, `{ ${typeEntries} }`);
              }
            }
          });
        }
      }
    };
  }
});

配置使用 #

将自定义规则添加到项目的ESLint配置文件中：

{
  "rules": {
    "@typescript-eslint/no-separate-destructured-type": "error"
  }
}

2. 代码审查+自定义扫描脚本 #

如果暂时不想编写ESLint规则，可以通过代码审查明确规范，同时配合自定义脚本批量扫描违规代码。

基于ts-morph的扫描脚本示例 #

import { Project } from 'ts-morph';

const project = new Project();
// 替换为你的组件文件路径
project.addSourceFilesAtPaths('src/**/*.tsx');

project.getSourceFiles().forEach(file => {
  // 扫描所有箭头函数和普通函数
  [...file.getFunctions(), ...file.getArrowFunctions()].forEach(func => {
    func.getParameters().forEach(param => {
      const objectPattern = param.getStructure().pattern;
      const typeAnnotation = param.getTypeNode();

      // 检查是否是解构对象且引用了单独的类型
      if (objectPattern?.kind === 'ObjectLiteral' && typeAnnotation?.kind === 'TypeReference') {
        const typeName = typeAnnotation.getTypeName().getText();
        const hasSeparateType = file.getTypeAlias(typeName) || file.getInterface(typeName);
        
        if (hasSeparateType) {
          console.log(`[违规] ${file.getRelativePath()} - ${func.getName() || "匿名组件"} 使用了单独定义的${file.getTypeAlias(typeName) ? 'type' : 'interface'} ${typeName}`);
        }
      }
    });
  });
});

运行脚本即可找出所有违反规范的代码，在PR审查中重点关注这类问题。

3. 团队规范文档约束 #

将该规范明确写入团队的代码风格指南中，结合定期的代码巡检，确保团队成员遵守。

内容的提问来源于stack exchange，提问作者kaimcg