使用Intellij Idea在Java项目中突出显示Jenkins文件语法

Question

我们已经尝试了以下方法：

• https://github.com/oliverlockwood/jenkinsfile-idea-plugin
• https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij

在网上搜索了好几天好几个小时后，我们仍然没有找到关于这个问题的有用资源。因此，在这里提出一个新问题似乎是有道理的。

我们正在IntelliJ idea中开发Java项目，并希望将我们的构建与Jenkins集成。在Idea中创建Jenkins文件时，不会得到语法高亮显示或自动完成。由于我们是詹金斯的新手，这些功能对我们来说真的很有用。我们怎样才能让Idea更支持詹金斯档案？

如果在idea中无法获得Jenkins文件的语法高亮显示和自动完成，那么其他哪些编辑器会有所帮助？

请注意：

>

我们使用的是java项目，而不是groovy项目。

我们已经尝试了插件https://github.com/oliverlockwood/jenkinsfile-idea-plugin.当插件被激活时，Jenkinsfile被识别为这样，但是我们得到的不是语法高亮显示，而是错误消息，请参见下面。

 pipeline {
 agent { docker 'maven:3.3.3' }
 stages {
     stage('build') {
         steps {
             sh 'echo Hello, World!'
         }
     }
   }
 }

Idea将管道的p突出显示为错误。错误消息如下：

JenkinsTokenType.COMMENT, JenkinsTokenType.CRLF or JenkinsTokenType.STEP_KEY expected, got 'p'

感谢任何帮助！




Answer 1

另一个选择是在Jenkinsfile上面使用shaang，就像这样#！/usr/bin/envgroovy。你也可以尝试gdsl：https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij但是到目前为止它不支持声明式管道：https://issues.jenkins-ci.org/browse/JENKINS-40127

Answer 2

最后，我们找到了一个适合我们的解决方案，并为idea中正常Java项目中的Jenkinsfile提供语法突出显示和代码完成。解决方案取自这里，这里（以及额外的个人实验/研究）

>

从Jenkins实例下载pipeline GDSL文件，该文件应该可以通过以下链接获得：https://yourJenkinsInstance.tld/pipeline-syntax/gdsl，并将其添加到Java项目的类路径中。例如，通过创建一个新文件夹src/main/jenkins，将管道gdsl文件放在那里，并在IntelliJ Idea中将该文件夹标记为源根目录

添加"Jenkinsfile"作为groovy文件的有效文件名模式，如下所述

为了避免错误消息，“节点”不能应用于“（groovy.lang.Closure）

//无检查功能检查

Answer 3

如果您希望IDEA将Jenkinsfile识别为Groovy文件，那么您可以添加字符串Jenkinsfile作为Groovy文件的有效文件名模式（通常包含文件结尾）。这是支持开箱即用的，不需要任何额外的插件（除了Groovy插件，但它已经是IDEA的一部分）。

据我所知，IDEA现在提供了语法高亮显示和自动完成。它在编写时建议现有的函数/方法名称，但我不是Groovy开发人员，因此我无法判断是否缺少一些建议。