发布和使用自己的NPM包

附件下载:发布和使用自己的NPM包.zip

NPM(node package manager) 是NodeJs官方提供的包管理工具,让开发者可以方便地下载、安装、升级、删除依赖包。因为NPM默认的镜像源(https://registry.npmjs.org) 在国外,下载会比较慢,一般会使用淘宝镜像,有两种使用方式:直接修改npm镜像源、下载cnpm。推荐下载使用cnpm,保留npm默认源。通过命令npm install -g cnpm --registry=https://registry.npm.taobao.org安装cnpm。大部分前端开发者应该都用过npm install命令下载依赖包,而发布命令npm publish用的比较少,接下来将通过一个实例来详细介绍如何发布npm包。

创建一个npm项目

  1. 创建一个新的文件夹并进入,本例文件夹名【yo-coder】,执行npm init命令初始化项目,执行命令后有一些信息要填,直接忽略,一路回车即可(后面可以修改),最后会在文件夹下生成一个package.json文件
{
    "name": "yo-coder", // 项目名称,在npm仓库中唯一
    "version": "1.0.0", // 版本号
    "description": "",  // 描述
    "main": "index.js", // 使用import yo from \'yo-coder\'导入时,yo指向的文件
    "scripts": {        // 自定义命令\r\n      \"test\": \"echo 这是一个测试命令\"
    },
    "author": "朽木",    // 作者
   "license": "MIT"     // 一种开源协议,作者只保留版权,其他的可以为所欲为
}
  1. 写一点代码
    为了演示方便,这里就简单的创建了一个index.js文件,导出两个方法
exports.yo = function() {
    alert('Yo Coder!')
} 
exports.hello = function() {
    alert('Hello Coder!')
}

发布到npm

  1. https://www.npmjs.com/signup 注册npm账号,如果有账号了请忽略

  2. 执行命令npm adduser,根据提示完成登录,登录后会在~/.npmrc文件里保存身份令牌,可以把这个文件拷贝到项目里,其他人直接指定这个配置文件进行发布,不用登录

  3. 执行命令npm publish发布

  4. 在npm网站上查看发布的包信息 https://www.npmjs.com/package/yo-coder

    查看npm仓库

  5. 在淘宝NPM镜像网站上查看发布的包信息 https://npm.taobao.org/package/yo-coder
    cnpm不会实时更新,目前的同步频率为10分钟同步一次,可以手动点击SYNC触发同步

    查看淘宝npm仓库

下载使用npm模块,以vue为例

如果你已经很熟悉vue或react这些项目,忽略以下内容吧

  1. 执行npm install -g vue-cli命令安装vue脚手架,使用vue -V命令验证是否安装成功
  2. 执行vue init webpack yo-coder-test初始化vue项目,这里项目名为【yo-coder-test】,一路回车后,会自动开始下载依赖包,因为默认是从npm源下载依赖包,会比较慢,按ctrl c取消下载,进入目录,手动使用cnpm install命令下载依赖包
  3. 执行npm run dev命令启动vue项目,浏览器打开localhost:8080查看vue的欢迎界面
  4. 执行npm install --save yo-coder命令,执行成功后会在package.json里记录依赖的包,方便下次直接执行npm install命令下载依赖包。install命令中的--save是运行时依赖,记录在在dependencies下,比如antd、element-ui等;--save-dev是开发时依赖,记录在devDependencies下,比如webpack、eslint等
  5. 使用yo-coder模块,直接在App.vue里测试,效果就是一个简单的alert


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

推荐阅读更多精彩内容