Podsumowując inne odpowiedzi
Zaleca się, aby zasadniczo wykluczyć .vscode
folder, ale pozostaw wybrane pliki JSON, które pozwalają innym programistom na odtworzenie wspólnych ustawień.
Przykłady ustawień, które należy uwzględnić:
- Konfiguracje testów specyficzne dla języka do uruchamiania pakietów testowych (
settings.json
)
- Ustawienia rozszerzeń dla narzędzi i narzędzi do formatowania kodu w celu wymuszenia reguł językowych używanych w tym repozytorium (
settings.json
)
- Konfiguracje uruchamiania i debugowania (
launch.json
)
- Zadania współdzielone - jeśli zarządzane za pomocą VS Code (
tasks.json
)
Pamiętaj, że niektóre ustawienia można zapisać w pliku obszaru roboczego lub przenieść do niego z folderu .vscode. Patrz poniżej.
Przykładowy .gitignore
kod do użycia (i gdzie go zdobyć)
Oto ustawienia, jak sugerowano na https://gitignore.io . Możesz tam wyszukać „VisualStudioCode”, aby uzyskać najnowszy zalecany .gitignore
plik. Używam tej strony jako punktu wyjścia .gitignore
dla większości moich nowych repozytoriów:
# 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
W powyższym .gitignore
pliku, .vscode/*
linia mówi wykluczyć wszystko w .vscode
folderze, ale wtedy !.vscode/a_specific_file
linii powiedz git na „nie” ignorować pewne konkretne pliki w tym folderze ( settings.json
, launch.json
, itd.). Rezultat końcowy jest taki, że wszystko jest wykluczone w .vscode
folderze, z wyjątkiem plików specjalnie nazwanych w jednym z tych innych wierszy.
Inne czynniki i jak się przekonać ...
Dołączenie .vscode
folderu do repozytorium nie zaszkodzi nikomu, kto używa innego IDE (lub edytora tekstu / kodu).
Może jednak zaszkodzić innym osobom korzystającym z VS Code, jeśli pliki te zawierają ogólne ustawienia, które wymagają czegoś specyficznego dla twojego środowiska, które jest inne w ich środowisku - np. Bezwzględna ścieżka, w której repo jest zainstalowane (w którym rozszerzenie VS Code Python konsekwentnie wprowadza pythonpath
w .vscode/settings.json
). Kluczem jest unikanie zapisywania ustawień dostosowanych do lokalnego środowiska, udostępniając tylko te, z których mogą korzystać wszyscy.
Na przykład, jeśli pliki ustawień IDE mają bezwzględne ścieżki do repozytorium lub plików / bibliotek itp., To źle, nie udostępniaj. Ale jeśli wszystkie referencje są względne, powinny działać dla każdego, kto korzysta z repozytorium (choć uważaj na różnice specyfikacji ścieżek między Windows / Unix ..).
Informacje o ustawieniach użytkownika, obszaru roboczego i folderu
Uwaga: pliki ustawień w .vscode
folderze są generalnie aktualizowane tylko po wprowadzeniu zmian w wersji ustawień folderu (wydaje się jednak, że istnieje wiele wyjątków).
- Jeśli wprowadzisz zmiany w ustawieniach użytkownika , zwykle są one przechowywane w innym miejscu.
- Jeśli wprowadzisz zmiany w ustawieniach obszaru roboczego , zwykle są one przechowywane w
*.code-workspace
folderze, którego aktualnie używasz (nadal często przechodzą do plików ustawień folderów - ale możesz je ręcznie przenieść!).
Oznacza to, że należy umieścić własne ustawienia dla Twojego osobistego komputera do użytkownika ustawień i umieścić te ogólne dla określonego projektu / pakiet do innych, w miarę możliwości.
- Zauważyłem, że podczas korzystania z rozszerzenia Python
.vscode/settings.json
plik (który zapisuje ustawienia folderów ) zawsze zapisuje ścieżkę bezwzględną pod tym pythonpath
ustawieniem, więc usunąłem jego wykluczenie z moich .gitignore
plików i nie zapisuję go już na moich repozytoriach Python. Nawet jeśli zapiszę go ze ścieżką względną, VS Code po prostu zresetuje go do ścieżki bezwzględnej.
- Zamiast tego po prostu zapisuję dowolny folder, którego muszę użyć w Kodzie jako obszar roboczy (np. Tworzę
myproject.code-workspace
plik za pomocą Plik -> Zapisz obszar roboczy jako . W ten sposób możesz kontrolować, co wchodzi do pliku obszaru roboczego i zapisać go w repozytorium, wykluczając plik ustawień folderów ( .vscode/settings.json
). Możesz dowolnie przenosić dowolne ustawienia między obszarem roboczym a plikami ustawień folderów, aby kontrolować, co zostanie zapisane, a co nie. Pamiętaj, że plik obszaru roboczego zastąpi wszystko w pliku ustawień folderu.
Krótko mówiąc - możesz po prostu użyć pliku obszaru roboczego i umieścić w nim najczęściej używane ustawienia, jednocześnie umieszczając ustawienia lokalne w pliku ustawień folderu, choć wydaje się, że zależy to od używanych rozszerzeń / języków.
Oczywiście możesz mieć inne powody, dla których chcesz zapisać .vscode/settings.json
plik lub jego część. Lub może to nie stanowić problemu dla ustawień w twoim obecnym języku.
Twój przebieg może się różnić ...