在tslint中检查region语句的最优方法是什么？是否有对应的walker？

嘿，好问题！很多维护TSLint项目的开发者都会遇到这个需求——规范代码里的//#region///#endregion块，避免出现未闭合的region或者多余的endregion。下面是具体的解决方案：

1. 核心方案：自定义规则+专属Walker #

TSLint本身并没有内置规则来校验region注释，但你可以通过自定义规则搭配AST Walker来实现这个功能——毕竟region本质是注释节点，我们可以通过遍历所有注释来做状态跟踪。

实现步骤： #

• 先创建一个自定义规则类，继承TSLint的Lint.Rules.AbstractRule
• 实现apply方法，返回一个自定义的Walker（继承Lint.RuleWalker）
• 在Walker中重写visitComment方法，用栈结构跟踪region的开闭状态：
  • 遇到//#region（支持带名称的情况，比如//#region Private Methods）就往栈里push一条记录
  • 遇到//#endregion时，如果栈为空，说明这是多余的endregion，抛出错误；否则从栈中pop一条记录
  • 遍历完所有节点后，如果栈不为空，说明存在未闭合的region，抛出错误
• 还可以额外扩展校验逻辑，比如要求region必须有名称、名称格式统一，或者禁止嵌套region等

示例代码片段： #

import * as Lint from "tslint";
import * as ts from "typescript";

export class Rule extends Lint.Rules.AbstractRule {
    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
        return this.applyWithWalker(new RegionWalker(sourceFile, this.getOptions()));
    }
}

class RegionWalker extends Lint.RuleWalker {
    private regionStack: string[] = [];

    visitComment(node: ts.CommentRange) {
        const commentText = node.getText().trim();
        
        // 匹配//#region（兼容带名称的写法）
        const regionMatch = commentText.match(/^\/\/#region\s*(.*)$/);
        if (regionMatch) {
            this.regionStack.push(regionMatch[1] || "unnamed");
            return;
        }

        // 匹配//#endregion（兼容带空格的写法）
        if (commentText.startsWith("// #endregion") || commentText.startsWith("//#endregion")) {
            if (this.regionStack.length === 0) {
                this.addFailureAt(
                    node.pos,
                    node.end - node.pos,
                    "发现无对应//#region的//#endregion"
                );
            } else {
                const regionName = this.regionStack.pop();
                // 可选：校验endregion是否和对应region的名称匹配
            }
        }

        super.visitComment(node);
    }

    // 遍历结束后检查未闭合的region
    walk(sourceFile: ts.SourceFile) {
        super.walk(sourceFile);
        if (this.regionStack.length > 0) {
            this.regionStack.forEach((regionName) => {
                this.addFailureAt(
                    0, // 可优化为定位到对应region的具体位置
                    0,
                    `存在未闭合的//#region：${regionName}`
                );
            });
        }
    }
}

2. 额外提示 #

如果是新项目，更推荐迁移到ESLint + typescript-eslint——因为TSLint已经被官方废弃，typescript-eslint生态里有现成的插件（比如eslint-plugin-region）可以直接使用，不用自己从零写规则。但如果是维护老项目必须用TSLint，上面的自定义Walker方案就是最灵活的最佳选择。

内容的提问来源于stack exchange，提问作者Violet Sigal Voronetzky