当前位置: 首页 > >

新建node ts_NPM 发布 TS 包

发布时间:

推荐点击下方 阅读原文 使用语雀查看
文件夹,因为他们只在开发时使用 }



中的 files 可以这样写:


"files":?[

现在就只有 lib 文件夹下的才会上传到 npm 仓库啦,README.md 和 package.json 已经默认加入了。
增加测试:


npm?install?--save-dev?jest?@types/jest?ts-jest

编写配置文件 jest.config.js?如下


module.exports?=?{

增加 test 命令


"test":?

增加测试文件 src/__test__/Greeter.test.ts?如下


import?{?Greeter?}?

执行 test 命令查看
这里可以下载 vscode jest 插件,进行测试用例的实时结果查看
使用 npm 特殊命令:
对于一个优秀的包,我们应该将操作尽可能的自动化,接下来看几个特殊的命令:


命令操作备注
preparenpm run build在打包和发布之前运行,适合build
prepublishOnlynpm test && npm run lint在?prepare 之前,并且只有?npm publish 时才运行,这里应该执行测试和lint,保证我们不会发布不好的代码
preversionnpm run lint在新建 tag 之前运行
versionnpm run format && git add -A src在改了 tag 之后,但 commit 之前
postversiongit push && git push --tags在改了 tag 之后,commit 之后

最后如下,再添加上 main 和 types 字段
登陆你的 npm 账号,执行 npm publish 命令,注意要使用 npm 默认源哦
这样就发布成功了,也执行了 prepare 和 prepublishOnly 命令,下面使用 npm version patch 升级个版本看一下:
也看到如预期执行了命令,最后再 npm publish 一下,就能更新版本了。
最后使用包如下:


结语

学到了给 ts 写 lint 配置、jest 简单 ts 配置、npm 的特殊命令,是一个比较规范的包发布流程。
欢迎关注我的公众号,或语雀 https://www.yuque.com/zcue/blog :








相关资源:教你30秒发布一个TypeScript到NPM的方法步骤



友情链接: