How to format Jenkinsfile locally?

Question

I want to format Jenkinsfile locally and understand if they are any formatting issues. I use sublime editor for editing. Is there a better editor which can also suggest me any formatting errors? I do not want to use any online formatting tools.

Brinton

You can use Visual Studio Code with the Jenkins Pipeline Linter Connector plugin to format as well as validate Jenkinsfile locally from within VS Code. – Nonfeasance

I tried this out and very good with the linting, I however cannot see how to use it to format the jenkinsfile – Mooch

Answer 1

IntelliJ can be configured to parse Jenkinsfile as a regular Groovy file, as explained in this question or this article. This allows to use standard Groovy formatting and syntax check.

However, you might want to consider using Replay Pipeline functionality in your Jenkins instance instead.

Langill

Answer 2

I use VSCode and a Jenkinsfile. In order to format it, I use a popular Groovy code formatter extension, but first I must rename the Jenkinsfile to Jenkinsfile.groovy. I reformat it, then save it back to the original filename (without the .groovy extension).

Palaestra