npm 中的 package.json 实践-files 字段

时间:2024-10-16 10:59:53

files 字段是需要发布文件的配置。

默认情况下,README.md、package.json、LICENSE 文件会默认发布到 npm。

像 node_modules、package-lock.json 文件默认不会发布到 npm。

其他文件是否发布可以通过 files 字段控制,以库 leafer-x-ruler 为例,其 files 配置为:

{
  ...
  "files": [
    "src",
    "types",
    "dev",
    "dist"
  ],
  ...
}

因此可以看到,除了默认发布的文件外,指定4个文件夹及其下的文件都被发布到 npm 了:

node_modules/leafer-x-ruler
├── LICENSE
├── README.md
├── dev
│   ├── bundle.js
│   └── index.html
├── dist
│   ├── index.cjs
│   ├── index.esm.js
│   ├── index.esm.min.js
│   ├── index.js
│   ├── index.min.cjs
│   └── index.min.js
├── package.json
├── src
│   ├── Ruler.ts
│   └── index.ts
└── types
    └── index.d.ts

5 directories, 14 files

而像 playground, __tests__ 文件夹并没有发布上去。