创建属于自己的NPM包

245 阅读2分钟

1、创建NPM账号

这一步很简单,只需访问npm官网创建一个账号

2、开始创建属于自己的NPM包

2.1、npm init

在执行这一步前,先给自己的第一个NPM取一个名字,命名需要注意以下规范:

1、不要与已存在的其他npm包重名 2、包名不能出现大写 3、不能混淆作者身份 4、符合npm标准,不能有冒犯性的命名,或是别人的商标名 5、在package.json文件的相应行中指定名称。

在自己的npm包目录下执行npm init命令,按提示一步一步输入即可。其中必填的只有三项

name:npm包名,不可以出现大写 version:npm包版本号,默认1.0.0 main: npm包入口文件,默认index.js

填完后目录下生成package.json 详细的package.json配置说明见https://docs.npmjs.com/getting-started/using-a-package.json

2.2、开始编写npm包

在目录下的index.js,即配置的main入口编写代码,先来一行简单的代码:

var sayHello = function (msg) {
  console.log(msg || 'Hello, world!')
}

module.exports = sayHello

至此,一个简单的npm包就已经写完了,接下来就可以发布了。

2.3、开始发布自己的npm包

1、运行npm login输入第一步中创建的npm账号,通过npm whoami检验当前登入的npm账号。确认账号已注册可访问https://npmjs.com/~username。 2、如果你的npm包目录下有很多文件,需要忽略一些文件不上传,可以添加.gitignore文件到根目录,添加需要忽略的目录或文件到.gitignore:

ignoreFile01
ignoreDirectory02

3、创建一个readme.md,给你的包做个说明,告诉别人怎么使用你的包 4、现在可以运行npm publish发布你自己的npm包了。成功后的提示:

+ your-package-name@1.0.0

2.4、用一用自己的npm包

访问https://npmjs.com/package/即可看到你自己的npm包了,像使用其他所有npm包那样, 运行npm i yourPackageName即可下载自己的npm包并使用了!

2.5、更新自己的npm包

修改了自己的npm包后需要重新发布: 1、运行npm version <update_type>,已存在的版本号不允许重复。运行完命令,新的版本号会反应到目录下的package.json。 2、改变版本后运行npm publish即可更新自己的npm包。

至此,如何创建属于自己的NPM包完结 测试案例:

www.npmjs.com/package/win…