TRAE IDE 规则设置概述
TRAE IDE（Textual Rule-based Analysis Engine IDE）是一个基于文本规则的代码分析工具，用于在开发过程中检测潜在问题或优化代码结构。规则设置是其核心功能之一，允许用户自定义检查逻辑。
规则文件通常以 .trae 或 .json 格式存储，包含规则名称、描述、匹配模式和执行动作等字段。
基本规则语法示例
以下是一个简单的规则示例，用于检测未使用的变量：
{
"name": "unused-variable",
"description": "Detects variables that are declared but never used",
"pattern": "(let|const|var)\\\\s+(\\\\w+)\\\\s*=",
"action": "warn"
}
正则表达式匹配规则
正则表达式是规则定义的核心部分。以下示例检测未闭合的 HTML 标签：
{
"name": "unclosed-html-tag",
"pattern": "<(\\\\w+)([^>]*)>(?!.*<\\\\/\\\\1>)",
"scope": ["html"],
"severity": "error"
}
上下文相关规则
更复杂的规则可能需要上下文分析。以下规则检测未处理的 Promise：
// .trae 规则文件
rule('unhandled-promise', {
pattern: /\\.then\\(/,
context: {
notFollowedBy: /\\.catch\\(|\\.finally\\(/
},
message: "Promise chain missing error handling"
});
多文件关联规则
某些规则需要跨文件分析。例如检测未导出的组件：
# 多文件规则示例
rule:
name: "unexported-component"
files:
include: "**/*.jsx"
condition:
– pattern: "function\\\\s+\\\\w+\\\\s*\\\\([^)]*\\\\)\\\\s*{"
– notFound: "export\\\\s+default\\\\s+\\\\w+"
severity: "warning"
自定义规则动作
除了简单的警告和错误，规则可以触发自定义修复操作：
# 修复未使用变量的示例规则
{
"name": "fix-unused-vars",
"pattern": "(var|let|const)\\\\s+(\\\\w+)\\\\s*=[^;]+;",
"action": {
"type": "replace",
"with": "// removed unused: $0",
"when": {
"references": "$2",
"count": 0
}
}
}
复杂逻辑规则示例
结合多种条件的复杂规则示例，检测可能的内存泄漏：
// 检测事件监听器未移除的规则
createRule({
id: "potential-memory-leak",
meta: {
docs: {
description: "Detect event listeners without removal"
}
},
pattern: [
{
match: ".addEventListener(",
capture: ["element", "event"]
},
{
notMatch: ".removeEventListener(",
usingSame: ["element", "event"]
}
],
message: "Potential memory leak: event listener added but not removed"
});
规则组合与继承
规则可以继承和组合其他规则：
{
"extends": "base-ruleset",
"rules": {
"no-console": {
"except": ["warn", "error"]
},
"custom-rule": {
"pattern": "specific-pattern",
"action": "custom-action"
}
}
}
性能优化规则
针对性能优化的规则示例，检测重复的 DOM 查询：
// 检测重复的DOM查询
interface PerformanceRule extends Rule {
name: "duplicate-dom-query";
pattern: string;
threshold: number;
}
const domQueryRule: PerformanceRule = {
name: "duplicate-dom-query",
pattern: "document.querySelector(\\\\s*['\\"].*?['\\"]\\\\s*)",
threshold: 3,
action: "suggest-caching"
};
规则测试方法
为规则编写测试用例的示例：
# 规则测试框架示例
def test_unused_var_rule():
rule = load_rule("unused-variable.trae")
test_cases = [
("var x = 5;", True), # 应触发
("let y = 10; console.log(y)", False) # 不应触发
]
for code, expected in test_cases:
assert rule.match(code) == expected
规则优先级设置
管理规则优先级的配置示例：
rule-priorities:
– name: security
level: 10
rules:
– sql-injection
– xss
– name: performance
level: 5
rules:
– duplicate-dom-query
– large-assets
IDE 集成配置
在开发环境中集成 TRAE 规则的配置示例：
// .vscode/settings.json
{
"trae.rules": [
"./rules/basic.trae",
"./team-rules/security.json"
],
"trae.autoFix": true,
"trae.ignorePatterns": [
"**/test/**",
"**/node_modules/**"
]
}
规则文档生成
为规则集自动生成文档的配置示例：
<!– rules/README.md –>
## 规则列表
| 名称 | 描述 | 严重性 |
|——|——|——–|
| unused-variable | 检测未使用的变量 | warning |
| unhandled-promise | 检测未处理的Promise | error |
规则调试技巧
调试复杂规则的实用方法：
// 启用调试模式
const debugRule = {
…originalRule,
debug: true,
onMatch: (match) => {
console.log('Rule matched:', match);
return originalAction;
}
};
规则性能分析
分析规则性能影响的配置：
performance-monitoring:
enabled: true
threshold-ms: 50
log-file: ./trae-perf.log
以上示例展示了 TRAE IDE 规则设置的多种应用场景和技术细节。实际使用时需要根据具体项目需求调整规则内容和严格程度。
