0

0

npm publish 默认忽略的文件与目录模式详解

聖光之護

聖光之護

发布时间:2026-02-22 09:53:02

|

182人浏览过

|

来源于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` 中是否显式声明,这些文件均不会被包含在发布的包中。

在构建和发布 Node.js 包时,理解 npm publish 的默认排除逻辑至关重要——它并非仅依赖 .npmignore 或 package.json#files,而是在底层预置了一组强制忽略规则(hardcoded ignore patterns)。这些规则优先级最高,无法通过常规配置覆盖,除非使用 ! 显式反向声明(但对部分模式仍无效,后文说明)。

✅ npm publish 永远忽略的文件/目录列表(v8/v9+ 稳定版本)

根据 npm 官方开发者文档,以下路径模式在 npm publish 执行时自动排除,且不可绕过(即使写入 "files" 数组或添加 !./.git 也不会生效):

.*.swp
._*
.DS_Store
.git
.gitignore
.hg
.npmignore
.npmrc
.lock-wscript
.svn
.wafpickle-*
config.gypi
CVS
npm-debug.log

⚠️ 注意:src 目录本身不在该默认忽略列表中。你遇到的 src 被意外排除,极可能是由其他原因导致(例如:package.json 中 "files" 字段未包含 "src",且未设置 "files" 时 npm 默认仅包含白名单文件;或存在隐式 .npmignore 继承规则;或使用了旧版 npm 的遗留行为)。请务必检查 package.json 是否缺失 "files" 配置,或运行 npm pack --dry-run 验证实际打包内容。

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

文档内容对比神器

下载

? 如何验证哪些文件会被发布?

执行以下命令可预览即将发布的文件结构,无需真正上传:

npm pack --dry-run
# 或生成 tarball 后解压检查
npm pack && tar -tzf your-package-1.0.0.tgz

此外,启用详细日志可辅助诊断:

npm publish --dry-run --loglevel verbose

? 关键注意事项

  • ! 反向规则对默认忽略项无效:在 .npmignore 中写 !./.git 不会恢复 .git 目录——因为它是硬编码排除,! 仅作用于 .npmignore/.gitignore 的普通匹配规则。
  • "files" 字段是白名单机制:若设置了 "files",则只有列表中明确声明的路径会被包含,其余全部排除(包括 src、lib、README.md 等常见目录/文件)。未设置 "files" 时,npm 采用启发式默认(如包含 package.json、README、LICENSE、CHANGELOG 及主入口相关文件),但不保证包含 src/
  • .gitignore 仅在无 .npmignore 时作为后备:npm 优先读取 .npmignore;若不存在,则回退至 .gitignore。但二者均无法覆盖上述硬编码忽略项

✅ 最佳实践建议

  1. 显式声明 "files"(推荐):避免隐式行为,提高可预测性。
    {
      "files": ["dist", "lib", "index.js", "types", "README.md"]
    }
  2. 避免依赖 src/ 自动包含:始终将构建产物(如 dist/ 或 lib/)纳入 "files",而非源码目录。
  3. 定期用 npm pack --dry-run 验证:将其加入 CI 流程,防止意外遗漏关键文件。
  4. 勿尝试“解除”硬忽略项:如需调试信息,改用 console.log() 或独立日志文件,而非保留 npm-debug.log。

掌握这些底层规则,能显著减少发布失败、功能缺失等“神秘消失”问题,让包管理更稳健、可维护。

热门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号