Đánh dấu cú pháp Jenkinsfile trong dự án Java bằng Intellij Idea

Chúng tôi đã thử các cách tiếp cận như được liệt kê bên dưới:

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

Sau khi đã tìm kiếm trên web trong nhiều giờ trong nhiều ngày, chúng tôi vẫn chưa tìm thấy nguồn hữu ích về vấn đề này. Vì vậy, có vẻ hợp lý khi đặt một câu hỏi mới ở đây.

Chúng tôi đang phát triển các dự án Java của mình theo ý tưởng IntelliJ và muốn tích hợp các bản dựng của chúng tôi với Jenkins. Khi chúng tôi tạo tệp Jenkins trong Idea, chúng tôi không nhận được đánh dấu cú pháp hoặc tự động hoàn thành. Vì chúng tôi mới sử dụng Jenkins, những tính năng đó sẽ thực sự hữu ích đối với chúng tôi. Làm cách nào để chúng tôi có thể khiến Idea được Jenkinsfiles ủng hộ nhiều hơn?

Nếu không có cách nào để có được đánh dấu cú pháp và tự động hoàn thành cho một tệp Jenkins trong ý tưởng, thì những trình chỉnh sửa nào khác sẽ hữu ích?

Xin lưu ý:

• chúng tôi đang làm việc với các dự án java, không phải các dự án phức tạp.

• Chúng tôi đã thử plugin https://github.com/oliverlockwood/jenkinsfile-idea-plugin . Khi plugin được kích hoạt, Jenkinsfile được nhận dạng như vậy, nhưng thay vì tô sáng cú pháp, chúng tôi nhận được thông báo lỗi, vui lòng xem bên dưới.

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

  Ý tưởng làm nổi bật 'p' của 'đường ống' là lỗi. Thông báo lỗi ghi:

  JenkinsTokenType.COMMENT, JenkinsTokenType.CRLF hoặc JenkinsTokenType.STEP_KEY dự kiến, có 'p'

Cảm ơn vì bất kì sự giúp đỡ!

Nếu bạn muốn IDEA nhận ra tệp Jenkins là tệp Groovy, thì bạn có thể thêm Chuỗi "Jenkinsfile" làm mẫu tên tệp hợp lệ (thường chứa phần cuối tệp) cho tệp Groovy. Điều này được hỗ trợ "ngoài hộp" mà không yêu cầu bất kỳ Plugin bổ sung nào (ngoại trừ Plugin "Groovy", nhưng đó đã là một phần của IDEA).

Để làm điều đó, hãy chuyển đến menu cài đặt, mở mục "Trình chỉnh sửa" và sau đó là "Loại tệp". Bây giờ chọn "Groovy" trong danh sách phía trên và thêm "Jenkinsfile". Bạn cũng có thể sử dụng một regex như "Jenkinsfile *" nếu bạn muốn linh hoạt hơn liên quan đến phần kết thúc tệp tùy chọn cho Jenkinsfile.
Cài đặt bây giờ sẽ giống như sau:

Ví dụ của bạn bây giờ trông giống như thế này trong IDEA (với chủ đề Dracula):

Vì vậy, IDEA hiện cung cấp đánh dấu cú pháp và tự động hoàn thành theo như tôi có thể nói. Nó gợi ý các tên hàm / phương thức hiện có trong khi viết, nhưng tôi không phải là nhà phát triển Groovy, vì vậy tôi không thể biết nếu thiếu một số đề xuất.

Một tùy chọn khác là sử dụng shabang trên Jenkinsfile như thế này #!/usr/bin/env groovy. Ngoài ra, bạn có thể dùng thử gdsl: https://st-g.de/2016/08/jenkins-pipeline-autocompletion-in-intellij nhưng cho đến nay nó không hỗ trợ các đường dẫn khai báo: https://issues.jenkins-ci .org / Browse / JENKINS-40127

Dưới đây là phản hồi mà chúng tôi nhận được từ IntelliJ . Chúng tôi sẽ theo dõi vấn đề này nếu chúng tôi có thể cung cấp giải pháp hiệu quả.

Andrey Dernov, IntelliJ, ngày 14 tháng 12, 07:50 CET

Xin chào Georg, không có hỗ trợ Intellisense của Editor đặc biệt nào để chỉnh sửa Jenkinsfiles trong IDE. Bạn sẽ cần viết một plugin ngôn ngữ tùy chỉnh cho việc này.

Hoặc bạn có thể xem xét triển khai hỗ trợ như vậy thông qua viết Kotlin DSL. Một số ví dụ để bắt đầu.

Nhìn vào mã nguồn, có vẻ như BÌNH LUẬN không được xác định (chúng được nhận xét trong mã)

STEP_KEY được định nghĩa là: STEP_NAME = "sh" | "song song, tương đông"

Tôi không chắc plugin còn làm được nhiều hơn thế nữa và nó đã không được cập nhật trong 2 năm.

Nếu bạn thêm

#!groovy​

đầu trang tới tệp jenkins của bạn thì bạn sẽ nhận được đánh dấu cú pháp thú vị trong IDE.

Sử dụng shnhư thế này và lỗi sẽ biến mất (phù hợp với tôi) ...

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