这篇文章主要介绍“如何创建并发布npm包”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“如何创建并发布npm包”文章能帮助大家解决问题。创建一个新项目,包含package.json
{ "name":"drrq", "type":"module", "version":"1.0.0" }
npm i qs axios主要思路是用请求的url和参数作为key记录请求队列,当出现重复请求时,打断后面的请求,将前面的请求结果返回时共享给后面的请求。
importqsfrom"qs"; importaxiosfrom"axios"; letpending=[];//用于存储每个ajax请求的取消函数和ajax标识 lettask={};//用于存储每个ajax请求的处理函数,通过请求结果调用,以ajax标识为key //请求开始前推入pending constpushPending=(item)=>{ pending.push(item); }; //请求完成后取消该请求,从列表删除 constremovePending=(key)=>{ for(letpinpending){ if(pending[p].key===key){ //当前请求在列表中存在时 pending[p].cancelToken();//执行取消操作 pending.splice(p,1);//把这条记录从列表中移除 } } }; //请求前判断是否已存在该请求 constexistInPending=(key)=>{ returnpending.some((e)=>e.key===key); }; //创建task constcreateTask=(key,resolve)=>{ letcallback=(response)=>{ resolve(response.data); }; if(!task[key])task[key]=[]; task[key].push(callback); }; //处理task consthandleTask=(key,response)=>{ for(leti=0;task[key]&&i{ letkey=url+'?'+qs.stringify(params); returnnewPromise((resolve,reject)=>{ constinstance=axios.create({ baseURL:url, headers, timeout:30*1000, }); instance.interceptors.request.use( (config)=>{ if(preventRepeat){ config.cancelToken=newaxios.CancelToken((cancelToken)=>{ //判断是否存在请求中的当前请求如果有取消当前请求 if(existInPending(key)){ cancelToken(); }else{ pushPending({key,cancelToken}); } }); } returnconfig; }, (err)=>{ returnPromise.reject(err); } ); instance.interceptors.response.use( (response)=>{ if(preventRepeat){ removePending(key); } returnresponse; }, (error)=>{ returnPromise.reject(error); } ); //请求执行前加入task createTask(key,resolve); instance(Object.assign({},{method},method==='post'||method==='put'?{data:!uploadFile?qs.stringify(params):params}:{params})) .then((response)=>{ //处理task handleTask(key,response); }) .catch(()=>{}); }); }; exportconstget=(url,data={},preventRepeat=true)=>{ returnrequest('get',url,data,getHeaders,preventRepeat,false); }; exportconstpost=(url,data={},preventRepeat=true)=>{ returnrequest('post',url,data,postHeaders,preventRepeat,false); }; exportconstfile=(url,data={},preventRepeat=true)=>{ returnrequest('post',url,data,fileHeaders,preventRepeat,true); }; exportdefault{request,get,post,file};
示例入口index.js
import{exampleRequestGet}from'./api.js'; constexample=async()=>{ letres=awaitexampleRequestGet(); console.log('请求成功'); }; example();
api列表api.js
import{request}from'./request.js'; //示例请求Get exportconstexampleRequestGet=(data)=>request('get','/xxxx',data); //示例请求Post exportconstexampleRequestPost=(data)=>request('post','/xxxx',data); //示例请求Post不去重 exportconstexampleRequestPost2=(data)=>request('post','/xxxx',data,false); //示例请求Post不去重 exportconstexampleRequestFile=(data)=>request('file','/xxxx',data,false);
全局请求封装request.js
importdrrqfrom'../src/index.js'; constbaseURL='https://xxx'; //处理请求数据(拼接url,data添加token等)请根据实际情况调整 constparamsHandler=(url,data)=>{ url=baseURL+url; data.token='xxxx'; return{url,data}; }; //处理全局接口返回的全局处理相关逻辑请根据实际情况调整 constresHandler=(res)=>{ //TODO未授权跳转登录,状态码异常报错等 returnres; }; exportconstrequest=async(method,_url,_data={},preventRepeat=true)=>{ let{url,data}=paramsHandler(_url,_data); letres=null; if(method=='get'||method=='GET'||method=='Get'){ res=awaitdrrq.get(url,data,preventRepeat); } if(method=='post'||method=='POST'||method=='Post'){ res=awaitdrrq.post(url,data,preventRepeat); } if(method=='file'||method=='FILE'||method=='file'){ res=awaitdrrq.file(url,data,preventRepeat); } returnresHandler(res); };
代码写完后,我们需要验证功能是否正常,package.json加上
"scripts":{ "test":"nodeexample" },
执行npm run test功能正常,工具库准备完毕。(eslint和prettier读者可视情况选用)一般项目的打包使用webpack,而工具库的打包则使用rollup通过下面的命令安装 Rollup:
npminstall--save-devrollup
创建配置文件在根目录创建一个新文件 rollup.config.js
exportdefault{ input:"src/index.js", output:{ file:"dist/drrp.js", format:"esm", name:'drrp' } };
input —— 要打包的文件output.file —— 输出的文件 (如果没有这个参数,则直接输出到控制台)output.format —— Rollup 输出的文件类型如果要使用 es6 的语法进行开发,还需要使用 babel 将代码编译成 es5。因为rollup的模块机制是 ES6 Modules,但并不会对 es6 其他的语法进行编译。rollup-plugin-babel 将 rollup 和 babel 进行了完美结合。
n免费云主机、域名pminstall--save-devrollup-plugin-babel@latest npminstall--save-dev@babel/core npminstall--save-dev@babel/preset-env
根目录创建 .babelrc
{ "presets":[ [ "@babel/preset-env", { "modules":false } ] ] }
rollup 提供了插件 rollup-plugin-commonjs,以便于在 rollup 中引用 commonjs 规范的包。该插件的作用是将 commonjs 模块转成 es6 模块。rollup-plugin-commonjs 通常与 rollup-plugin-node-resolve 一同使用,后者用来解析依赖的模块路径。安装模块
npminstall--save-devrollup-plugin-commonjsrollup-plugin-node-resolve
添加 UglifyJS 可以通过移除注上释、缩短变量名、重整代码来极大程度的减少 bundle 的体积大小 —— 这样在一定程度降低了代码的可读性,但是在网络通信上变得更有效率。安装插件用下面的命令来安装 rollup-plugin-uglify:
npminstall--save-devrollup-plugin-uglify
rollup.config.js 最终配置如下
importresolvefrom'rollup-plugin-node-resolve'; importcommonjsfrom'rollup-plugin-commonjs'; importbabelfrom'rollup-plugin-babel'; import{uglify}from'rollup-plugin-uglify'; importjsonfrom'@rollup/plugin-json' constpaths={ input:{ root:'src/index.js', }, output:{ root:'dist/', }, }; constfileName=`drrq.js`; exportdefault{ input:`${paths.input.root}`, output:{ file:`${paths.output.root}${fileName}`, format:'esm', name:'drrq', }, plugins:[ json(), resolve(), commonjs(), babel({ exclude:'node_modules/**', runtimeHelpers:true, }), uglify(), ], };
在package.json中加上
"scripts":{ "build":"rollup-c" },
即可执行npm run build将/src/index.js打包为/dist/drrq.js准备npm账号,通过npm login或npm adduser。这里有一个坑,终端内连接不上npm源,需要在上网工具内复制终端代理命令后到终端执行才能正常连接。完整的package.json如下
{ "name":"drrq", "private":false, "version":"1.3.5", "main":"/dist/drrq.js", "repository":"https://gitee.com/yuanying-11/drrq.git", "author":"it_yuanying", "license":"MIT", "description":"能自动取消重复请求的axios封装", "type":"module", "keywords":[ "取消重复请求", ], "dependencies":{ "axios":"^1.2.0", "qs":"^6.11.0" }, "scripts":{ "test":"nodeexample", "build":"rollup-c" }, "devDependencies":{ ... } }
name 包名称 一定不能与npm已有的包名重复,想一个简单易记的private 是否为私有version 版本main 入口文件位置repository git仓库地址author 作者license 协议description 描述keywords 关键词,便于检索每个 npm 包都需要一个版本,以便开发人员在安全地更新包版本的同时不会破坏其余的代码。npm 使用的版本系统被叫做 SemVer,是 Semantic Versioning 的缩写。不要过分担心理解不了相较复杂的版本名称,下面是他们对基本版本命名的总结:
给定版本号 MAJOR.MINOR.PATCH,增量规则如下:MAJOR 版本号的变更说明新版本产生了不兼容低版本的 API 等,MINOR 版本号的变更说明你在以向后兼容的方式添加功能,接下来PATCH 版本号的变更说明你在新版本中做了向后兼容的 bug 修复。表示预发布和构建元数据的附加标签可作为 MAJOR.MINOR.PATCH 格式的扩展。最后,执行npm publish就搞定啦关于“如何创建并发布npm包”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识,可以关注云技术行业资讯频道,小编每天都会为大家更新不同的知识点。
相关推荐: jquery a标签不能点的原因有哪些及怎么解决
本篇内容主要讲解“jquery a标签不能点的原因有哪些及怎么解决”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“jquery a标签不能点的原因有哪些及怎么解决”吧! 免费云主机、域名 以下是可能出现的原因及解决方…