开发npm包模板

终端创建


创建文件夹,打开文件夹,

npm init   //开始创建,或者是npm init -y 这是直接自动生成package.json文件,那个是手动。
name就是包的名字,自己去设计,最好是搜索很容易,最关键的是没占用,跟域名一个道理,占用了就报错了。
version 就是版本,每一次修改保存,版本号都要变的。
description对这个包的描述
entry point默认运行文件
剩下的可以不用管,后续直接修改package.json文件也可以的。

发布流程


刚刚填的信息都有的。后续可以补充的。可以再终端输入npm init命令:

再看看文件改了没

里面的main就是包作用的入口文件,默认的是index.js。所以我们需要有这样一个文件的。创建,,,
路径啊,文件内容啊,如图

这里只是简单地学着发布上线如何的。不深究的。
如何发布?
发布到npm,就要先登录自己的账号,然后再发布的。



我先转到国外的正规地址,免得报错了,如果有错,可能就是不是官网地址而是国内山寨的那个下载地址。
登录了,就发布吧,
npm publish

问题又有了,报错,,,提示说这个包的名字已经存在了,不行的,域名也一样。
所以我就回package.json文件把文件名改一下,最好是名字不错,容易被索引,而且没被占用。改成weather-do-cli,再发布试试。


成功了。

再去npm官网查查看,,,


但是没有使用说明啊,开始写使用说明,再回到文件目录下,新建文件README.md,如图,编辑:

改了,就要重新发布,发布的版本就要改一下了,1.0.1。


别人如何用呢??
演示一下。。。

细化如何使用

先创建一个作用对象的文件,命令操作如图:

打开这个index.js文件去调用这个包操作试试看,,,

这时候自己想想,在终端输入node index.js可以吗?
肯定不行啊,这个npm包你还没有安装到本地目录下,先去安装,教程都说了的,,,


test目录下加载了node_modules文件了。
这时候,才可以用这个包了。

node index.js

输出了这个包里的index.js的那个'haha',成了吧!
这个时候,这个包只能引入到目录文件用,我想像http-server一样当成命令去用,怎么办?

包如何变成命令,再在终端全局调用

步骤很简单,正好对应了它的原理。
在包的package.json文件里加入

"bin":{
"my-weather":"./index.js"
}

有什么阴谋?这句话的意思是,一旦全局安装,-g 形式安装,系统看到这句话,就会把下载模块放到(mac的)usr/local/lib/node_module/下,这里是包的储存地址,调用包的时候,输入一个命令,这个命令就去usr/local/bin/里找对应的标签名,这个标签是个指针指向包文件,所以,除了下载了包,必须还在bin里生成了一个指针指向这个包,这个指针在这里就是my-weather。bin里的指针都是环境变量,全局视野的。

同时,要告诉系统这个命令是要在node环境下运行,所以,在包的index.js首部加入

#!/usr/bin/env node 

有了这句话,输入命令时前面就不需要加node了。

然后,再更新一下版本号,发布一下。



测试一下,随便一个路径,全局安装:



看看安装的那些点,满满的都是套路啊。
试一试,

命令是bin里设置的键值,,,

my-weather

完成了。。。。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容