ERB Lint 插件生态系统：如何扩展和定制检查功能

ERB Lint 插件生态系统：如何扩展和定制检查功能

【免费下载链接】erb-lintLint your ERB or HTML files项目地址: https://gitcode.com/gh_mirrors/er/erb-lint

ERB Lint 是一款强大的 ERB 和 HTML 文件检查工具，它通过丰富的插件生态系统提供灵活的代码质量检查功能。本文将详细介绍如何扩展和定制 ERB Lint 的检查功能，帮助开发者打造符合项目需求的代码检查规则。

核心 Linter 架构解析

ERB Lint 的插件系统基于 Linter 基类构建，所有内置检查器都继承自这个核心类。在lib/erb_lint/linter.rb中定义了基础框架，为自定义检查器提供了标准化接口。

内置 Linter 类型概览

ERB Lint 提供了多种内置检查器，覆盖从代码风格到安全检查的多个维度：

• 代码风格检查：如SpaceAroundErbTag（检查 ERB 标签周围空格）、SpaceIndentation（缩进检查）
• HTML 规范检查：如SelfClosingTag（自闭合标签检查）、SpaceInHtmlTag（HTML 标签内空格检查）
• 安全检查：如ErbSafety（ERB 安全检查）、RequireScriptNonce（脚本 Nonce 检查）
• 性能与最佳实践：如DeprecatedClasses（废弃类检查）、NoUnusedDisable（未使用禁用指令检查）

这些检查器位于lib/erb_lint/linters/目录下，每个文件对应一个独立的检查功能。

开发自定义 Linter 的完整指南

基础结构与必要方法

创建自定义 Linter 需要继承Linter基类并实现核心方法：

class CustomLinter < Linter def run(processed_source) # 检查逻辑实现 end def autocorrect(processed_source, offense) # 自动修复逻辑实现 end end

• run方法：接收processed_source参数，实现具体的检查逻辑
• autocorrect方法（可选）：定义自动修复功能，返回修复后的代码

配置模式定义

通过定义ConfigSchema类可以为 Linter 添加可配置选项：

class CustomLinter < Linter class ConfigSchema < LinterConfig property :allowed_tags, default: %w[div span], accepts: Array end end

注册与使用自定义 Linter

创建好的 Linter 需要在lib/erb_lint/linter_registry.rb中注册，才能被 ERB Lint 识别和加载。

高级定制技巧

利用现有工具集成

ERB Lint 支持与 RuboCop 集成，通过Rubocop和RubocopText检查器（位于lib/erb_lint/linters/）可以复用 Ruby 代码检查规则。

上下文感知检查

通过processed_source对象可以获取文件内容、行号等上下文信息，实现更精准的检查：

def run(processed_source) processed_source.each_line do |line| if line.include?('<%= @') && !line.include?('local_assigns') add_offense(...) end end end

自动修复实现

自动修复功能通过返回代码修改操作实现，如RightTrim检查器的实现：

def autocorrect(_processed_source, offense) ->(corrector) { corrector.remove(offense.source_range) } end

实践案例：创建自定义检查器

步骤 1：创建 Linter 文件

在lib/erb_lint/linters/目录下创建custom_linter.rb文件：

module ERBLint module Linters class CustomLinter < Linter class ConfigSchema < LinterConfig property :forbidden_words, default: [], accepts: Array end def run(processed_source) processed_source.each_line.with_index(1) do |line, line_num| config.forbidden_words.each do |word| if line.include?(word) add_offense( "避免使用禁用词汇: #{word}", line: line_num, source_range: processed_source.source_range(line_num, line.index(word), word.length) ) end end end end end end end

步骤 2：配置与使用

在项目配置文件中启用自定义检查器：

linters: CustomLinter: enabled: true forbidden_words: ["foo", "bar"]

插件生态系统最佳实践

保持检查器专注单一职责

每个 Linter 应专注于单一检查功能，如FinalNewline仅检查文件末尾是否有换行符，TrailingWhitespace专注于行尾空格检查。

提供清晰的错误信息

良好的错误信息应包含问题描述和修复建议，如AllowedScriptType检查器提供明确的脚本类型限制提示。

编写测试用例

所有检查器都应有对应的测试，测试文件位于spec/erb_lint/linters/目录，如space_around_erb_tag_spec.rb对应SpaceAroundErbTag检查器的测试。

总结：构建个性化代码检查体系

ERB Lint 的插件生态系统为开发者提供了强大的扩展能力，通过本文介绍的方法，你可以构建符合项目需求的代码检查规则。无论是简单的自定义检查还是复杂的集成工具，ERB Lint 的灵活架构都能满足你的需求。

开始使用 ERB Lint，打造高质量的 ERB 和 HTML 代码库吧！你可以通过以下命令获取项目：

git clone https://gitcode.com/gh_mirrors/er/erb-lint

探索lib/erb_lint/linters/目录下的现有实现，获取更多自定义 Linter 的灵感和参考。

【免费下载链接】erb-lintLint your ERB or HTML files项目地址: https://gitcode.com/gh_mirrors/er/erb-lint