สรุปคำตอบอื่น ๆ
คำแนะนำคือการยกเว้น.vscode
โฟลเดอร์ แต่ให้ปล่อยไฟล์ JSON ที่เลือกไว้ซึ่งจะช่วยให้นักพัฒนาซอฟต์แวร์รายอื่นสามารถสร้างการตั้งค่าที่แชร์ได้ใหม่
ตัวอย่างของการตั้งค่าที่จะรวมถึง:
- การกำหนดค่าการทดสอบเฉพาะภาษาเพื่อเรียกใช้ชุดทดสอบ (
settings.json
)
- การตั้งค่าส่วนขยายสำหรับ linters และเครื่องมือการจัดรูปแบบรหัสเพื่อบังคับใช้กฎภาษาที่ใช้ใน repo นี้ (
settings.json
)
- เรียกใช้และแก้ไขการกำหนดค่า (
launch.json
)
- แชร์งาน - หากจัดการด้วยรหัส VS (
tasks.json
)
โปรดทราบว่าการตั้งค่าบางอย่างสามารถเก็บไว้ในไฟล์พื้นที่ทำงานหรือถ่ายโอนไปยังได้จากโฟลเดอร์. vscode ดูด้านล่าง
.gitignore
โค้ดตัวอย่างที่จะใช้ (และตำแหน่งที่จะได้รับ)
นี่คือการตั้งค่าให้เป็นข้อเสนอแนะที่https://gitignore.io คุณสามารถค้นหา "VisualStudioCode" ที่นั่นเพื่อรับ.gitignore
ไฟล์ที่แนะนำล่าสุด ฉันใช้เว็บไซต์นี้เป็นจุดเริ่มต้น.gitignore
สำหรับส่วนใหญ่ของ repos ใหม่ของฉัน:
# Created by https://www.gitignore.io/api/visualstudiocode
# Edit at https://www.gitignore.io/?templates=visualstudiocode
### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
### VisualStudioCode Patch ###
# Ignore all local history of files
**/.history
# End of https://www.gitignore.io/api/visualstudiocode
ในข้างต้น.gitignore
แฟ้ม.vscode/*
บรรทัดกล่าวว่าจะไม่รวมทุกอย่างใน.vscode
โฟลเดอร์ แต่แล้ว!.vscode/a_specific_file
เส้นบอกคอมไพล์จะ "ไม่" ละเว้นไฟล์บางอย่างในโฟลเดอร์นั้น ( settings.json
, launch.json
ฯลฯ ) ผลลัพธ์ที่ได้คือทุกอย่างไม่รวมอยู่ใน.vscode
โฟลเดอร์ยกเว้นไฟล์ที่มีชื่อเฉพาะในหนึ่งบรรทัดอื่น ๆ
ปัจจัยอื่น ๆ และวิธีการคิดออกเพื่อตัวคุณเอง ...
การรวม.vscode
โฟลเดอร์ใน repo ของคุณไม่ได้ทำร้ายใครที่ใช้ IDE อื่น (หรือ text / code editor)
อย่างไรก็ตามอาจทำให้ผู้อื่นใช้รหัส VS หากไฟล์เหล่านี้มีการตั้งค่าทั่วไปที่ต้องการบางสิ่งบางอย่างสำหรับสภาพแวดล้อมของคุณซึ่งแตกต่างกันในสภาพแวดล้อมของพวกเขา - เช่นเส้นทางสัมบูรณ์ที่ repo ติดตั้งอยู่pythonpath
ใน.vscode/settings.json
) กุญแจสำคัญคือการหลีกเลี่ยงการบันทึกการตั้งค่าที่กำหนดเองสำหรับสภาพแวดล้อมท้องถิ่นของคุณเฉพาะการแบ่งปันที่สามารถใช้งานได้โดยทุกคน
ตัวอย่างเช่นหากไฟล์การตั้งค่า IDE มีพา ธ ที่สมบูรณ์ไปยัง repo หรือไฟล์ / ไลบรารีใด ๆ เป็นต้นแสดงว่าไม่ถูกต้องอย่าแชร์ แต่ถ้าการอ้างอิงทั้งหมดนั้นสัมพันธ์กันพวกเขาก็ควรทำงานให้กับทุกคนที่ใช้ repo (แม้ว่าจะต้องระมัดระวังเกี่ยวกับความแตกต่างของสเปคพา ธ ระหว่าง Windows / Unix .. )
เกี่ยวกับการตั้งค่าผู้ใช้พื้นที่ทำงานและโฟลเดอร์
หมายเหตุ:.vscode
โดยทั่วไปไฟล์การตั้งค่าในโฟลเดอร์นั้นจะได้รับการอัปเดตเฉพาะเมื่อคุณทำการเปลี่ยนแปลงการตั้งค่าเวอร์ชันของโฟลเดอร์ (ดูเหมือนจะมีข้อยกเว้นมากมาย)
- หากคุณทำการเปลี่ยนแปลงการตั้งค่าผู้ใช้มักจะถูกจัดเก็บไว้ที่อื่น
- หากคุณทำการเปลี่ยนแปลงการตั้งค่าพื้นที่ทำงานปกติจะถูกเก็บไว้ใน
*.code-workspace
โฟลเดอร์ที่คุณกำลังใช้งานอยู่ (โดยปกติจะยังคงอยู่ในไฟล์การตั้งค่าโฟลเดอร์ - แต่คุณสามารถย้ายได้ด้วยตนเอง!)
ซึ่งหมายความว่าคุณควรตั้งค่าที่กำหนดเองสำหรับพีซีส่วนบุคคลของคุณลงในการตั้งค่าผู้ใช้และตั้งค่าทั่วไปสำหรับโครงการ / แพ็คเกจเฉพาะลงในส่วนอื่น ๆ เมื่อทำได้
- ฉันสังเกตว่าเมื่อใช้ส่วนขยาย Python
.vscode/settings.json
ไฟล์ (ซึ่งบันทึกการตั้งค่าโฟลเดอร์ ) จะบันทึกพา ธ สัมบูรณ์ภายใต้การpythonpath
ตั้งค่าเสมอดังนั้นฉันจึงลบการแยกออกจาก.gitignore
ไฟล์ของฉันและไม่บันทึกลงใน repos ของ Python อีกต่อไป แม้ว่าฉันจะบันทึกด้วยเส้นทางสัมพัทธ์รหัส VS เพียงแค่รีเซ็ตเป็นเส้นทางที่แน่นอน
- แต่ฉันเพิ่งบันทึกโฟลเดอร์ใด ๆ ที่ฉันต้องการใช้ใน Code เป็นเวิร์กสเปซ (เช่นสร้าง
myproject.code-workspace
ไฟล์ด้วยFile -> Save workspace asด้วยวิธีนี้คุณสามารถควบคุมสิ่งที่จะเข้าไปในไฟล์เวิร์กสเปซและบันทึกลง repo ได้ ไฟล์การตั้งค่าโฟลเดอร์ ( .vscode/settings.json
) คุณสามารถย้ายการตั้งค่าใด ๆ ระหว่างเวิร์กสเปซและไฟล์การตั้งค่าโฟลเดอร์เพื่อควบคุมสิ่งที่ได้รับการบันทึกและสิ่งที่ไม่จำไว้ว่าไฟล์เวิร์กสเปซจะแทนที่สิ่งใด ๆ ในไฟล์การตั้งค่าโฟลเดอร์
ความยาวและความสั้นคือ - คุณสามารถใช้ไฟล์เวิร์กสเปซแล้วตั้งค่าทั่วไปส่วนใหญ่ในขณะที่ตั้งค่าโลคัลในไฟล์การตั้งค่าโฟลเดอร์แม้ว่าสิ่งนี้จะขึ้นอยู่กับส่วนขยาย / ภาษาที่คุณใช้
แน่นอนคุณอาจมีเหตุผลอื่นในการบันทึก.vscode/settings.json
ไฟล์หรือบางส่วนของมัน หรือนี่อาจไม่ใช่ปัญหาสำหรับการตั้งค่าในภาษาปัจจุบันของคุณ
ไมล์สะสมของคุณอาจแตกต่างกันไป ...