Jenkinsfile提交遇groovy-lint提示，添加@CompileStatic报错求解

提交Jenkinsfile变更时，groovy-lint弹出提示：

Class should be marked with one of @GrailsCompileStatic, @CompileStatic or @CompileDynamic CompileStatic

我试着加了import groovy.transform.CompileStatic，还给pipeline块标了@CompileStatic，结果直接报语法错：

Unexpected input: '{' @ line 4, column 10. NglParseError

当前的pre-commit hook配置是这样的：

- repo: https://github.com/nvuillam/npm-groovy-lint
  rev: v14.6.0
  hooks:
  -   id: npm-groovy-lint
      args: [--fix]
      files: '(Jenkinsfile|.*\.jenkins)$'

需求是：不修改pre-commit hook的info级别忽略设置，把这个提示消掉。

可行的解决办法 #

1. 把Pipeline逻辑封装到带注解的类里 #

Jenkinsfile顶层的pipeline是DSL语法，不能直接套@CompileStatic注解。你可以把核心的构建逻辑抽出来，放到一个单独的Groovy类里，给这个类加上@CompileStatic，然后在Jenkinsfile里调用它：

• 先建个工具类，比如PipelineUtils.groovy：

import groovy.transform.CompileStatic

@CompileStatic
class PipelineUtils {
    static def runBuild() {
        // 把原来pipeline里的步骤都移到这里
        echo "开始构建"
        // 其他构建、测试、部署逻辑...
    }
}

• 然后修改Jenkinsfile：

import PipelineUtils

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    PipelineUtils.runBuild()
                }
            }
        }
    }
}

这样groovy-lint会检测到带注解的类，不会再弹提示，同时Jenkins的DSL也能正常跑。

2. 给groovy-lint加规则配置，跳过Jenkinsfile的检查 #

在项目根目录建一个.groovylintrc.json文件，专门针对Jenkinsfile禁用CompileStatic规则：

{
  "rules": {
    "CompileStatic": {
      "excludeFiles": ["Jenkinsfile", "*.jenkins"]
    }
  }
}

这个配置会让groovy-lint自动跳过对Jenkinsfile的这个规则检查，不用改pre-commit hook的级别，直接就能消掉提示。

3. 加@CompileDynamic注解（不推荐但能用） #

如果不想抽逻辑，也可以在Jenkinsfile最顶部加@CompileDynamic注解（注意是加在整个脚本最前面，不是pipeline块上）：

import groovy.transform.CompileDynamic

@CompileDynamic
pipeline {
    agent any
    // 你的pipeline内容...
}

这个注解会告诉Groovy用动态编译处理整个脚本，groovy-lint就不会再提示了，但代价是失去静态编译的类型检查优势。

内容的提问来源于stack exchange，提问作者Fergus Johnson