使用 Visual Studio Code 驗證 JCasC 配置文件

配置即代碼插件

問題陳述：將現有的模式驗證工做流程腳本語言 Jenkins 配置即代碼插件轉換爲基於 Java 的重寫，從而加強其可讀性和可測試性，並由該測試框架提供支持。經過開發 VSCode 插件來促進自動完成和驗證，從而加強開發人員的經驗，這將有助於開發人員在應用到Jenkins實例以前編寫正確的 yaml 文件。
配置即代碼插件已被設計爲 Jenkins 基於聲明式配置文件配置的基本方式，無需成爲 Jenkins 專家亦可編寫這樣的文件，只需將配置過程當中轉換成用於在 web UI 中執行的代碼便可。該插件使用此類模式來驗證要應用於 Jenkins 實例的文件。
啓用了新的 JSON 模式後，開發人員如今能夠針對其測試 yaml 文件。該模式檢查 descriptors，便可以應用於插件或 Jenkins 核心的配置，使用正確的類型並在某些狀況下提供幫助文本。VSCode 容許咱們經過一些修改當即測試架構。該項目是 Community Bridge 計劃的一部分，Community Bridge 計劃是 Linux 基金會建立的一個平臺，旨在使開發人員以及支持他們的我的和公司提升開源技術的可持續性、安全性和多樣性。您能夠看一下 Jenkins Community Bridge 項目。

啓用架構驗證的步驟

第一步安裝 Visual Studio Code 的 JCasC 插件，並經過擴展列表打開擴展。使用 Ctrl + Shift + X 在 VSCode 編輯器中打開擴展列表的快捷方式。
爲了啓用驗證，咱們須要將其包括在工做空間設置中。依次導航到 File，Preference 和 Settings。內部設置中搜索 json，內部 settings.json 中包含如下配置。

{
"yaml.schemas": {
    "schema.json": "y[a]?ml"
}

}

您能夠將全局模式指定爲 schema.json 的值，schema.json 是模式的文件名。這會將架構應用於全部 yaml 文件。例如：.[y [a]？ml]
使用 VSCode 能夠完成如下任務：
自動完成（Ctrl + Space）：自動補全全部命令。
文檔大綱（Ctrl + Shift + O）：提供文件中全部已完成節點的文檔概述。
在工做目錄下建立一個名爲 jenkins.yml 的新文件。例如，參考如下文件的內容：

jenkins:
systemMessage: 「Hello World」
numExecutors: 2

上面的 yaml 文件根據架構有效，vscode 爲您提供驗證和自動完成功能。
截圖

咱們於 2 月 26 日舉行了在線 meetup（譯註：該 meetup 已舉辦，Video 及 Slides 連接見最下方），討論該插件以及如何使用它來驗證您的 YAML 配置文件。對於有關架構的任何建議或討論，請隨時加入咱們的 gitter 頻道。能夠在 Github 上提交問題。

本文轉自公衆號 jenkins中文社區 做者 Sladyn Nunes