Intellij Ideaを使用したJavaプロジェクトでのJenkinsfile構文の強調表示

私たちはすでに以下にリストされているアプローチを試しました：

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

何日にもわたって何時間もウェブを検索した後も、この問題に関する有用なリソースは見つかりませんでした。したがって、ここで新しい質問をすることは理にかなっているようです。

IntelliJのアイデアでJavaプロジェクトを開発しており、ビルドをJenkinsと統合したいと考えています。IdeaでJenkinsfileを作成する場合、構文の強調表示や自動補完は行われません。私たちはJenkinsを初めて使用するので、これらの機能は私たちにとって非常に役立ちます。Jenkinsfilesを使用してIdeaのサポートを強化するにはどうすればよいですか？

Jenkinsfileの構文の強調表示とオートコンプリートを取得する方法がない場合、他にどのエディタが役に立ちますか？

ご注意ください：

• 私たちはGroovyプロジェクトではなく、Javaプロジェクトで作業しています。

• プラグインhttps://github.com/oliverlockwood/jenkinsfile-idea-pluginをすでに試しました。プラグインがアクティブ化されると、Jenkinsfileはそのように認識されますが、構文の強調表示の代わりにエラーメッセージが表示されます。以下を参照してください。

  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での例は次のようになります（Draculaテーマを使用）。

したがって、IDEAは構文の強調表示と自動補完を提供します。作成中に既存の関数/メソッド名を提案しますが、私はGroovy開発者ではないため、いくつかの提案が欠落しているかどうかはわかりません。

別のオプションは、このようにJenkinsfileの上にシャバンを使用すること#!/usr/bin/env groovyです。また、あなたが試してみることができGDSL：https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij これまでのところ、それは宣言型のパイプラインをサポートしていません：HTTPS：//issues.jenkins-ci .org / browse / JENKINS-40127

IntelliJからのフィードバックは以下のとおりです。実用的なソリューションを提供できる場合は、これについてフォローアップします。

Andrey Dernov、IntelliJ、12月14日07:50 CET

こんにちはGeorg、IDEでJenkinsfilesを編集するための特別なエディターインテリセンスサポートはありません。このためのカスタム言語プラグインを作成する必要があります。

または、Kotlin DSLを作成して、このようなサポートの実装を検討することもできます。最初にいくつかの例を示します。

ソースコードを見ると、コメントが定義されていないようです（コード内でコメント化されています）。

STEP_KEYは、STEP_NAME = "sh" |として定義されています。"平行"

プラグインがもっと多くのことをしているとは思いませんし、2年間更新されていません。

追加した場合

#!groovy​

jenkinsfileにヘッダーを追加すると、IDEでGroovy構文が強調表示されます。

shこのように使用すると、エラーは解消されます（私にとってはうまくいきました）...

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