未加星标

使用yarn制作npm包

字体大小 | |
[前端(javascript) 所属分类 前端(javascript) | 发布者 店小二03 | 时间 2016 | 作者 红领巾 ] 0人收藏点击收藏

MAC OSX

工具:Yarn ( npm install yarnpkg -g ),git

创建你的第一个NPM库

在创建你的第一个库之前,你需要了解什么是yarn。

打开终端,首先创建一个git仓库

git init RockSocket

进入 RockSocket 文件夹,执行:

yarn init

这将会询问你以下几个问题:

name (my-new-project): version (1.0.0): description: entry point (index.js): git repository: author: license (MIT):

可以选择回答或者直接按回车使用括号中的默认值(如果你想所有的东西使用默认值的话,可以直接使用 npm install --yes ,这样会跳过所有的问题)。

package.json

现在,在文件夹中应该出现了一个package.json,它大致的样式是这样子的:

{ "name":"RockSocket", "version":"1.0.0", "description":"RockSocket is a npm framework created by `yarn`", "main":"index.js", "repository": { "url":"https://github.com/wilddylan/rocksocket.git", "type":"git" }, "author":"Dylan <[email protected]>", "license":"MIT" }

这些值的含义分别是(这个文件你可以按照自己的意愿修改):

name:包的唯一标识,如果你这个包可以被别人使用,就必须确认这个名字是唯一的。

version:当前的版本,发布更新必须更改这个值。

description:包的描述,不是必须的值,这个用来帮助用户理解你的库的作用。

main:入口文件

repository:git仓库的地址,以后源代码也是存放在这里的。

author:作者,是有格式的,例如 dylan <[email protected]> (http://wilddylan.github.io) 。

license:规定了大家使用你代码的权限。

Additional fields

在 package.json 中你还有可能希望添加以下的一些字段:

{ "name":"RockSocket", "...":"...", "keywords": ["cool","useful","stuff"], "homepage":"https://RockSocket.com", "bugs":"https://github.com/you/RockSocket/issues", "contributors": [ "Your Friend <[email protected]> (http://their-website.com)", "Another Friend <[email protected]> (https://another-website.org)" ], "files": [ "index.js", "lib/*.js", "bin/*.js" ], "bin": { "rock-socket-cli":"bin/rock-socket-cli.js" } }

他们分别的含义是:

keywords:别的开发者可以通过这些关键字搜索到你的项目。

homepage:项目的主页,提供一些文档、说明等。

bugs:项目出现的问题,一般是github的issue的地址,可以引导大家去查看。

contributors:项目成员,可以被定义在这里。

files:文件的列表,可以用*来表示所有,规则跟shell的一样。

bin:yarn在安装时可以使用的图形化界面。

项目说明

一般写入到gith中ReadMe.md中,供大家参考。在创建项目的时候,保证库的简洁,同样需要注意你的库所依赖的库。

项目发布

首先要在npm注册一个account, 注册地址 ,紧接着,在当前文件夹下:

yarn login

会要求你提供刚刚输入的帐号以及邮箱,会在publish的时候问你询问密码,现在还不需要。

yarn publish

首先会让你输入自己的版本号,然后会要求输入刚刚帐号的密码,最后提示成功。

使用你上传的项目

在新的项目中:

yarn add RockSocket

也可以通过:

yarn info RockSocket

来查看自己库的信息,当然,在npmjs.com上也是可以看的到的。

本文前端(javascript)相关术语:javascript是什么意思 javascript下载 javascript权威指南 javascript基础教程 javascript 正则表达式 javascript设计模式 javascript高级程序设计 精通javascript javascript教程

分页:12
转载请注明
本文标题:使用yarn制作npm包
本站链接:http://www.codesec.net/view/483827.html
分享请点击:


1.凡CodeSecTeam转载的文章,均出自其它媒体或其他官网介绍,目的在于传递更多的信息,并不代表本站赞同其观点和其真实性负责;
2.转载的文章仅代表原创作者观点,与本站无关。其原创性以及文中陈述文字和内容未经本站证实,本站对该文以及其中全部或者部分内容、文字的真实性、完整性、及时性,不作出任何保证或承若;
3.如本站转载稿涉及版权等问题,请作者及时联系本站,我们会及时处理。
登录后可拥有收藏文章、关注作者等权限...
技术大类 技术大类 | 前端(javascript) | 评论(0) | 阅读(56)