Jenkinsfile syntax highlighting in Java project using Intellij Idea

Question

We already tried the approaches as listed below:

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

After having searched the web for many hours on multiple days, we still haven't found a helpful resource on this matter. Thus, it appears to make sense to ask a new question here.

We are developing our Java projects in IntelliJ idea and want to integrate our builds with Jenkins. When we create a Jenkinsfile in Idea, we do not get syntax highlighting or auto completion. Since we are new to Jenkins, those features would be really useful to us. How can we make Idea be more supportive with Jenkinsfiles?

If there is no way to get syntax highlighting and auto completion for a Jenkinsfile in idea, what other editors would be helpful?

Please note:

• we are working with java projects, not groovy projects.

• We've already tried the plugin https://github.com/oliverlockwood/jenkinsfile-idea-plugin. When the plugin is activated, the Jenkinsfile is recognized as such, but instead of syntax highlighting we get an error message, please see below.

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

Idea highlights the p of pipeline as error. The error message reads:

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

Thanks for any help!

Solution 1

At long last we found a solution that works for us and provides syntax highlighting and code completion for the Jenkinsfile present in an otherwise normal Java project in Idea. The solution is taken from here, here (and from additional personal experiments / research)

1. Download the Groovy SDK (if you did not do so already) from the Groovy Page and configure it on your Java project. For help on this see here

2. Download the pipeline GDSL file from your Jenkins instance which should be available under a link like https://yourJenkinsInstance.tld/pipeline-syntax/gdsl, and add it to the classpath of your Java project. E.g. by creating a new folder src/main/jenkins, putting the pipeline gdsl file there and marking the folder as source root in IntelliJ Idea

3. Add "Jenkinsfile" as a valid file name pattern for groovy files as described here

4. To avoid the error message 'node' cannot be applied to '(groovy.lang.Closure<java.lang.Object>), you can add this line at the top of your Jenkinsfile:

   // noinspection GroovyAssignabilityCheck

Solution 2

If you want IDEA to recognize a Jenkinsfile as a Groovy file, then you can add the String "Jenkinsfile" as a valid file name pattern (normally contains file endings) for Groovy files. This is supported "out of the box" without requiring any additional Plugin (except the "Groovy" Plugin, but that is already part of IDEA).

To do that go to the settings menu, open the "Editor" item and then "File Types". Now select "Groovy" in the upper list and add "Jenkinsfile". You can also use a regex like "Jenkinsfile*" if you want to be more flexible regarding an optional file ending for the Jenkinsfile.
The setting should now look like this:

Your example now looks like this in IDEA (with the Dracula theme):

So IDEA now provides syntax highlighting and auto completion as far as I can tell. It suggests existing function/method names while writing, but I'm not a Groovy developer, thus I can't tell if some suggestions are missing.

Solution 3

Another option is to use a shabang on top of the Jenkinsfile like this #!/usr/bin/env groovy. Also you can try out gdsl: https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij but so far it doesn't support declarative pipelines: https://issues.jenkins-ci.org/browse/JENKINS-40127

Solution 4

If you add

#!groovy​

header to your jenkinsfile then you should get groovy syntax highlighting in IDE.

Solution 5

Looking at the source code, it looks like COMMENTS are not defined (they are commented out in the code)

The STEP_KEY is defined as: STEP_NAME="sh" | "parallel"

I'm not sure the plugin does much more and it hasn't been updated in 2 years.

View more solutions

Comments

[y.bedrov]

There is a custom plugin: plugins.jetbrains.com/plugin/10127-jenkinsfile-idea-plugin and feature request: youtrack.jetbrains.com/issue/IDEA-158104

[rexford]

@y.bedrov thanks for your comment. We already had tried the stated plugin, but only got an error message, but no syntax highlighting or auto completion. What's your experience with the plugin, does it work for you?

[Tom]

I have no idea why you would need a plugin for this basic stuff. Just add "Jenkinsfile" as a file type for Groovy (Settings > Editor > File Types > Groovy and add "Jenkinsfile" as a "Registered Pattern"). What's missing after that setup?

[rexford]

@Tom thanks! Actually, your comment is about what we were looking for. Please provide this information as an answer, and I will accept it as correct / most helpful answer.

[OrangeDog]

@Tom What's missing is autocompletion and validation of the actual Jenkins DSL

[Tom]

@OrangeDog That's interesting and I assume you would then really need a plugin to get these features. Can you please add this comment under my answer as well? It would be more visible for people reading my answer. Thank you for this information.

[OrangeDog]

Features that people would want include validation/autocompletion/quickdocs for the GDSL and integration of the linter. An ideal plugin would make everything "just work" with minimal configuration (e.g. just point it at a Jenkins instance).

[Ming]

Just a note, the groovy file type is only available in InteliJ and Android studio, not in PyCharm 2018.3.2. I think because this plugin is required plugins.jetbrains.com/plugin/1524-jetgroovy

[Stephan]

Also consider downloading the gdsl file from your Jenkins instance at https://<Jenkins>/job/<Job Name>/pipeline-syntax/gdsl and put them into the Groovy classpath of your project.

[owensmartin]

This is a nice idea but requires a Groovy SDK to be configured

[icfantv]

Brilliant! TY so much! I was able to reassign our Jenkinsfile.declarative files in the same manner so that we get both syntax highlighting and code completion. For us *.declarative was assigned to the Text file type.

[Tomer Gal]

In intellij it's not working and this answer is too vague in general

[Ales Dolecek]

Idea will recognize any file as Groovy if it contains shebang #!groovy on first line

[vahidzolf]

worked for Pycharm 2022.1.2 professional !! thanks