.gitignoreファイルの作成と、node_modulesをgitの管理下から外す

先に結論

以下のコマンドを実行し、.gitignoreファイルを作成します。この時、プロジェクトの最上位、ルートディレクトリでファイルを作成すること。

touch .gitignore

.gitingoreファイルには、Gitで管理したくないファイルを記述します。
今回はnode_modulesディレクトリを記述します。

.gitignore

node_modules/

次に、node_modulesディレクトリは残したままGitの管理対象から外します。
以下のコマンドを実行。

git rm -r --cached node_modules

--chashedオプションをつけないと、ディレクトリごと削除してしまうので注意!

ここまで実行したら、GitHubのリポジトリへpushして完了です。

git add .
git commit -m "message"
git push origin main

これでリモートリポジトリを確認すると、node_modulesディレクトリが削除されているはずです。

ここに至った経緯

当初、GitHubにてリポジトリを作成する予定はなく、ローカルでプロジェクトを作成し進めていました。
途中でGitHubで管理したくなり、.gitignoreファイルを作成していない状態でgit initを実行したため、node_modulesディレクトリもGitの管理対象となってしまいました。
リモートリポジトリからディレクトリを削除しようと試みましたが、ものすごい量だったため、ディレクトリ内のファイルを表示するのに時間を要したため断念。
そのため、今回の方法でnode_modulesディレクトリをGitの管理下から外すことにしました。

まとめ

間違ってGitHubへnode_modulesディレクトリをpushしてしまった場合には、ローカルで.gitignoreファイルを作成する。そして、Gitの管理下から外すコマンドを実行することで修正することが可能でした。