Menyesuaikan pengaturan proyek dan editor

  • 3 menit

Anda telah menyiapkan kontainer pengembangan untuk salah satu proyek agensi Anda. Sekarang akan "hanya berfungsi" untuk siapa pun yang memiliki Docker dan ekstensi Dev Containers. Mereka masih harus menginstal ketergantungan. Mereka mungkin juga memerlukan beberapa ekstensi Visual Studio Code yang tidak mereka ketahui.

Untungnya, Anda dapat sepenuhnya menyesuaikan dan mengotomatiskan semua penyiapan proyek dengan menggunakan file devcontainer.json.

Melihat lebih dekat pada devcontainer.json

Mari kita lihat opsi utama dalam file .devcontainer/devcontainer.json dari proyek Dasbor Produk. Agak panjang untuk melihat semuanya sekaligus, jadi mari kita lihat dalam bagian-bagian.

Konfigurasi build

Properti image menentukan bagaimana kontainer akan dibuat, berdasarkan apa yang dikenal sebagai kontainer gambar.

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

Gambar ini dihosting di devcontainers/images repo, di mana Anda dapat memeriksanya lebih lanjut. Gambar dalam repositori ini semuanya gambar bawaan, yang mempercepat alur kerja Anda dan menghasilkan konfigurasi .devcontainer/devcontainer.json yang lebih sederhana.

Anda juga dapat menggunakan file yang dikenal sebagai Dockerfile atau file Docker Compose untuk mengonfigurasi penyiapan Anda. File-file ini dapat hidup di folder .devcontainer Anda dan memungkinkan Anda untuk mengonfigurasi lebih lanjut persyaratan penyiapan tertentu, seperti menginstal perangkat lunak tambahan. Anda dapat mempelajari lebih lanjut dalam dokumentasi kontainer dev kami.

Fitur

Kontainer pengembangan Fitur adalah unit kode penginstalan mandiri yang dapat dibagikan dan konfigurasi kontainer pengembangan. Namanya berasal dari ide bahwa dengan mengacu pada salah satunya, Anda bisa dengan cepat dan mudah menambahkan alat, runtime, atau pustaka sebagai "Fitur" ke dalam kontainer pengembangan agar dapat digunakan oleh Anda atau kolaborator Anda.

Saat Anda menggunakan perintah Visual Studio Code Dev Containers: Tambahkan Dev Container Configuration Files, Anda disajikan daftar skrip untuk menyesuaikan konfigurasi kontainer dev yang ada, seperti menginstal Git atau Azure CLI.

Pengaturan proyek

Bagian selanjutnya dari file berurusan langsung dengan konfigurasi proyek.

customizations menetapkan properti khusus produk untuk produk yang mendukung kontainer pengembangan, seperti Visual Studio Code dan GitHub Codespaces.

Sebagai contoh, Anda dapat mengatur vscode.settings untuk menyalin pengaturan khusus komputer ke dalam kontainer. Anda mungkin memiliki pengaturan ini di penyiapan Visual Studio Code Anda sendiri. Dengan menambahkannya ke settings, Anda memastikan bahwa siapa pun yang membuka proyek ini mendapatkan pengaturan Visual Studio Code tertentu ini.

Dalam kontainer Python ini, Anda dapat melihat pengaturan ini dalam gambar dasarnya mcr.microsoft.com/devcontainers/python:0-3.11. Mereka memberi pengguna pengalaman pengeditan Python yang ditingkatkan.

  • Anda dapat menggunakan array extensions dalam properti customizations.vscode untuk menentukan ekstensi Visual Studio Code mana yang harus diinstal di Visual Studio Code saat terhubung ke kontainer. Penyiapan Visual Studio Code normal Anda dan semua ekstensi yang sudah Anda miliki tidak akan tersedia ketika Anda menggunakan Dev Containers. Ekstensi ditentukan di sini beserta ID-nya.

perintahPembuatanPost

Properti postCreateCommand memungkinkan Anda menjalankan perintah apa pun yang Anda inginkan setelah kontainer dibuat. Jika Anda ingat dari latihan pertama, Anda harus menjalankan perintah pip3 untuk menginstal dependensi. Tapi bagaimana kau bisa melakukan itu? Anda mungkin tidak. Anda dapat mengonfigurasinya di sini sehingga akan terjadi secara otomatis dan orang lain tidak perlu khawatir tentang hal itu.

Pada latihan berikutnya, Anda akan memodifikasi file devcontainer.json untuk mengotomatiskan beberapa aspek proyek yang akan menyiapkan pengembang lain untuk keberhasilan segera.