发布一个 npm 工具包
初始化项目
winpty vue.cmd create patrick-utils
选择 default 配置
新建一个 utils 目录,下面 index.js
//index.js
function sum(a, b) {
return a + b;
}
export { sum };
修改 packge.json 配置
{
"name": "patrick-utils",
"private": false,
"version": "1.0.0",
"license": "MIT",
"scripts": {
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
"lint": "vue-cli-service lint",
"package": "vue-cli-service build --target lib --name baseComFuncs ./src/utils/index.js"
},
"main": "/dist/baseComFuncs.umd.min.jss"
}
配置说明
-
name npm 的包名,发布成功后可以在 npm 官网 上搜索
-
private->false 设置为公开
-
version 版本号 每次发布版本号必须更新
-
添加 license MIT
-
scripts 中添加编译项 "package": "vue-cli-service build --target lib --name baseComFuncs ./src/utils/index.js"
--targer lib 代表打包成库文件
--name index 打包生成文件的名称
./src/utils/index.js 代码的入口文件地址
-
添加 main: "/dist/baseComFuncs.umd.min.js" 入口文件
npm 包发布流程
- 查看当前的 npm 源 npm config get registry npmjs.com
- npm login 然后输入账号密码 登录
- npm publish 发布,成功后命令行会有提示信息
- npm unpublish 撤回 npm 包
使用方法
使用说明
- npm install patrick-utils
- import * as utils from 'patrick-utils'
- 开始使用 utils 中各种方法
- 更新方法 npm update patrick-utils
本地开发调试说明
- npm 包项目目录下执行 npm link
- 需要使用 npm 包的项目下执行 npm link patrick-utils
- 以下同使用说明步骤 2 及以下
目前的提供的方法
- testPhone 校验是否为合法手机号
- testIdCard 校验是否为合法身份证号
- testEmail 校验是否为合法邮箱
- testCnName 校验是否为中文
- testEnName 校验是否为英文
- testSocialCode 校验是否为合法统一社会信用代码
- translateTime 转换时间为 YYYY-MM-DD HH:mm:ss 格式
其他
修改 readme.md ,描述包的安装方法以及使用方法