开发属于自己的包

 

1. 需要实现的功能

格式化日期

转义HTML中的特殊字符

还原HTML中的特殊字符

 

 

 

 

2. 初始化包的基本结构

新建it-tools文件夹,作为包的根目录

在it-toole文件夹中,新建如下的三个文件:

  • package.json (包配置文件)
  • index.js(包的入口文件)
  • README.md(包的说明文档)

 

 

3. 初始化package.json

 

 

4.  在index. js中定义格式化时间的方法

 

 接收

 

 

 

5.了解package.json中的main属性的main

 

 node会在文件夹找到package.json的main属性找路径

 

 

6. 在index.js中定义转义HTML的方法

 

 

 

 

7. 将不同的功能进行模块化拆封

1. 将格式化时间的功能,拆分到src -> dateFormat.js中

 

2. 将处理HTML 字符串的功能, 拆分到 src -> htmlEscape.js中

3. 在index.js 中,导入两个模块,得到需要向外共享的方法

4. 在index.js中,使用module.exports把对象的方法共享出去

 

 

 

 因为date,escape接受的是对象,可以用三个点展开

 

 

 

8.  编写包的说明文档

包根目录中的README.md文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以markdown的格式写出来,方便用户参考。README文件中具体写什么内容,没有强制性的要求;只要能清晰地把包地作用、用法,注意事项等描述清楚即可。

 

posted @ 2021-12-11 20:33  漫漫长路</>  阅读(17)  评论(0编辑  收藏  举报