他の答えを要約する
通常は.vscodeフォルダーを除外することをお勧めしますが、他の開発者が共有設定を再作成できるようにするJSONファイルを選択したままにします。
含める設定の例:
- テストスイートを実行するための言語固有のテスト構成(
settings.json)
- このリポジトリで使用される言語ルールを適用するためのリンターおよびコードフォーマットツールの拡張設定(
settings.json)
- 構成の実行とデバッグ(
launch.json)
- 共有タスク-VSコードで管理されている場合(
tasks.json)
一部の設定は、ワークスペースファイルに保存するか、.vscodeフォルダーからそこに転送できます。下記参照。
.gitignore使用するサンプルコード(およびそれを入手する場所)
https://gitignore.ioで提案されている設定は次のとおりです。そこで「VisualStudioCode」を検索して、最新の推奨.gitignoreファイルを取得できます。私はこのWebサイトを、.gitignore私の新しいリポジトリのほとんどの出発点として使用しています。
# 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の行は(そのフォルダ内のいくつかの特定のファイルを無視し、「ない」にgitのを教えてくれsettings.json、launch.jsonなど、)。その結果.vscode、他の行の1つで具体的に指定されたファイルを除いて、すべてがフォルダーから除外されます。
その他の要因と自分で理解する方法...
.vscodeリポジトリにフォルダーを含めても、実際には別のIDE(またはテキスト/コードエディター)を使用しているユーザーに害が及ぶことはありません。
ただし、これらのファイルに、環境に固有の何かが必要な一般的な設定が含まれている場合、VS Codeを使用している他の人に害を及ぼす可能性があります。pythonpathで.vscode/settings.json)。重要なのは、ローカル環境に合わせたカスタム設定を保存せず、全員が使用できる設定のみを共有することです。
たとえば、IDE設定ファイルにリポジトリまたはファイル/ライブラリなどへの絶対パスがある場合、それは悪いことです。共有しないでください。ただし、すべての参照が相対である場合、レポを使用するすべての参照で機能します(ただし、Windows / Unix間のパス指定の違いに注意してください)。
ユーザー、ワークスペース、フォルダの設定について
注:.vscodeフォルダー内の設定ファイルは通常、設定のフォルダーバージョンに変更を加えた場合にのみ更新されます(ただし、多くの例外があるようです)。
- ユーザー設定に変更を加えた場合、それらは通常別の場所に保存されます。
- ワークスペースの設定に変更を加えると、それらは通常、
*.code-workspace現在使用しているフォルダーに保存されます(フォルダー設定ファイルに頻繁に移動しますが、手動で移動できます!)。
つまり、可能な限り、パーソナルPCのカスタム設定をユーザー設定に入れ、特定のプロジェクト/パッケージの一般的な設定を他のプロジェクト/パッケージに入れるべきです。
- Python拡張機能を使用すると、
.vscode/settings.jsonファイル(フォルダー設定を保存する)は常にpythonpath設定の下の絶対パスを保存するので、.gitignoreファイルからその除外を削除し、Pythonリポジトリに保存しなくなりました。相対パスで保存しても、VS Codeは絶対パスにリセットするだけです。
- 代わりに、コードで使用する必要のあるフォルダーをワークスペースとして保存するだけ
myproject.code-workspaceです(たとえば、[ファイル]-> [ワークスペースを名前を付けて保存]でファイルを作成します。こうすることで、ワークスペースファイルの内容を制御し、リポジトリに保存できます。フォルダ設定ファイル(.vscode/settings.json)。ワークスペースとフォルダ設定ファイルの間で設定を移動して、何を保存し、何を保存しないかを制御できます。ワークスペースファイルは、フォルダ設定ファイル内のすべてを上書きすることに注意してください。
長い点と短い点があります。ワークスペースファイルを使用して、最も一般的な設定をそこに配置し、ローカル設定をフォルダー設定ファイルに配置することができますが、これは使用している拡張機能/言語によって異なるようです。
もちろん、.vscode/settings.jsonファイルまたはその一部を保存する理由は他にもあります。または、現在の言語の設定では問題にならない場合があります。
あなたのマイレージは異なる場合があります...