0

0

npm publish 默认忽略的文件名模式详解

聖光之護

聖光之護

发布时间:2026-02-22 10:26:09

|

215人浏览过

|

来源于php中文网

原创

npm publish 默认忽略的文件名模式详解

npm publish 命令在打包发布时,会无条件忽略一组硬编码的文件与目录(如 .git、.DS_Store、npm-debug.log 等),无论 package.json 的 "files" 字段或 .npmignore/.gitignore 中是否显式声明,这些模式均优先生效。

npm publish 命令在打包发布时,会无条件忽略一组硬编码的文件与目录(如 `.git`、`.ds_store`、`npm-debug.log` 等),无论 `package.json` 的 `"files"` 字段或 `.npmignore`/`.gitignore` 中是否显式声明,这些模式均优先生效。

在使用 npm publish 发布 Node.js 包时,开发者常遇到“明明没写 .npmignore,也没在 package.json#files 中排除,但某些文件却莫名消失”的问题——例如嵌套层级中的 src/ 目录未被包含。这并非配置疏漏,而是 npm 内置了一组强制忽略规则(hardcoded ignore patterns),它们在任何用户配置之前即生效,且无法通过常规方式覆盖(除非显式列入 "files" 白名单)。

✅ npm publish 永久忽略的文件/目录列表

根据 npm 官方开发者文档,以下路径始终被排除,无需 .npmignore 或 .gitignore 参与:

.*.swp        # Vim 交换文件
._*           # macOS 元数据文件(如 ._package.json)
.DS_Store     # macOS 目录元数据
.git          # Git 版本库目录
.gitignore    # Git 忽略配置文件
.hg           # Mercurial 版本库目录
.npmignore    # npm 忽略配置文件(自身不参与打包)
.npmrc        # npm 配置文件
.lock-wscript # Waf 构建系统锁文件
.svn          # Subversion 版本库目录
.wafpickle-*  # Waf 构建缓存文件
config.gypi   # Node.js GYP 配置文件
CVS           # CVS 版本库目录
npm-debug.log # npm 调试日志

⚠️ 注意:src/ 不在该默认忽略列表中。你遇到的 src 目录缺失,极可能源于其他原因——例如:

Calliper 文档对比神器
Calliper 文档对比神器

文档内容对比神器

下载
  • package.json 中 "files" 字段未显式包含 "src"(npm 默认仅包含 package.json、README、LICENSE、CHANGELOG 等少数文件,不递归包含 src/);
  • 存在隐式 .npmignore(即使为空,也会禁用 .gitignore 回退逻辑);
  • src/ 被父级 .gitignore 或项目根 .npmignore 规则匹配(如 node_modules/ 同级的 * 或 **/*)。

? 如何验证实际发布的文件?

使用 npm pack --dry-run 可预览将被打包的文件列表(不真正发布):

$ npm pack --dry-run
npm notice 
npm notice ?  my-package@1.0.0
npm notice === Tarball Contents ===
npm notice 1.2kB package.json
npm notice 567B  README.md
npm notice 2.1kB lib/index.js
npm notice === Tarball Details ===
npm notice name:          my-package
npm notice version:       1.0.0
npm notice filename:      my-package-1.0.0.tgz
npm notice package size:  1.8 kB
npm notice unpacked size: 3.9 kB
npm notice shasum:        1a2b3c4d5e6f...
npm notice integrity:     sha512-...
npm notice total files:   3

若 src/ 未出现在输出中,说明它被 files 白名单遗漏或被某条 ignore 规则捕获。

✅ 推荐实践:明确控制发布内容

为避免意外遗漏,强烈建议显式声明 "files" 字段

{
  "name": "my-package",
  "version": "1.0.0",
  "files": [
    "lib",
    "index.js",
    "README.md",
    "LICENSE"
  ]
}

✅ 此方式安全、可读、可维护;
❌ 避免依赖默认行为(npm 默认仅包含极少数文件,不会自动包含 src/、test/、examples/ 等常见目录)。

? 总结

  • npm publish 的“某些模式”是硬编码的 13 类路径,涵盖版本控制元数据、编辑器临时文件、构建产物及 npm 自身配置文件;
  • src/ 不在此列,其缺失通常源于 files 未声明或 ignore 规则误匹配;
  • 使用 npm pack --dry-run 是诊断发布内容最直接的方法;
  • 最佳实践:始终在 package.json 中明确定义 "files",以实现可预测、可审计的包发布行为。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

443

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

322

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

524

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

454

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

596

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5715

2023.08.17

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

928

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
前端基础到实战(HTML5+CSS3+ES6+NPM)
前端基础到实战(HTML5+CSS3+ES6+NPM)

共162课时 | 20.4万人学习

第二十四期_前端开发
第二十四期_前端开发

共161课时 | 4.4万人学习

Composer与自制MVC框架
Composer与自制MVC框架

共8课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号