如何编写一个npm包，可以公共使用？

JerryWangSAP 发布于2019-08-22 18:09 / 1693人阅读

摘要：经常开发的项目，文件大家应该都非常都清楚，所谓的依赖，就是逻辑的暴露，现在告诉大家怎么发布自己写的包，供全球人使用。

经常开发vue的项目，package.json文件大家应该都非常都清楚，所谓的依赖，就是js逻辑的暴露，现在告诉大家怎么发布自己写的npm包，供全球人使用。

npm包创建步骤 1.创建一个文件夹

mkdir test
cd test
npm init
然后一路回车即可

2.在test文件夹创建index.js（主入口文件）

index.js内容自定义即可
示例：

module.exports = function(options) {

const options = options || {};
return function(req, res, next) {
    console.log(req, res, next);
}

}

3.完善init初始化的package.json文件

name：包的名字，确保该名字是独一无二的
version：包的版本，默认是1.0.0
description：包的描述
main：入口文件，默认是index.js
test command：测试命令
repository：git仓库地址,一般为”type”:”git”,”url”:”git的url”
keyword：这个挺重要，尽量用比较贴切的关键字作为这个包的索引，这样才能有更多的人搜索到你的包
author：写你的账号或者你的github账号吧
license：开源协议用了哪个

4.添加LICENCE文件(我们选择MIT)

参考链接：https://spdx.org/licenses/MIT... & https://opensource.org/licens...
新建文件名称为：LICENSE 没有后缀
内容输入参考链接里面的text内容即可。
将和修改为对应的年份和版权拥有者名字

5.添加 README.md 文件和 .gitignore

README.md 文件主要用于该项目的一些说明，使用方法等
好看的版本信息参考链接：https://shields.io

6.发布npm包

首先，注册npm账号，链接：https://www.npmjs.com

其次，打开终端，到test目录，输入：npm adduser;然后输入npm whoami，如果出现注册名字，说明成功

最后，输入npm publish --access=public,即可发布成功

测试是否发布成功，直接 npm install 你的包名，或者去注册账户查看

如果更新版本，需要更改package.json里面的版本号，不然会报错

以上就是几步，希望大家能够开发自己想做的npm包。

GPU云服务器云服务器每周数百万下载量!NPM包修复了一个远程一个网站可以使用两个云主机吗一个网站可以使用两个云vps吗 NPM包管理器

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/95557.html

webpack工程化集成React技术栈（一）

项目开始前，我们先聊一聊关于项目的一些说明。该项目起始于2017年初，当时公司主要技术栈为gulp+angular，鉴于react的火热的生态，在公司决定研发bss管理系统时选用react开发，目的也是为react native打下基础，以解决后期公司大前端技术栈的逐步成熟。（当时没有选择vue开发的主要原因是weex生态还不够特别成熟），既然决定换新，项目的构建也跟着一起换，从gulp转向火热的...

tianhang 2019-08-22 14:47 评论0 收藏0
webpack4+vue2+axios+vue-router的多页+单页混合应用框架

摘要：适用于主要入口页面生成多页，子页面和次要页面使用单页形式的项目。文件用来存放固定的数据，而文件可更加自由的处理并返回数据。 VUE2的单页应用框架有人分享了，多页应用框架也有人分享了，这里分享一个单页+多页的混合应用框架吧，node.js写了一个简单的mock服务也集成在里面，整体初现雏形，还有很多需要优化和改善的地方。。。项目结构 │ ├─build ...

whatsns 2019-08-23 11:44 评论0 收藏0
基于webpack4的VUE多页脚手架

摘要：另外备注一部分参数的说明折叠有助于文档树中文本节点的空白区域对进行压缩默认默认按照不同文件的依赖关系来排序。敲黑板讲重点的当然目前这部分的文档在官网还不是很全，所以这里我们参考了印记中文的说明文档，指优化模块。链接写在前面为什么要自己手写一个脚手架？如何去思考遇到的问题？正文链接原文链接 github whale-vue ——写在前面 1、为什么要自己手写...

张金宝 2019-08-23 18:40 评论0 收藏0
npm入手笔记0x002-发布自己的Node.js模块及其版本管理

摘要：概述本篇文章承接上文，记录的是如何发布自己的模块编写模块新建项目并初始化编写模块代码发布模块测试模块命名空间每个人都可以发布自己的包，难免会有包名相同的情况，如果想要使 0x001 概述本篇文章承接上文，记录的是如何发布自己的Node.js模块 0x002 编写模块新建项目并初始化 $ mkdir 0x005-publish-own-module $ cd 0x005-publis...

mrli2016 2019-08-21 16:24 评论0 收藏0
从零开始创建 angularjs-gulp-es5 项目

摘要：为了动态插入新加的和文件且添加的文件有一定顺序，安装系列包。具体参见至此已经可以在本地愉快的开发了。配置编译任务开发完成以后代码需要上线，继续创建一些。有时间会加入校验添加，添加等等。。。源码地址：https://github.com/silence717/angular-gulp-seed 创建一个空文件夹名字任意，此项目为angular-gulp-seed mkdir angu...

hqman 2019-08-20 12:13 评论0 收藏0