การเน้นไวยากรณ์ 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 เมื่อเราสร้าง Jenkinsfile ใน Idea เราจะไม่ได้รับการเน้นไวยากรณ์หรือการเติมข้อความอัตโนมัติ เนื่องจากเรายังใหม่กับ Jenkins คุณสมบัติเหล่านี้จะมีประโยชน์กับเรามาก เราจะทำให้ Idea สนับสนุน Jenkinsfiles มากขึ้นได้อย่างไร

หากไม่มีวิธีรับการเน้นไวยากรณ์และการเติมข้อความอัตโนมัติสำหรับ Jenkinsfile ในความคิดตัวแก้ไขอื่น ๆ จะเป็นประโยชน์อะไร

โปรดทราบ:

• เรากำลังทำงานกับโปรเจ็กต์ Java ไม่ใช่โปรเจ็กต์ที่น่าสนใจ

• เราได้พยายามแล้วปลั๊กอินhttps://github.com/oliverlockwood/jenkinsfile-idea-plugin เมื่อเปิดใช้งานปลั๊กอิน Jenkinsfile จะได้รับการยอมรับในลักษณะนี้ แต่แทนที่จะเน้นไวยากรณ์เราได้รับข้อความแสดงข้อผิดพลาดโปรดดูด้านล่าง

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

  Idea เน้นให้ 'p' ของ 'pipeline' เป็นข้อผิดพลาด ข้อความแสดงข้อผิดพลาดอ่าน:

  คาดว่าจะมี JenkinsTokenType.COMMENT, JenkinsTokenType.CRLF หรือ JenkinsTokenType.STEP_KEY มี 'p'

ขอบคุณสำหรับความช่วยเหลือ!

หากคุณต้องการให้ IDEA จดจำ Jenkinsfile เป็นไฟล์ Groovy คุณสามารถเพิ่ม String "Jenkinsfile" เป็นรูปแบบชื่อไฟล์ที่ถูกต้อง (โดยปกติจะมีนามสกุลไฟล์) สำหรับไฟล์ Groovy สิ่งนี้ได้รับการสนับสนุน "นอกกรอบ" โดยไม่ต้องใช้ Plugin เพิ่มเติมใด ๆ (ยกเว้นปลั๊กอิน "Groovy" แต่เป็นส่วนหนึ่งของ IDEA แล้ว)

โดยไปที่เมนูการตั้งค่าเปิดรายการ "ตัวแก้ไข" และ "ประเภทไฟล์" ตอนนี้เลือก "Groovy" ในรายการด้านบนและเพิ่ม "Jenkinsfile" คุณยังสามารถใช้ regex เช่น "Jenkinsfile *" ได้หากคุณต้องการยืดหยุ่นมากขึ้นเกี่ยวกับไฟล์เสริมที่ลงท้ายด้วย Jenkinsfile
การตั้งค่าควรมีลักษณะดังนี้:

ตอนนี้ตัวอย่างของคุณมีลักษณะเช่นนี้ใน IDEA (พร้อมกับธีม Dracula):

ดังนั้น IDEA จึงมีการเน้นไวยากรณ์และการเติมข้อความอัตโนมัติเท่าที่ฉันสามารถบอกได้ มันแนะนำชื่อฟังก์ชัน / วิธีการที่มีอยู่ขณะเขียน แต่ฉันไม่ใช่ผู้พัฒนา Groovy ดังนั้นฉันจึงไม่สามารถบอกได้ว่าคำแนะนำบางอย่างหายไป

อีกตัวเลือกหนึ่งคือการใช้ shabang ที่ด้านบนของ Jenkinsfile #!/usr/bin/env groovyเช่นนี้ นอกจากนี้คุณสามารถลองใช้ gdsl: https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij แต่จนถึงขณะนี้ยังไม่รองรับไปป์ไลน์ที่เปิดเผย: https: //issues.jenkins-ci .org / เรียกดู / JENKINS-40127

ถ้าคุณเพิ่ม

#!groovy​

ส่วนหัวไปยัง jenkinsfile ของคุณคุณควรได้รับการเน้นไวยากรณ์ที่น่าสนใจใน IDE

ในที่สุดเราก็พบโซลูชันที่เหมาะกับเราและให้การเน้นไวยากรณ์และการเติมโค้ดสำหรับ Jenkinsfile ที่มีอยู่ในโครงการ Java ปกติใน Idea การแก้ปัญหาจะนำมาจากที่นี่ , ที่นี่ (และจากการทดลองส่วนบุคคลเพิ่มเติม / วิจัย)

1. ดาวน์โหลด Groovy SDK (หากคุณยังไม่ได้ดำเนินการ) จากGroovy Pageและกำหนดค่าบนโปรเจ็กต์ Java ของคุณ สำหรับความช่วยเหลือเกี่ยวกับเรื่องนี้โปรดดูที่นี่

2. ดาวน์โหลดไฟล์ GDSL ไปป์ไลน์จากอินสแตนซ์ Jenkins ของคุณซึ่งควรมีอยู่ในลิงค์เช่นhttps: //yourJenkinsInstance.tld/pipeline-syntax/gdslและเพิ่มลงใน classpath ของโปรเจ็กต์ Java ของคุณ เช่นการสร้างโฟลเดอร์ใหม่ src / main / jenkins วางไฟล์ pipeline gdsl ไว้ที่นั่นแล้วทำเครื่องหมายโฟลเดอร์ว่าเป็น source root ใน IntelliJ Idea

3. เพิ่ม "Jenkinsfile" เป็นรูปแบบชื่อไฟล์ที่ถูกต้องสำหรับไฟล์ groovy ตามที่อธิบายไว้ที่นี่

4. เพื่อหลีกเลี่ยงข้อความแสดงข้อผิดพลาด'node' cannot be applied to '(groovy.lang.Closure<java.lang.Object>)คุณสามารถเพิ่มบรรทัดนี้ที่ด้านบนของ Jenkinsfile ของคุณ:

   // noinspection GroovyAssignabilityCheck

เมื่อดูที่ซอร์สโค้ดดูเหมือนว่า COMMENTS จะไม่ได้กำหนดไว้ (มีการแสดงความคิดเห็นไว้ในโค้ด)

STEP_KEY ถูกกำหนดให้เป็น: STEP_NAME = "sh" | "ขนาน"

ฉันไม่แน่ใจว่าปลั๊กอินทำอะไรได้มากกว่านี้และยังไม่ได้รับการอัปเดตภายใน 2 ปี

ใช้shแบบนี้แล้วข้อผิดพลาดควรหายไป (ใช้ได้กับฉัน) ...

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