Evidenziazione della sintassi del file Jenkins nel progetto Java utilizzando Intellij Idea

Abbiamo già provato gli approcci elencati di seguito:

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

Dopo aver cercato sul Web per molte ore in più giorni, non abbiamo ancora trovato una risorsa utile su questo argomento. Quindi, sembra avere senso porre una nuova domanda qui.

Stiamo sviluppando i nostri progetti Java secondo l'idea di IntelliJ e vogliamo integrare le nostre build con Jenkins. Quando creiamo un file Jenkins in Idea, non otteniamo l'evidenziazione della sintassi o il completamento automatico. Dato che siamo nuovi a Jenkins, queste funzionalità ci sarebbero davvero utili. Come possiamo rendere Idea più solidale con Jenkinsfiles?

Se non è possibile ottenere l'evidenziazione della sintassi e il completamento automatico per un file Jenkins, quali altri editor sarebbero utili?

Notare che:

• stiamo lavorando con progetti java, non progetti fantastici.

• Abbiamo già provato il plugin https://github.com/oliverlockwood/jenkinsfile-idea-plugin . Quando il plugin è attivato, il file Jenkins viene riconosciuto come tale, ma invece di evidenziare la sintassi viene visualizzato un messaggio di errore, vedere di seguito.

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

  L'idea evidenzia come errore la "p" di "pipeline". Il messaggio di errore legge:

  JenkinsTokenType.COMMENT, JenkinsTokenType.CRLF o JenkinsTokenType.STEP_KEY previsto, ottenuto "p"

Grazie per qualsiasi aiuto!

Se vuoi che IDEA riconosca un file Jenkins come file Groovy, puoi aggiungere la stringa "Jenkinsfile" come modello di nome file valido (normalmente contiene terminazioni di file) per i file Groovy. Questo è supportato "out of the box" senza richiedere alcun plug-in aggiuntivo (tranne il plug-in "Groovy", ma che fa già parte di IDEA).

Per farlo vai nel menu delle impostazioni, apri la voce "Editor" e poi "Tipi di file". Ora seleziona "Groovy" nell'elenco in alto e aggiungi "Jenkinsfile". Puoi anche usare un'espressione regolare come "Jenkinsfile *" se vuoi essere più flessibile riguardo a un file opzionale che termina per il Jenkinsfile.
L'impostazione dovrebbe ora assomigliare a questa:

Il tuo esempio ora ha questo aspetto in IDEA (con il tema Dracula):

Quindi IDEA ora fornisce l'evidenziazione della sintassi e il completamento automatico per quanto ne so. Suggerisce nomi di funzioni / metodi esistenti durante la scrittura, ma non sono uno sviluppatore Groovy, quindi non posso dire se mancano alcuni suggerimenti.

Un'altra opzione è usare uno shabang sopra il file Jenkins in questo modo #!/usr/bin/env groovy. Inoltre puoi provare gdsl: https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij ma finora non supporta pipeline dichiarative: https: //issues.jenkins-ci .org / browse / JENKINS-40127

Di seguito è riportato il feedback che abbiamo ricevuto da IntelliJ . Continueremo a farlo se saremo in grado di fornire una soluzione funzionante.

Andrey Dernov, IntelliJ, 14 dicembre, 07:50 CET

Ciao Georg, non esiste uno speciale supporto Editor intellisense per la modifica dei file Jenkins in IDE. Dovrai scrivere un plugin di lingua personalizzato per questo.

Oppure puoi prendere in considerazione l'implementazione di tale supporto scrivendo Kotlin DSL. Alcuni esempi con cui iniziare.

Guardando il codice sorgente, sembra che i COMMENTI non siano definiti (sono commentati nel codice)

STEP_KEY è definito come: STEP_NAME = "sh" | "parallelo"

Non sono sicuro che il plugin faccia molto di più e non sia stato aggiornato da 2 anni.

Se aggiungi

#!groovy​

intestazione al tuo jenkinsfile, dovresti ottenere una fantastica evidenziazione della sintassi in IDE.

Usa shcosì e l'errore dovrebbe scomparire (ha funzionato per me) ...

steps {
    sh """
        echo 'Hello, World!'
    """
}