如何为Jenkins声明式流水线自定义步骤实现参数代码补全功能

可行的实现方案 #

方案1：显式声明具名强类型参数（最简单适配）

直接替换原有的动态Map入参，在call方法中明确定义每个参数的类型和默认值，IDE可直接识别参数信息实现补全：

// vars/buildPlugin.groovy
// 明确定义每个参数的类型、默认值
def call(String name, String mvnGoal = 'install', String notifyMail = '') {
    node {
        git url: "https://github.com/jenkinsci/${name}-plugin.git"
        sh "mvn ${mvnGoal}"
        if (notifyMail) {
            mail to: notifyMail, subject: "${name} plugin build", body: '...'
        }
    }
}

调用方式和原有逻辑完全兼容，声明式流水线中可直接用具名参数传递：
buildPlugin name: 'git', notifyMail: 'admin@yourdomain.com'

方案2：参数实体类封装（适合参数较多的复杂场景）

在共享库的src目录下定义强类型参数POJO类，所有参数的类型、默认值都在类中明确定义，IDE可以识别类属性实现补全：

1. 首先创建参数类文件src/com/yourorg/BuildPluginConfig.groovy：

package com.yourorg
import groovy.transform.TupleConstructor

// 该注解支持直接用Map构造类实例，兼容原有传参方式
@TupleConstructor
class BuildPluginConfig {
    // 每个参数都明确定义类型，可设置默认值
    String name
    String mvnCommand = 'mvn install'
    String notifyReceiver
    Boolean skipTest = false
}

2. 改造自定义步骤的call方法，增加类参数适配：

// vars/buildPlugin.groovy
import com.yourorg.BuildPluginConfig

// 强类型参数入口，IDE可识别属性补全
def call(BuildPluginConfig config) {
    node {
        git url: "https://github.com/jenkinsci/${config.name}-plugin.git"
        sh config.skipTest ? "${config.mvnCommand} -DskipTests" : config.mvnCommand
        if (config.notifyReceiver) {
            mail to: config.notifyReceiver, subject: "${config.name} plugin build", body: '...'
        }
    }
}

// 重载方法兼容原有Map传参方式，无需修改旧流水线代码
def call(Map params) {
    call(new BuildPluginConfig(params))
}

方案3：补充GroovyDoc增强提示效果

在call方法、参数类的属性上方补充GroovyDoc注释，IDE补全时会同步显示参数说明，使用体验更友好：

/**
 * 构建Jenkins插件的自定义步骤
 * @param name 插件名称
 * @param mvnGoal Maven执行目标，默认install
 * @param notifyMail 构建结果通知邮箱，为空则不发送
 */
def call(String name, String mvnGoal = 'install', String notifyMail = '') {
    // 逻辑省略
}

声明式流水线兼容性说明 #

以上所有方案都完全兼容声明式流水线，不需要修改原有流水线的编写结构，调用方式和原自定义步骤保持一致。

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