使用npm写一个自己的工具依赖包：riven-tools

一、创建一个项目文件夹riven-tools

1. 项目文件夹下包含三个文件：index.js、package.json、README.md，以及一个文件夹：src

   项目结构如下：

   

二、初始化package.json文件

{
    "name": "riven-tools",
    "version": "1.0.0",
    "main": "index.js",
    "description": "riven自己写的一些小工具",
    "keywords": ["riven","Riven","tools","Tools"],
    "license": "ISC"
}

1. name是依赖包的名字
2. version是版本
3. main是程序的入口文件
4. description是依赖包的介绍
5. keywords是依赖包的搜索关键字
6. license是依赖包的开源协议

三、初始化工具文件

1. 在src文件夹下创建：dateFormat.js文件，这个文件里面放的是格式化时间的js文件

   function dateFormat(date) {
       date = new Date(date);
       if (!date) return console.error('error:', 'Parameter error, invalid date');
       let result = {
           isStr: false,
           yyyy: padZero(date.getFullYear()),
           MM: padZero(date.getMonth() + 1),
           dd: padZero(date.getDate()),
           HH: padZero(date.getHours()),
           mm: padZero(date.getMinutes()),
           ss: padZero(date.getSeconds()),
       };
   
       let d = new Date(date).setHours(0, 0, 0, 0);
       let today = new Date().setHours(0, 0, 0, 0);
   
       if (d - today == -86400000) {
           result.isStr = '昨天';
       } else if (d - today == 0) {
           result.isStr = '今天';
       }
   
       return result;
   }
   
   // 补0函数
   function padZero(n) {
       return n > 9 ? ''+n : '0' + n;
   }
   
   // 给外界暴露dateFormat函数
   module.exports = {
       dateFormat
   }
   

四、初始化index.js文件

index.js是我们的入口文件，我们需要在这个文件里导入我们的功能模块，并且把功能模块里的属性暴露出去。

// 包的入口文件
const date = require('./src/dateFormat')

// 使用...展开date里面的属性，暴露给外界
module.exports = {
    ...date
}

五、编写README.md文档

## 安装方式 ##
````shell
npm install riven-tools
````
## 导入方式 ##
````js
const riven = require('riven-tools')
````

## 使用 ##
#### 1、格式化时间 ####
传入时间，得到一个对象
````js
const result = riven.dateFormat('2022-1-24 12:12:12')
console.log('格式化得到的时间：', result);
````
结果如下：
````bash
格式化得到的时间： {
  isStr: false, // 如果时间是今天或昨天，siStr属性='今天'||'昨天',否则为false
  yyyy: '2022',
  MM: '01',
  dd: '24',
  HH: '12',
  mm: '12',
  ss: '12'
}
````

### 开源协议 ###
ISC

六、发布包

1. 注册npm账号：www.npmjs.com/

2. 在终端里登录npm账号

   npm账号注册完成后，可以在终端中执行npm login命令，依次输入用户名、密码、邮箱后，即可登录成功。

   注意:在运行npm login命令之前，必须先把下包的服务器地址切换为npm的官方服务器。否则会导致发布包失败!

   

3. 发布包

   • 首先我们需要cd到我们自定义依赖包的根目录

   • 然后运行npm publish命令发布

     

   • 然后我们就能在npm官网上面看到我们的包了

     

七、删除已经发布到npm上的依赖包

我们可以运行以下命令删除我们发布的包：

npm unpublish 包名 --force

注意：

1. 此命令只能删除发布72小时内的包
2. 此命令发布的包24小时内不能再发布
3. 发包要慎重，不要发没有意义的包