### 开发Sonar的JavaScript插件流程
#### 一、概览
Sonar是一个广泛使用的代码质量管理工具，它能够帮助开发者发现代码中的问题并提供改进措施。为了更好地满足项目需求，有时我们需要为Sonar开发自定义插件。本文档旨在详细介绍如何在Sonar中开发JavaScript插件，并特别关注其开发过程中的关键步骤。
#### 二、核心概念
1. **`pom.xml`中的`pluginKey`**：在`pom.xml`文件中定义的`pluginKey`用于唯一标识该插件，例如：`<pluginKey>rule01</pluginKey>`。
2. **规则定义里的`repositoryKey`**：规则定义中的`repositoryKey`需要与描述该规则的HTML文档名保持一致，这对于确保规则在Sonar界面中被正确显示至关重要。
#### 三、开发步骤详解
##### 1. 创建Maven项目并配置`pom.xml`
- **创建Maven项目**：首先通过IDE或其他工具创建一个新的Maven项目。
- **配置`pom.xml`**：在`pom.xml`中添加必要的配置来表明这是一个Sonar插件：
```xml
<packaging>sonar-plugin</packaging>
```
- 指定`pluginClass`，即规则主类：
```xml
<pluginClass>org.sonar.myrule.SonarPluginDeclare</pluginClass>
```
- 定义`pluginKey`作为规则的代号：
```xml
<pluginKey>rule01</pluginKey>
```
##### 2. 构建项目结构与类
- **项目结构**：在`src/main/java`目录下创建与`pluginClass`对应的包结构，例如：`org.sonar.myrule`。
- **构建核心类**：
- **`SonarPluginDeclare`类**：标记整个插件为Sonar插件。
- **`JavaScriptPluginDeclare`类**：标记规则为JavaScript插件。
- **`RuleContent`类**：具体定义规则内容。
这些类需要继承相应的接口或抽象类：
- `SonarPluginDeclare`继承`SonarPlugin`。
- `JavaScriptPluginDeclare`继承`CustomJavaScriptRulesDefinition`。
- `RuleContent`继承`BaseTreeVisitor`。
##### 3. 联系各部分
- 在`SonarPluginDeclare`类中的`getExtensions`方法内返回`JavaScriptPluginDeclare`类实例，以明确该插件属于JavaScript类型。
- 配置规则的`repositoryKey`和`repositoryName`，如：
```java
String repositoryKey = "JavaScriptRule1";
String repositoryName = "MyRule1";
```
这些值将在规则的详细说明中显示。
- 将`RuleContent`类实例通过`checkClasses`方法返回，以完成规则的定义。
##### 4. 定义规则
- 在`RuleContent`类中使用注解定义规则细节，例如：
```java
@Rule(
key = "description1",
priority = Priority.MAJOR,
name = "forbiddenwritefunction",
tags = {"security"})
@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.DATA_RELIABILITY)
@SqaleConstantRemediation("5min")
public void visitCallExpression(CallExpressionTree tree) {
super.visitCallExpression(tree);
}
```
这里定义了规则的键、优先级、名称以及标签等属性。
##### 5. 编写规则说明文档
- 创建描述规则的HTML文档（如`description1.html`），并放置于`src/resources/org/sonar/l10n/javascript/rules/<repositoryKey>`目录下。
##### 6. 打包与部署
- 使用Maven打包项目为JAR文件，并将其放置到Sonar服务器的`extensions/plugins`目录下。
- 重启Sonar服务。
#### 四、注意事项
1. **`pom.xml`配置**：确保`pom.xml`中的`pluginClass`正确无误，避免出现类型转换异常。
2. **规则说明文档格式**：规则说明文档必须采用HTML格式，否则会导致异常。
通过遵循以上步骤，可以有效地为Sonar开发定制化的JavaScript插件，进一步提高代码质量控制的灵活性和针对性。
