如何配置npm，使Git仓库仅暴露指定文件夹？

问题场景 #

我有两个Git仓库：

• 仓库MyRepo的目录结构：

MyRepo
|- library
|- FolderToHide
|- package.json

其package.json内容：

{
   "name": "myRepo",
   "repository": {
     "type": "git",
     "url": "https://somewhere"
   },
   ...
}

• 仓库myRepo2通过Git URL引入MyRepo作为依赖：

{
   "name": "myRepo2",
   "repository": {
     "type": "git",
     "url": "https://somewhereelse"
   },
   "dependencies": {
     "myRepo": "git+ssh:https://git@somewhere"
   }
   ...
}

安装后myRepo2的node_modules里包含了MyRepo的FolderToHide文件夹，需要配置MyRepo使其仅对外暴露指定文件夹（比如library）。

解决方案 #

方法1：使用package.json的files字段（推荐）

npm处理依赖（包括Git依赖）时，会优先遵循package.json中的files字段，它定义了包安装时需要包含的文件/目录，属于白名单机制。

修改MyRepo的package.json，添加files数组，只列出你想暴露的内容：

{
   "name": "myRepo",
   "repository": {
     "type": "git",
     "url": "https://somewhere"
   },
   "files": [
     "library/"
   ],
   ...
}

提交并推送这个修改后，myRepo2重新安装MyRepo依赖时，node_modules里只会出现library目录，FolderToHide会被自动排除。

注：package.json、README、LICENSE等文件默认会被包含，无需手动添加到files数组。

方法2：使用.gitignore（需处理已提交文件）

如果更习惯用Git忽略规则，也可以通过.gitignore排除FolderToHide，但要注意该目录的Git跟踪状态：

1. 在MyRepo根目录创建或修改.gitignore文件，添加：

FolderToHide/

2. 如果FolderToHide已经被Git提交过，先从Git索引中移除（不会删除本地文件）：

git rm -r --cached FolderToHide/

3. 提交并推送修改：

git add .gitignore
git commit -m "忽略FolderToHide目录"
git push

之后myRepo2重新安装依赖，node_modules里就不会出现FolderToHide了。

这种方法的局限性是：后续新增需要暴露的目录时，要确保没被.gitignore排除；相比之下files字段的白名单方式更清晰，适合明确指定对外内容的场景。

内容的提问来源于stack exchange，提问作者A.Pissicat