本地安装Git子模块时.npmignore失效，如何精简node_modules文件？

When installing local packages like your Git submodule modules/loader, npm sometimes behaves differently than with published packages, which can make .npmignore seem ineffective. Let's walk through the most reliable solutions to ensure only your dist/ folder ends up in node_modules:

1. Use the files Field in the Submodule's package.json (Most Reliable) #

Instead of relying on exclusion via .npmignore, explicitly define what should be included using the files array in modules/loader/package.json. This is npm's preferred method and avoids any ambiguity:

{
  "name": "loader",
  "version": "x.x.x",
  "files": [
    "dist/"
  ],
  // rest of your package.json content
}

This tells npm to only include the dist/ directory when installing or packaging the module. Any other files (like ts/, tsconfig.json) will be automatically excluded—no .npmignore needed.

2. Verify Your .npmignore Setup (If You Prefer Exclusion) #

If you still want to use .npmignore, double-check these details:

• Ensure the .npmignore file is in the root of the loader module (modules/loader/.npmignore), not the parent modules/ folder.
• Make sure it explicitly excludes the files/folders you don't want:

  # Exclude TypeScript source files and config
  ts/
  tsconfig.json
  # Add any other non-essential files here
  

• Note: If you have a .gitignore in the same folder, npm will ignore .gitignore entries only if .npmignore exists. But using files is still more straightforward for local installs.

3. Clean npm Cache and Reinstall #

npm sometimes caches local package data, so changes to .npmignore or package.json might not take effect immediately. Run these commands to reset:

# Clear npm cache
npm cache clean --force

# Remove the existing loader module from node_modules
rm -rf serverApp/node_modules/loader

# Reinstall the local module
npm install

4. Test What Gets Included with npm pack #

To verify your setup without reinstalling every time, run npm pack in the modules/loader directory. This creates a tarball (loader-x.x.x.tgz) that mirrors what npm would include when installing. You can extract it to check if only dist/ is present:

cd modules/loader
npm pack
tar -xvf loader-x.x.x.tgz
# Check the contents of the extracted "package" folder

By following these steps, you should be able to limit the files in node_modules/loader to just your compiled dist/ folder, avoiding unnecessary TypeScript files and configs.

内容的提问来源于stack exchange，提问作者XeniaSis