Git管理下でのVSCodeのlaunch.jsonの扱い方について教えてください。

PHPを用いたプロジェクトで、Xdebugを使ってVSCodeでデバッグすることが多いのですが、毎回以下のことを繰り返しています。

1.毎回プロジェクトごとに構成を作成、プロジェクトフォルダ直下に.vscodeフォルダとlaunch.jsonが生成される
2.Gitのリモートリポジトリにpushするときに、launch.jsonがVSCodeのソース管理の一覧に表示されてしまうため、その度に削除してpush
3.デバッグする際に、再度構成を作成、launch.jsonが生成される

pushの度に毎回launch.jsonの生成削除を繰り返すのが、非常に面倒くさいです（間違って一緒にpushしてしまうこともしばしば）。

この状況を改善するために.gitignoreに記述すれば一覧に表示されなくなるのではないかと思い、以下を記述してみました

.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

しかし、反映されず、相変わらず変更一覧に表示されてしまいます。

また、その時思ったのですが、
仮にlaunch.jsonが一覧から消えたとしても、.gitignoreが一覧に表示されてしまうので、
勝手に.gitignoreを編集したとして、他のメンバーに迷惑なのではないか、という不安があります。
（.gitignoreは.envのようにGitに反映されないのかと思っていました。）

そこで、以下の点をお聞きしたいです。

1.どうすれば.gitignoreに書いた内容が反映されるのか
2.gitignore自体はgitに反映されるのか、反映してよいのか
3.そもそも毎回launch.jsonを作る必要があるのか（最初に一度作れば済む方法はないのか、みなさんはどのように対処しているのか）

よろしくお願いいたします。

行動規範の内容に同意します

回答3件

ベストアンサー

plain
1.vscode/*
2!.vscode/settings.json
3!.vscode/tasks.json
4!.vscode/launch.json
5!.vscode/extensions.json

これってlaunch.jsonをgit管理する設定ですよね。
https://github.com/github/gitignore/blob/21419e391a78f2487340b3b1240b988aaf15b54f/Global/VisualStudioCode.gitignore
にも乗っかるくらいわりと推奨されている設定。

まあつまり諦めてバージョン管理したら？ってことでは。

投稿2019/10/13 09:24

yumetodo

総合スコア5850

coh46

2019/10/16 03:32

ご回答ありがとうございます。推奨されているとは知りませんでした。一度 launch.json を push してしまって、「削除して再度 push しなおして」と言われた経緯があります。こういうのはプロジェクトのルール次第なのですね。。。

yumetodo

2019/10/16 03:50

一度gitで管理されたファイルはgitignoreを変更しても削除されませんが git rm -r --cached . することで.gitignoreを反映できます(毎回コマンド忘れてgit ignore applyでググって https://stackoverflow.com/questions/19663093/apply-gitignore-on-an-existing-repository-already-tracking-large-number-of-file このStackOverflow見てる・・・)

coh46

2019/10/16 04:14

こんなコマンドがあるんですね！このコマンドは、既存のファイルを削除して.gitignoreに追記する（バージョン管理の対象外とする）ということでしょうか？

yumetodo

2019/10/16 05:55

>.gitignoreに追記する違います。.gitignoreを反映します

行動規範の内容に同意します

ちょっと昔の質問なので、質問された方が見てないかもしれませんが自分が行ってた方法を紹介します。

詳しくは以下の記事を確認してください。
https://qiita.com/orange634nty/items/852ff50a0bcdcce22f26

簡単に説明すると、 ~/.gitconfig に

[core]
    excludesfile = ~/.gitignore_global

を追記して、 ~/.gitignore_global に ignore するファイルを記述します。
こうすると、グローバルでgitignoreが可能です。
全部のプロジェクト共通でignoreされると困る場合は使えませんが、それで問題ないなら有効な方法です。

注意点

コメントでもありますが、グローバルなignoreは意図しない挙動を誘発することがあります。
なので、一番の方法は他の回答者のおっしゃるようにgitの管理下に含めるようにチームと交渉することだと思います。

投稿2020/02/18 04:07

編集2020/02/18 16:59

orange634nty

総合スコア18

yumetodo

2020/02/18 15:16

グローバルのignoreは意図しない挙動に悩まされがちな印象・・・(SourceTreeのデフォルト設定に叫ぶ人々を観測しつつ

orange634nty

2020/05/19 05:50 編集

> グローバルのignoreは意図しない挙動に悩まされがちな印象・・・(SourceTreeのデフォルト設定に叫ぶ人々を観測しつつそうですね、なので一番はプロジェクトのgit管理下に入れるようにチームに交渉することだと思います。ただ、見た雰囲気質問者が微妙に納得されてないようなので別案を提示してみました。誤解が生まれるとよくないので、そちら注意点に追記しておきます。ありがとうございます。

行動規範の内容に同意します