基于angular-eslint创建自定义ESLint插件指南

项目背景

angular-eslint是一个专为Angular项目设计的ESLint生态系统，它提供了针对Angular模板和TypeScript代码的lint规则。该项目包含两个核心插件：eslint-plugin（用于TypeScript代码）和eslint-plugin-template（用于HTML模板）。

自定义插件开发基础

要创建自定义ESLint插件，首先需要理解几个核心概念：

1. 规则(Rule): 定义具体的代码检查逻辑
2. 处理器(Processor): 处理非JavaScript文件的预处理
3. 配置(Config): 定义规则如何被应用

对于Angular项目，我们通常需要处理两种文件类型：

• TypeScript文件（组件、服务等）
• HTML模板文件

创建TypeScript规则

开发TypeScript规则的基本流程：

1. 创建规则文件，通常命名为your-rule-name.ts
2. 使用createESLintRule工具函数定义规则
3. 实现规则的create方法，返回AST访问器

示例规则结构：

import { ESLintUtils } from '@typescript-eslint/utils';
import { createESLintRule } from '../utils/create-eslint-rule';

export const RULE_NAME = 'service-naming';
export const rule = createESLintRule({
  name: RULE_NAME,
  meta: {
    type: 'suggestion',
    docs: {
      description: '确保服务类名以Service结尾',
    },
    schema: [],
    messages: {
      missingServiceSuffix: '服务类名应以"Service"结尾',
    },
  },
  defaultOptions: [],
  create(context) {
    return {
      ClassDeclaration(node) {
        if (!node.id.name.endsWith('Service')) {
          context.report({
            node,
            messageId: 'missingServiceSuffix',
          });
        }
      },
    };
  },
});

创建HTML模板规则

HTML模板规则开发略有不同，因为需要处理的是模板AST而非TypeScript AST：

1. 创建规则文件，通常命名为template-your-rule-name.ts
2. 同样使用createESLintRule工具函数
3. 实现针对模板AST的检查逻辑

示例模板规则结构：

import { createESLintRule } from '../utils/create-eslint-rule';

export const RULE_NAME = 'require-trackby';
export const rule = createESLintRule({
  name: RULE_NAME,
  meta: {
    type: 'problem',
    docs: {
      description: '确保*ngFor循环使用trackBy函数',
    },
    schema: [],
    messages: {
      missingTrackBy: '*ngFor循环必须使用trackBy函数',
    },
  },
  defaultOptions: [],
  create(context) {
    return {
      'BoundAttribute[name="ngFor"]'(node) {
        const hasTrackBy = node.value.ast.properties.some(
          prop => prop.key.name === 'trackBy'
        );
        
        if (!hasTrackBy) {
          context.report({
            node,
            messageId: 'missingTrackBy',
          });
        }
      },
    };
  },
});

测试自定义规则

良好的测试是规则开发的关键部分。angular-eslint提供了测试工具来简化这一过程：

import { convertAnnotatedSourceToFailureCase } from '@angular-eslint/test-utils';

const messageId = 'missingServiceSuffix';
const ruleName = 'service-naming';

describe(ruleName, () => {
  it('应该通过以Service结尾的服务类名', () => {
    const source = `
      @Injectable()
      class UserService {}
    `;
    testRule({
      ruleName,
      rule,
      valid: [source],
    });
  });

  it('应该报告不以Service结尾的服务类名', () => {
    const source = `
      @Injectable()
      class User {}
    `;
    const failureCase = convertAnnotatedSourceToFailureCase({
      description: '应该检测到缺少Service后缀',
      annotatedSource: source,
      messageId,
      annotatedOutput: source,
    });
    testRule({
      ruleName,
      rule,
      invalid: [failureCase],
    });
  });
});

打包和发布插件

完成规则开发后，需要将插件打包发布：

1. 创建index.ts导出所有规则
2. 配置package.json中的main和types字段
3. 确保exports字段正确配置
4. 发布到npm或私有仓库

最佳实践

1. 性能考虑：规则应尽可能高效，避免深度遍历AST
2. 错误信息：提供清晰、具体的错误信息
3. 文档：为每个规则编写详细的使用说明
4. 可配置性：通过schema支持规则配置
5. 向后兼容：避免破坏性变更

常见问题解决

1. AST类型问题：使用正确的类型定义，TypeScript规则使用@typescript-eslint类型，模板规则使用@angular/compiler类型
2. 跨文件分析：对于需要跨文件分析的复杂规则，可以使用TypeScript的类型检查器
3. 性能优化：对于大型项目，考虑实现选择性分析或缓存机制

通过遵循这些指南，开发者可以创建出高效、可靠的自定义ESLint规则，专门针对Angular项目的特定需求进行代码质量检查。