1. ホーム
  2. node.js

[解決済み] NPMは.gitignoreにリストされたファイルを無視しますか?

2023-05-02 06:10:24

質問

で生成されたファイルがあります。 npm install コマンドで生成されたファイルがあります ( preinstall タスクを使用)。私はgitリポジトリにも、NPMプロジェクトにもそれを追加したくありません。

仮にファイル名が foo.json であるとすると、私はそれを .gitignore というファイルに foo.json .

NPMレジストリにアップロードしないようにするには、これでよいのでしょうか?

私は、私が追加することができます知っている .npmignore ファイルを追加すれば確実に無視されることは分かっていますが、もし .gitignore がすでにこれを行なっている場合は追加しません。

どのように解決するのですか?

プロジェクトに .npmignore.gitignore ファイルでは、npmは だけ を使用します。 .npmignore ファイルを使用します。

から ドキュメント :

を使用します。 .npmignore ファイルを使って、パッケージの中にあるものを外に出さないようにしましょう。もし .npmignore ファイルはありませんが a .gitignore ファイルであれば、npm は .gitignore ファイルにマッチするものを無視します。もし 欲しい で除外されているものをインクルードするために .gitignore ファイルによって除外されるものを含めたい場合は、空の .npmignore ファイルを作成し、それを上書きします。

もっと簡単に言うと、npm が好む .npmignore ファイルがあればそちらを優先し、なければ .gitignore ファイルにフォールバックします。

多くの場合、Git と npm の両方が同じファイルを無視することができるので、単に .gitignore ファイルを単独で使用することは理にかなっています。もし矛盾が生じた場合 (つまり npm と Git がそれぞれ別のファイルを無視する必要がある場合) は、別々の .gitignore.npmignore のファイルです。

に何を入れるかについての詳しい情報は .npmignore ファイルに記述します。 テストを .npmignore するべきですか?