Виділення синтаксису Jenkinsfile в проекті Java за допомогою Intellij Idea

Ми вже випробували підходи, перелічені нижче:

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

Після багатогодинного пошуку в Інтернеті протягом кількох днів, ми все ще не знайшли корисного ресурсу з цього питання. Таким чином, мабуть, є сенс задавати тут нове запитання.

Ми розробляємо наші проекти Java в ідеї IntelliJ і хочемо інтегрувати свої конструкції з Jenkins. Коли ми створюємо файл Jenkins у Idea, ми не отримуємо підсвічування синтаксису або автоматичне заповнення. Оскільки ми новачок у Дженнінкі, ці функції були б нам дуже корисні. Як ми можемо зробити Ідею більш прихильною для Jenkinsfiles?

Якщо немає можливості отримати виділення синтаксису та автоматичне заповнення для файлу Jenkins, які інші редактори були б корисними?

Будь ласка, запиши:

• ми працюємо з Java-проектами, а не з груві-проектами.

• Ми вже випробували плагін https://github.com/oliverlockwood/jenkinsfile-idea-plugin . Коли плагін активовано, файл Jenkins розпізнається як такий, але замість підсвічування синтаксису ми отримуємо повідомлення про помилку, див. Нижче.

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

  Ідея виділяє "p" "трубопроводу" як помилку. Повідомлення про помилку звучить так:

  JenkinsTokenType.COMMENT, JenkinsTokenType.CRLF або JenkinsTokenType.STEP_KEY очікували, отримали 'p'

Дякуємо за будь-яку допомогу!

Якщо ви хочете, щоб IDEA розпізнавала Jenkinsfile як файл Groovy, тоді ви можете додати рядок "Jenkinsfile" як дійсний шаблон імені файлу (як правило, містить закінчення файлу) для файлів Groovy. Це підтримується "поза коробкою", не вимагаючи додаткового плагіна (крім плагіну "Groovy", але це вже є частиною IDEA).

Для цього перейдіть до меню налаштувань, відкрийте пункт «Редактор», а потім «Типи файлів». Тепер виберіть "Groovy" у верхньому списку та додайте "Jenkinsfile". Ви також можете використовувати регулярний вираз, наприклад "Jenkinsfile *", якщо ви хочете бути більш гнучкими щодо необов'язкового файлу, що закінчується для Jenkinsfile.
Налаштування тепер має виглядати так:

Тепер ваш приклад виглядає так в IDEA (з темою Дракула):

Отже, IDEA тепер забезпечує виділення синтаксису та автоматичне заповнення, наскільки я можу зрозуміти. Він пропонує існуючі назви функцій / методів під час написання, але я не розробник Groovy, тому я не можу сказати, чи відсутні якісь пропозиції.

Іншим варіантом є використання шабангу поверх Дженкінсфілла, як це #!/usr/bin/env groovy. Також ви можете спробувати gdsl: https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij, але поки що він не підтримує декларативні конвеєри: https: //issues.jenkins-ci .org / переглядати / JENKINS-40127

Нижче наведено відгуки від IntelliJ . Ми будемо продовжувати цю роботу, якщо зможемо запропонувати робоче рішення.

Андрій Дернов, IntelliJ, 14 грудня, 07:50 CET

Привіт Георге, у редакторі IDE немає спеціальної підтримки для редагування Jenkinsfiles у редакторі Jenkinsfiles. Для цього вам потрібно буде написати власний мовний плагін.

Або ви можете розглянути можливість застосування такої підтримки, написавши DSL Kotlin. Кілька прикладів для початку.

Дивлячись на вихідний код, здається, КОМЕНТАРИ не визначені (вони коментуються в коді)

STEP_KEY визначається як: STEP_NAME = "sh" | "паралельний"

Я не впевнений, що плагін робить набагато більше, і він не оновлювався протягом 2 років.

Якщо додати

#!groovy​

заголовка до вашого jenkinsfile, тоді ви повинні отримати бурхливе підсвічування синтаксису в IDE.

Використовуйте shтак, і помилка повинна піти (працював для мене) ...

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