TS库打包配置package.json的files字段时为何子目录未被忽略?
为啥你的配置不生效
files字段和.npmignore的工作逻辑完全不一样,你踩的是大部分人迁移配置时都会碰到的规则差异坑:
.npmignore是黑名单逻辑,支持「先全排除、再反选白名单内容」的写法,通配符会按照你预期的规则做排除/包含处理files是纯白名单逻辑,完全不支持任何排除类语法,只要被规则匹配到的是文件夹路径,npm会默认递归打包它下面的所有子文件、子目录,直到被.npmignore规则二次裁剪
你之前以为dist/*只会匹配dist根目录下的文件,实际上npm的通配符是不分文件/文件夹的,这个规则会把dist下的所有一级子目录(components、hooks、util)都纳入打包范围,加上dist/components/*会把components下的common等子目录也带进来,自然所有本该排除的内部文件都会被打进包里。
正确的配置方式
不需要硬靠files字段实现精细筛选,官方本身就是推荐files和.npmignore配合使用的,分工很明确:files负责圈定大的白名单范围,.npmignore负责裁剪掉范围内不需要的内容。
1. 调整package.json的files字段
不需要写复杂逻辑,只需要圈定要保留的大边界:
"files": [ "dist/*", "dist/components/*" ]
这一步结束后,npm会生成一个初始打包清单,里面包含dist下的所有一级路径、以及components下的所有一级路径。
2. 配套调整.npmignore规则
因为files没有排除能力,所有不需要的子目录都要靠.npmignore从初始清单里剔除,最终的.npmignore规则就三行:
# 排除dist根目录下所有一级子文件夹(这一步会把hooks、util、components全部从清单里去掉) dist/*/ # 重新把需要保留的components文件夹加回白名单 !dist/components/ # 排除components下的所有一级子文件夹(把common这类内部目录从清单里去掉) dist/components/*/
最终的打包效果
按照上面的配置,最终打出来的包会完全符合你的预期:
- 保留dist根目录下的所有顶级文件(比如bundle.js、sourcemap等)
- 保留dist/components下的所有直接文件(componentA.d.ts、componentB.d.ts等)
- 自动排除dist下的其他一级子目录(hooks、util等不需要交付的内容)
- 自动排除dist/components下的所有子目录(common这类仅内部使用的目录)
容易踩的小坑
- 别尝试在
files字段里写排除类的通配符(比如!dist/hooks),npm完全不识别这类语法,写了也不会生效 - 只要是文件夹路径,不管是直接写的还是通配符匹配到的,npm都会默认递归打包全量内容,这也是为啥光靠几个
*通配符没法实现精细筛选的核心原因 - 用了
files字段不代表要把.npmignore删掉,两者是配合关系,不是二选一的互斥关系
内容的提问来源于stack exchange,提问作者Devildude4427
相关产品推荐
相关产品推荐

