如何将.gitignore文件作为我的npm模块的一部分包含在内？

Question

我正在构建一个npm模块,它将为某些软件项目生成特定的项目模板.因此,当开发人员安装我的npm模块并运行它时,我希望程序以某种方式创建文件和文件夹.

我希望在项目模板中包含的一个这样的文件是.gitignore文件,因为软件项目将假设它将通过git进行跟踪.但是,当我在我的模块上调用"npm install"时,npm将我的所有.gitignore文件重命名为.npmignore文件.当我分发模块时,如何确保我的.gitignore文件没有被npm篡改？

Answer 1

您可以看到多个提交处理npm issues 1862 的多个提交：

\n\n

\n

• 这个项目添加了一个rename.json：

  \n\n

  lib/init-template/rename.json\n{\n    ".npmignore": ".gitignore",\n}\n

\n

• 这个重命名了.gitignore：

  \n\n

  templates/default/.gitignore \xe2\x86\x92 templates/default/{%=gitignore%}\n\nindex.js\n@@ -114,6 +114,10 @@ generator._pkgData = function (pkg) {\n    + // npm will rename .gitignore to .npmignore:\n    + // [ref](https://github.com/npm/npm/issues/1862)\n    + pkg.gitignore = \'.gitignore\';\n

\n

\n