如何编写一个健壮的 npm 包

发布时间：2023-05-28 文章分类：编程知识投稿人：王小丽字号：默认 | 大 | 超大打印

无脑发布 npm

比如老王我，用npm init新建一个包，改把改把，然后来个npm publish，so easy ✌️!

Too young too naive, baby 👶!

请容我讲述一些发布过程中踩过的坑。

首先，算了也可以之后有空再说，我们需要通读npm的配置文档。

package.json doc

通用性👷

指定发布文件

利用package.json中files字段精简发布体积。

{
  "files": ["dist", "lib", "module"]
}

若不指定files，每次发布会把所有不以.开头的文件都发布出去，导致发布体积过大（node_modules默认也不会被发布）。

README.md作为主文档，加不加都会发布，package.json也是。

指定源代码

{
  "source": "src/index.ts",
  "repository": {
    "type": "git",
    "url": "https://github.com/yourname/yourproject.git"
  }
}

通常来说我是不在npm发布中包括源代码的，因此都没有加过source字段，只是用repository来告知一下git仓库地址即可。

如果仓库是内部仓库或私人仓库并不对外，则source字段就有用了，将源代码发布后可让人帮忙debug找问题。

注意如果有source，则files也要加上souce对应的文件或文件夹。

发布`sourcemap`

一般来说我们发布的都是经过编译的代码，为了给使用者方便调试，只要不是源码，都要有对应的sourcemap文件，例如发布了一个dist/index.js则也需要一个dist/index.js.map文件与之配套。

指定安装源

如果你从来不用私有源，可跳过该项。

利用.npmrc指定安装源，用于当前项目与你的全局配置区分开。

否则当前项目很可能指定的内部npm源，导致外部用户无法利用lock文件安装。

例如

registry=https://registry.npmjs.org/

精确指定`dependencies`、`devDependencies`、`peerDependencies`

dependencies要尽量少，只有在运行时确实用到才放进去。

依赖的版本号要清晰指明，如"react": "16.x || 17.x"

否则，如果指定了"react": "17.0.0"，则在使用了react16的项目中，会引入两份react，造成一些莫名其妙的问题。

这种情况，react应放到peerDependencies中。

指定发布目标

如果你从来不在私有源发布，可跳过该项。

在package.json中指定发布地址，在当前包与全局配置不一致时非常必要。

{
  "publishConfig": {
    "registry": "https://registry.npmjs.org"
  }
}

sideEffects

对应配置：

{ "sideEffects": false }

作用：在打包时进行treeshake可根据是否使用而优化相关的代码。

如果sideEffects为true，则一旦引入，不管是否调用都不能被treeshake掉。

专用性🥷

类型配套

无论针对哪个环境，目前自带类型已经是既成事实的标配。

记得生成类型的.d.ts文件，并在package.json中指定。

{
  "types": "type/index.d.ts",
  "typings": "type/index.d.ts"
}

我一般会用一个专用的tsconfig.declaration.json来专门生成类型：

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "noEmit": false,
    "emitDeclarationOnly": true,
    "declaration": true,
    "outDir": "types"
  }
}

作为后端库

package.json中指定main字段。

编译结果需要在nodejs环境中运行，输出commonjs格式模块。

为了兼容最新与将来，同时也要输出esmodule格式模块。

作为前端库

前端库其实要求比后端库更高，为啥？

因为现代前端开发环境要求支持所有后端环境，并延伸出前端环境的额外支持。也就是说后端库要求一般是前端库要求的子集。

需要扩展的是纯前端环境的运行格式，老格式amd已经被淘汰可以不用考虑，现在基本都被umd格式统一。

{
  "main": "lib/index.js",
  "module": "module/index.js",
  "unpkg": "dist/index.js",
  "umd:main": "dist/index.js",
  "jsdelivr": "dist/index.umd.production.min.js"
}

其中unpkg，umd:main，jsdelivr都是为了更广泛兼容的指向浏览器环境运行的同一个目标别名。

通常来说commonjs，esmodule，umd都不会将其依赖的其他包包括进去，只是在运行时才加载。

还有一种情况，可能只有我自己用到过，就是发布包中有些东西与外部环境有冲突，因此除了这些通用模式之外我又加了一个independent(取名叫standalong也比较合适)格式，将这个包的所有依赖都封装进去，可以不依赖外部环境独立使用。

例如mobx-value的独立运行文件。

mobx-value independent

注意浏览器环境输出的都是优化后的.production.min格式，也必须同时输出.development后缀的开发模式，为了方便使用者调试方便。

因为最大的使用者，往往就是我们自己，不要连自己都糊弄了事~

作为命令行工具

多配置兼容

命令行工具一般需要很多参数，例如tsc，当参数过多时没人愿意每次都输入长长的参数，因此需要配置文件的支持。

