0

0

npm publish 默认忽略的文件模式清单(含规避方法与最佳实践)

碧海醫心

碧海醫心

发布时间:2026-02-22 08:37:02

|

317人浏览过

|

来源于php中文网

原创

npm publish 默认忽略的文件模式清单(含规避方法与最佳实践)

npm publish 命令内置一组硬编码的忽略规则,会无条件排除特定名称的文件和目录(如 .git、.DS_Store、npm-debug.log 等),即使未在 .npmignore 或 package.json#files 中声明;本文完整列出这些模式,并说明如何安全覆盖及验证。

npm publish 命令内置一组硬编码的忽略规则,会无条件排除特定名称的文件和目录(如 `.git`、`.ds_store`、`npm-debug.log` 等),即使未在 `.npmignore` 或 `package.json#files` 中声明;本文完整列出这些模式,并说明如何安全覆盖及验证。

在使用 npm publish 发布包时,开发者常遇到“文件莫名消失”的问题——例如名为 src 的子目录未出现在最终发布的 tarball 中,但既未被 .npmignore 显式排除,也未在 package.json 的 "files" 字段中遗漏。这种现象往往源于 npm 内置的强制忽略规则(hardcoded ignore patterns):它们独立于用户配置,在打包前由 npm CLI 直接过滤,优先级高于 .gitignore 和 .npmignore。

✅ npm publish 永远忽略的文件/目录模式(截至 npm v9)

以下模式匹配的文件或目录始终被排除,无论其路径深浅(如 ./src/、./packages/core/src/ 均适用):

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

? 注意:src 本身不在该列表中。你遇到的 src 被忽略,极可能源于其他原因(如 package.json 中 "files" 字段未包含 "src",或存在隐式 .npmignore 规则)。npm 官方明确说明:src/ 是完全合法且默认可发布的目录名——它不匹配任何硬编码模式。

? 如何验证与调试实际发布内容?

在执行 npm publish 前,务必用 npm pack 预览生成的 tarball 内容:

Pix2Pix
Pix2Pix

使用Prompt编辑视频

下载
# 生成并查看压缩包结构(不上传)
npm pack --dry-run

# 或解压后检查
npm pack && tar -tzf package-name-1.0.0.tgz

若发现关键文件缺失,按以下顺序排查:

  1. 检查 package.json 是否定义了 "files" 字段 —— 一旦声明,仅该字段指定的路径会被包含(白名单模式);
  2. 检查项目根目录是否存在 .npmignore;若无,则回退至 .gitignore(但硬编码规则仍优先生效);
  3. 运行 npm ls --depth=0 确认当前工作区无意外的 publishConfig 覆盖;
  4. 使用 npm config list 确认无全局 .npmrc 干预。

⚠️ 覆盖硬编码规则?不推荐,但有例外方式

npm 不提供禁用硬编码忽略的开关。唯一合法绕过方式是:在 .npmignore(或 .gitignore)中使用 ! 取反规则显式“恢复”——但仅对部分模式有效(如 !.DS_Store 在某些 npm 版本中生效,而 !.git 则永远失败,因 .git 是核心元数据,禁止发布属安全强制策略)。

✅ 推荐做法:

  • 始终显式声明 "files" 字段,精确控制发布内容(例:"files": ["dist", "lib", "index.js", "README.md"]);
  • 避免依赖隐式包含逻辑;
  • 将构建产物(如 dist/)与源码(如 src/)分离,并确保 "files" 包含目标目录。

✅ 总结

类型 是否可覆盖 示例 建议
硬编码忽略(如 .git, npm-debug.log) ❌ 永远不可覆盖 .git/config 无需尝试恢复,应从源头清理
用户配置忽略(.npmignore / "files") ✅ 完全可控 !dist/** 用 "files" 白名单最可靠
模糊行为(如 src 消失) ⚠️ 实为配置误用 src/ 未列在 "files" 中 以 npm pack + tar -tzf 为准

遵循“显式优于隐式”原则,主动管理 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号