如何将自己写的代码同步到github并发布到npm
1. 很明显,先注册NPM和github账号过程省略,进入各自的官网,创建账号2. 写代码默认你已经安装了node环境,node环境也包括了npm环境新建工程文件夹,然后执行下面的命令,初始化一个package.json文件npm init -y{"name": "a-string-is-null-empty-undefined","version":...
1. 很明显,先注册NPM和github账号
过程省略,进入各自的官网,创建账号
2. 写代码
默认你已经安装了node环境,node环境也包括了npm环境
新建工程文件夹,然后执行下面的命令,初始化一个package.json文件
npm init -y
{
"name": "a-string-is-null-empty-undefined",
"version": "1.0.0",
"description": "A package for judging a string is null or empty or undefined",
"main": "index.js",
"repository": "https://github.com/yorcent/string-is-null-empty-undefined.git",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [
"yorcent",
"string",
"isNullOrEmpty",
"undefined"
],
"author": "yorcentluo",
"license": "ISC"
}
"main"这一项 是默认的js入口文件, 可以修改。
"repository"这一项暂时不填,一会你创建了对应的github仓库再填进去对应的仓库地址
新建index.js文件,编写代码,如:
const stringJudgement = {
isNull (string) {
return string === null
},
isEmpty (string) {
return string === ''
},
isUndefined (string) {
return string === undefined
},
isNullOrEmptyOrUndefined (string) {
return string === null || string === '' || string === undefined
}
}
module.exports = stringJudgement
新建test.js文件,如:
const stringJudgement = require('./index')
console.log(stringJudgement.isNullOrEmptyOrUndefined(''))
控制台执行
node test
检查执行结果,初步测试通过
注意: 一般如果你的npm包有比较方便的测试代码或者用例,更能吸引开发者使用你发布的npm包。所以,一个优秀的npm包还需要更完善的测试环境。这里暂时不深入展示。
新建README.md文件
# stringJudgement
判断一个字符串是否为null, 或空字符串,或undefined
# install
npm install -g string-is-null-empty-undefined
#github
#usage
const stringJudgement = require('./index')
console.log(stringJudgement.isNullOrEmptyOrUndefined(''))
README.md文件 是方便开发者快速的了解和学习如何使用你这个npm包,非常重要。
3. 将代码上传至github仓库
这个方法有三种,这里使用其中一种。
1.1 新建git仓库
1.2 将新建好的git仓库地址克隆到本地
1.3 将之前创建的npm包的代码文件夹丢到git仓库克隆后的文件夹内,和.git文件在同一级目录
1.4 执行以下命令
git add .
git commit -m "init commit"
git push
git push -u origin master
4.将github仓库地址复制到npm包的package.json里的“repository”中
"repository": "https://github.com/yorcent/string-is-null-empty-undefined.git",
5. 执行以下命令将完整和正确的代码发布到npm
npm login
// 输入npm账号名
// 输入npm密码
// 输入npm邮箱
npm publish
6. 验证发布是否成功
首先npm publish 之后 会返回给你发布包的名称和版本
如果没有返回则发布失败,需要重新发布;或者如果你又修改了代码,重新发布的话你需要包的名字重新发布
然后你试着npm install -s packageName 检查是否安装到了node-modules目录。然后你可以开始调用你的写的方法
7. 踩坑
如果你将你的npm镜像改成了淘宝镜像,那么需要将镜像改回城 npm官方镜像,然后再重新npm login, 否则会发布失败。
更多推荐
所有评论(0)