首页 > 代码库 > 开发npm包

开发npm包

1、创建项目,使用npm init

name:填写你这个包的名字,默认是你这个文件夹的名字。
      注:最好先去npm上找一下有没有同名的包。也可以在命令行里面输入npm install 你要取的名字,如果报错,npm上没有跟你同名的包。
version:你这个包的版本,默认是1.0.0
description:包描述
entry point:入口文件,默认是index.js
test command:测试命令,这个直接回车就好了
git repository:这个是git仓库地址,如果你的包是先放到github上或者其他git仓库里,这时候你的文件夹里面会存在一个隐藏的.git目录,npm会读到这个目录作为这一项的默认值。如果没有的话,直接回车继续。
keyword:这个是一个重点,这个关系到有多少人会搜到你的npm包。尽量使用贴切的关键字作为这个包的索引。
author:写你的账号或者你的github账号
license:直接回车

 若不想输入这些,也可以直接使用 npm init -y

2、创建目录

  

├── bin           // 命令配置
├── README.md     // 说明文档
├── index.js      // 主入口
├── lib           // 目录下存放业务逻辑文件
├── package.json  // 包信息
└── test          // 目录下存放单元测试用例

 

3、开发模块

  3.1 局部安装
    所有的函数功能接口都由index.js暴露给外部

  入口文件index的开发:

‘use strict‘;

module.exports = function () {
    console.log(‘hello world‘);
};

 


  3.2.全局安装

    包全局安装的情况,一般是做自动化工具,关键在于配置全局命令,与index.js无关
    通过bin目录下与全局命令相同的js文件,写丰富的命令行可以引入commander

实例:

技术分享

 

mallcopy.js文件,在js文件顶部加上#!/usr/bin/env node

#!/usr/bin/env node


console.log(‘mallcopy‘);

在package.json文件中添加bin配置:

"bin": {
    "mallcopy": "./bin/mallcopy.js"
  },

 

全局安装包文件,执行mallcopy即可

 

4、发布npm包

  1. 申请个npm账号
  2.  npm login
  3. npm publish

开发npm包