那么选哪种配置格式呢？

此时cosmiconfig隆重登场！以一句名言形容，小孩子才做选择，成年人全都要！

兼容各种配置，各种位置，详情参见其api。

还有一点，如果需要读取一些周边的json配置，不要用原生的JSON.parse，很多json是带注释的或者编写不规范，用json5读取兼容好。

还有一个精简版：lilconfig，功能差不多，我下次打算试试。

配置文件类型校验

刚入门typescript时，我尝试用typescript作为配置文件，然后在运行时利用类型机制达到校验配置的目的。

但这样会丢失很多灵活性，限制死了配置文件的来源与格式，并由于库的typescript环境与应用所在的typescript环境不一致，也导致了很多工程问题(对我说的就是ts-gear)。

后来发现通过注释文档的方式，js文件中也同样可以校验类型，而且js文件对运行时更友好。

例如webpack.config.js这样配置

/**
 * @type {import('webpack').Configuration}
 * */
const config = {...}
export default config

配置文件运行时校验

我们的程序要读配置，但配置是使用者提供的，谁知道用户会写些什么，即使有上面那步提到的类型校验把关，也会有很多边界问题类型根本管不了。

因此，运行时配置数据校验就是必备环节。

不光是校验不通过时终止运行，还必须给出一个合理且精准的错误提示。

推荐一个协议、两个校验工具与一个漂亮的格式化提示工具。

协议是json schema，校验工具为joi或ajv，提示输出工具为chalk。

指定可运行文件

在package.json中指定bin：

{
  "bin": "bin/run.js"
}

对于大部分js脚本，都要在运行文件头部指定运行环境。

#! /usr/bin/env node

然后别忘了在发布前添加可执行属性，务必整合在自动化发布脚本中。

chmod +x bin/run.js

可调用api

例如babel，我们不光能使用@babel/cli在命令行使用，也可以在自己的程序里import babel from 'babel'来调用其api。

一个命令行工具通常也是一个第三方库，方便集成到调用者自身的脚本与环境中。

其他特定环境

例如针对react-native，这个我就见过，没实际用过。

{
  "react-native": "dist/index.esm.js"
}

最后不论什么格式，都记得输出配套sourcemap的.map文件。

健壮性🏋

指定运行环境：engine与os

尤其对于命令行工具，这俩点很重要，不然很容易就换个人换个电脑就莫名报错。

{
  "engine": "node>=14",
  "os": ["linux", "darwin"]
}

有否配套测试用例

有可运行的配套测试用例。
在README.md上有可见的测试覆盖率统计，让人可以放心使用。

测试用例放在哪？

最初我习惯按照jest推荐的模式，将所有测试用例放在__tests__文件夹内。

最近两年看了好多别的语言的单测用例，我现在更倾向于将测试文件与源文件放在一起。因为测试用例，就是源代码的一部分！

比如以下这种目录结构

src/setter.ts
src/setter.test.ts

测试运行时机

npm prepublishOnly的钩子一定要加上运行测试用例。

有余力的情况，可以再配置个额外的流水线，github上有好多免费的配套流水线，自己折腾折腾。

代码校验配套

项目必须有一个较好的文档规则校验流程，大多数情况我使用eslint，然后配上airbnb与prettier的校验规则。

校验有两个重要作用，一个是真的能解决很多隐性bug，另一个是代码漂亮，之后看你项目源码的人也会觉得舒服，关键是面试时也能拿的出手。

如果有面试者给我看自己的开源作品，如果代码风格都不行，立即就判定不行，也不用再看什么逻辑能力了，招进来也是挖坑。

好的代码风格必须依赖校验工具，最好把校验流程也集成到发布的钩子上。

推广性🤹

文档

使用.markdownlint配置规范自己的markdown文档，否则很容易写飞了。

要不人家一看文档，项目质量很容易就露馅了不是🤭

配套展示用例

一个方法是在项目中自带一个可运行的样例，让人clone之后运行指定命令即可查看样例。
更好一些，部署一个可以在线查看的例子，并在主文档上附上直达链接。
更进一步，项目增大之后，需要说明的地方越来越多，一个README已经太长。使用docusaurus等类似的工具部署一个独立的文档站点。

有否自动化版本管理

Why？因为版本号与兼容性是强相关的，具体参考semver规范。

使用husky/yorkie等规范提交日志。
使用standard-version等自动生成CHANGELOG并根据规则自动提升版本号。

最后留个作业

你有什么npm发布时的关键经验这里没提到的，帮我补充下🤝
当我们再一次运行npm publish，脑编译一下，想想这期间都发生了些什么，还少些什么？

作者：京东零售王凡

内容来源：京东云开发者社区

标签 npm, too, 脚本, 问题