自訂專案和編輯器設定

已完成

您已為機構的其中一個專案設定開發容器。 現在具有 Docker 和開發容器延伸模組的任何人員「即可使用」。 其仍必須安裝相依性。 人員們可能也需要一些不熟悉的 Visual Studio Code 延伸模組。

幸運的是,您可以使用 devcontainer.json 檔案以完整自訂及自動化所有專案設定。

深入了解 devcontainer.json

讓我們查看產品儀表板專案中 .devcontainer/devcontainer.json 檔案內的主要選項。 一次查看全部的時間有點久,因此讓我們來分節查看。

組建組態

image 屬性會根據所謂的容器映像來定義容器的建立方式。

"image": "mcr.microsoft.com/devcontainers/python:0-3.11"
},

此映像裝載於 devcontainers/images 存放庫中,您可以在其中進一步查看。 此存放庫中的映像都是預先建置的映像,可加速工作流程並產生更簡單的 .devcontainer/devcontainer.json 設定。

您也可以使用稱為 Dockerfile 或 Docker Compose 檔案的檔案來配置您的設定。 這些檔案可以存在於您的 .devcontainer 資料夾中,並可讓您進一步設定特定的設定需求,例如安裝其他軟體。 您可以在我們的開發容器文件中深入了解。

功能

開發容器功能是獨立、可共用的安裝程式碼單元和開發容器設定。 此名稱來自參考其中一項的概念,可讓您快速且輕鬆地將更多工具、執行階段或程式庫「功能」新增至您的開發容器,以供您或共同作業者使用。

使用 VS Code 命令開發容器: 新增開發容器設定檔時,您會看到指令碼清單,可用來自訂現有的開發容器設定,例如安裝 Git 或 Azure CLI。

專案設定

檔案稍後的區段會直接處理專案設定。

customizations 會為支援開發容器的產品 (例如 VS Code 和 GitHub Codespaces) 設定產品特定屬性。

例如,您可以將 vscode.settings 設定為將電腦特定的設定複製到容器中。 您可能會在您自己的 Visual Studio Code 設定中具備這些設定。 藉由將其新增至 settings,您可確保開啟此專案的任何人員都會取得這些特定的 VS Code 設定。

在此 Python 容器中,您可以在其基礎映像 mcr.microsoft.com/devcontainers/python:0-3.11看到這些設定。 它們可為使用者提供改善的 Python 編輯體驗。

  • 您可以使用 customizations.vscode 屬性中的 extensions 陣列指定連線到容器時應在 Visual Studio Code 中安裝哪些 Visual Studio Code 延伸模組。 您的一般 Visual Studio Code 設定和所有已具備的延伸模組,將不會在您使用開發容器時出現。 這裡會使用延伸模組的識別碼來指定延伸模組。

postCreateCommand

postCreateCommand 屬性可讓您在建立容器之後執行您所需的任何命令。 若您還記得第一個練習,您在第一個練習中必須執行 pip3 命令以安裝相依性。 但是您知道該怎麼做嗎? 您可能不知道。 您可以在這裡進行設定使其自動進行,其他人員就不需要煩惱。

在下一個練習中,您會修改 devcontainer.json 檔案,將專案的數個層面自動化,準備好讓其他開發人員立即成功。