@boyingliu01/xp-gate 0.8.1 → 0.8.2

package/adapters/java.sh

@@ -9,7 +9,7 @@ _is_whalecloud_enabled() {
   # Check if whalecloud-java plugin is enabled
   [ -d "$WHALECLOUD_PLUGIN_DIR" ] && \
     ([ -f "config/pmd/whalecloud-ruleset.xml" ] || \
-     grep -q 'xp-gate-whalecloud-java\|xp-gateWhalecloudCheck' pom.xml build.gradle build.gradle.kts 2>/dev/null)
+     grep -q 'xp-gate-whalecloud-java\|xpGateWhalecloudCheck' pom.xml build.gradle build.gradle.kts 2>/dev/null)
 }
 
 _detect_java_build() {

package/adapters/plugins/book299-20132-python/README.md

@@ -0,0 +1,21 @@
+# book299-20132-python
+
+Auto-generated plugin from spec document.
+
+## Source
+- **Spec file**: book299-20132-Python语言编码规范.txt
+- **Language**: python
+- **Generated**: 2026-05-13
+- **Rule count**: 73
+
+## Installation
+
+### Maven
+```bash
+bash githooks/adapters/plugins/scripts/install-maven.sh
+```
+
+### Gradle
+```bash
+bash githooks/adapters/plugins/scripts/install-gradle.sh
+```

package/adapters/plugins/book299-20132-python/plugin.yml

@@ -0,0 +1,21 @@
+---
+id: book299-20132-python
+name: book299-20132-python
+version: 1.0.0
+languages: [python]
+description: |
+  Auto-generated plugin from spec document: book299-20132-Python语言编码规范.txt
+  Generated by xp-gate init on 2026-05-13.
+source_file: book299-20132-Python语言编码规范.txt
+severity: error
+categories:
+  - wc-style: Coding style rules
+  - wc-security: Security rules
+  - wc-performance: Performance rules
+maven:
+  profile: xp-gate-book299-20132-python
+  profile_file: templates/maven/xp-gate-book299-20132-python-profile.xml
+  install_script: scripts/install-maven.sh
+gradle:
+  config_file: templates/gradle/xp-gate-book299-20132-python.gradle
+  install_script: scripts/install-gradle.sh

package/adapters/plugins/book299-20132-python/rules/exception/gen-0023.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0023
+name: 由于异常实际上也是类，因此类命名的约定也适用与异常。不同的是，如果异常实际上是抛出错误的话，异常名后应该加上“Error”的后缀。
+severity: warning
+tool: auto
+category: wc-exception
+description: |
+  由于异常实际上也是类，因此类命名的约定也适用与异常。不同的是，如果异常实际上是抛出错误的话，异常名后应该加上“Error”的后缀。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/logging/gen-0071.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0071
+name: 推荐使用logging而非print打印日志，logging的优点是：
+severity: warning
+tool: auto
+category: wc-logging
+description: |
+  推荐使用logging而非print打印日志，logging的优点是：
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0001.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0001
+name: 名字应该能够标识事物的特性，并且与业务挂钩。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  名字应该能够标识事物的特性，并且与业务挂钩。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0002.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0002
+name: 名字应该使用英文单词，而不能为拼音。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  名字应该使用英文单词，而不能为拼音。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0003.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0003
+name: 名字可以有两个或三个单词组成，但不应多于 4 个，控制在 3 至 30个字母以内。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  名字可以有两个或三个单词组成，但不应多于 4 个，控制在 3 至 30个字母以内。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0004.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0004
+name: 命名不能和关键字冲突。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  命名不能和关键字冲突。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0005.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0005
+name: 包命名采用全小写命名。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  包命名采用全小写命名。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0006.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0006
+name: 通过功能命名。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  通过功能命名。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0007.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0007
+name: 模块命名应短小，并且全为小写，如果需要多单词增加可读性，使用下划线进行拼接。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  模块命名应短小，并且全为小写，如果需要多单词增加可读性，使用下划线进行拼接。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0008.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0008
+name: 类命名采用驼峰命名约定，大写字母开头，各个单词首字母大写。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  类命名采用驼峰命名约定，大写字母开头，各个单词首字母大写。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0009.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0009
+name: Activity、Fragment、Service 等命名必须以 Activity、Fragment、Service相应后缀结束。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  Activity、Fragment、Service 等命名必须以 Activity、Fragment、Service相应后缀结束。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0010.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0010
+name: 当接口已有文档说明且主要是被用作调用时，也可以使用函数的命名约定。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  当接口已有文档说明且主要是被用作调用时，也可以使用函数的命名约定。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0011.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0011
+name: 函数命名都是小写，必要时使用下划线连接各单词提高可读性。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  函数命名都是小写，必要时使用下划线连接各单词提高可读性。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0012.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0012
+name: 只有当已有代码风格已经是混合大小写时，为了保留向后兼容性才使用混合大小写。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  只有当已有代码风格已经是混合大小写时，为了保留向后兼容性才使用混合大小写。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0013.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0013
+name: 用单下划线(_)开头表示模块函数是 protected 的。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  用单下划线(_)开头表示模块函数是 protected 的。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0014.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0014
+name: 用双下划线(__)开头的实例方法表示类内私有。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  用双下划线(__)开头的实例方法表示类内私有。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0015.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0015
+name: 变量命都是小写，多单词使用下划线连接。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  变量命都是小写，多单词使用下划线连接。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0016.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0016
+name: 类型变量名称通常应使用简短的驼峰命名，建议将后缀_co 或_contra 添加到用于声明相应的协变和逆变的行为。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  类型变量名称通常应使用简短的驼峰命名，建议将后缀_co 或_contra 添加到用于声明相应的协变和逆变的行为。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0017.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0017
+name: 类型变量的定义统一放在 import 之后。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  类型变量的定义统一放在 import 之后。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0018.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0018
+name: 类变量统一放在类注释的之后，所有类函数的之前。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  类变量统一放在类注释的之后，所有类函数的之前。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0019.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0019
+name: 全局变量：适用于函数的命名规范。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  全局变量：适用于函数的命名规范。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0020.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0020
+name: 用单下划线(_)开头表示模块变量是 protected 的。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  用单下划线(_)开头表示模块变量是 protected 的。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0021.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0021
+name: 用双下划线(__)开头的实例变量表示类内私有。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  用双下划线(__)开头的实例变量表示类内私有。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0022.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0022
+name: 全部使用大写并且下划线将单词分开。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  全部使用大写并且下划线将单词分开。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0024.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0024
+name: 一般情况下源程序的有效注释量必须在 30%以上。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  一般情况下源程序的有效注释量必须在 30%以上。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0025.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0025
+name: 避免使用装饰性内容，保持注释的简洁。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  避免使用装饰性内容，保持注释的简洁。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0026.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0026
+name: 注释信息不仅要包括代码的功能，还应给出原因，不要为注释而注释。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  注释信息不仅要包括代码的功能，还应给出原因，不要为注释而注释。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0027.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0027
+name: 注释不能嵌套。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  注释不能嵌套。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0028.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0028
+name: 避免使用行尾注释。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  避免使用行尾注释。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0029.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0029
+name: 生成开发文档的需要用中文编写。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  生成开发文档的需要用中文编写。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0030.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0030
+name: 如果需要注释的内容太多，需附加文档进行说明，注释时加上"参见《****》"。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  如果需要注释的内容太多，需附加文档进行说明，注释时加上"参见《****》"。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0031.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0031
+name: 复杂的分支流程必须注释。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  复杂的分支流程必须注释。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0032.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0032
+name: 代码质量不高但能正常运行，或者还没有实现的代码用# TODO:声明。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  代码质量不高但能正常运行，或者还没有实现的代码用# TODO:声明。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0033.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0033
+name: 可以根据[PEP-484]对Python3代码进行类型注释,并且在build时用类型检查工具例如[pytype]进行类型检查。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  可以根据[PEP-484]对Python3代码进行类型注释,并且在build时用类型检查工具例如[pytype]进行类型检查。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0034.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0034
+name: 存在错误隐患的代码用# FIXME:声明。
+severity: info
+tool: auto
+category: wc-style
+description: |
+  存在错误隐患的代码用# FIXME:声明。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0035.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0035
+name: 采用文档字符串的形式进行注释（三个双引号的形式）。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  采用文档字符串的形式进行注释（三个双引号的形式）。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0036.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0036
+name: 应该包含如下：
+severity: info
+tool: auto
+category: wc-style
+description: |
+  应该包含如下：
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0037.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0037
+name: 类应该在其定义下有一个用于描述该类的文档字符串。
+severity: error
+tool: auto
+category: wc-style
+description: |
+  类应该在其定义下有一个用于描述该类的文档字符串。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO

package/adapters/plugins/book299-20132-python/rules/style/gen-0038.yml

@@ -0,0 +1,14 @@
+---
+id: GEN-0038
+name: 如果你的类有公共属性(Attributes)，那么文档中应该有一个属性(Attributes)段。并且应该遵守和函数参数相同的格式。
+severity: warning
+tool: auto
+category: wc-style
+description: |
+  如果你的类有公共属性(Attributes)，那么文档中应该有一个属性(Attributes)段。并且应该遵守和函数参数相同的格式。
+
+  Auto-extracted from book299-20132-Python语言编码规范.txt.
+
+check:
+  type: ast-grep
+  pattern: TODO