3、如何发布一个包

大炮不想学习

已于 2023-07-22 17:13:41 修改

阅读量315

点赞数

分类专栏： 04、node.js学习文章标签：开发语言 javascript

于 2022-04-08 13:43:27 首次发布

本文链接：https://blog.csdn.net/weixin_48137421/article/details/124001032

版权

04、node.js学习专栏收录该内容

9 篇文章 0 订阅

订阅专栏

1初始化基础的包结构

1.1初始化包结构

1.2初始化package.json

1.3在index.js中定义初始化时间的函数

npm login:登录npm账号

npm publish:发布包到npm上

npm unpublish 包名 --force:从npm删除已发布的包

1初始化基础的包结构

1.1初始化包结构

新建itheima-tools文件夹，作为包的根目录，在itheima-tools文件夹中，新建如下三个文件:

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

1.2初始化package.json

{
    "name": "itheima-tools",
    "version": "1.0.0",
    "main": "index.js",
    "description": "提供了格式化时间，HTMLEscape的功能",
    "keywords": ["itheima", "dateFormat", "escape"],
    "license": "ISC"
}

1.3在index.js中定义初始化时间的函数

1.4转义html中的特殊字符

为了防止用户在提交表单的时候提交一些html的标签。

在index.js中定义转义html的方法

function htmlEscape(htmlStr) {
    return htmlStr.replace(/<|>|"|&/g, (match) => {
        switch (match) {
            case '<':
                return '&lt;'
            case '>':
                return '&gt;'
            case '"':
                return '&quot;'
            case '&':
                return '&amp;'
        }

    })
}

在index.js中定义还原html的方法

function htmlUnEscape(str) {
    return str.replace(/&lt;|&gt;|&quot;|&amp;/g, (match) => {
        switch (match) {
            case '&lt':
                return '<;'
            case '&gt':
                return '>;'
            case '&quot':
                return '";'
            case '&amp':
                return '&;'
        }

    })

}

2将不同的功能进行模块化拆分

将格式化时间的功能，拆分到src -> dateFormat.js 中
将处理HTML字符串的功能，拆分到src -> htmlEscape.js 中
在index.js中，导入两个模块，得到需要向外共享的方法
在index.js中，使用module.exports把对应的方法共享出去

3编写包的说明文档

包根目录中的README.md 文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以markdown的格式写出来，方便用户参考。包含6个部分：安装方式、导入方式、格式化时间、转义HTML中的特殊字符、还原HTML 中的特殊字符、开源协议

## 安装
```
npm install itheima-tools

```

## 导入
```js
const itheima = require('./index.js')
```

## 格式化时间
```js
// dateFormat对时间进行格式化
const dtStr = itheima.dateFormat(new Date())
// 结果 2022-04-08 00:06:02
console.log(dtStr)
```
## 转义HTML中的特殊字符
```js
// 待转换的html字符串
const htmlStr = '<h1 title="abd">这是h1标签<span>123&nbsp</span></h1>'
// 调用htmlEscape方法进行转换
const str = itheima.htmlEscape(htmlStr)
// 结果 &lt;h1 title=&quot;abd&quot;&gt;这是h1标签&lt;span&gt;123&amp;nbsp&lt;/span&gt;&lt;/h1&gt;
console.log(str)
```
## 还原HTML中的特殊字符
```js
// 调用htmlUnEscape方法进行还原
const str2 = itheima.htmlUnEscape(htmlStr)
// 结果 <h1 title="abd">这是h1标签<span>123&nbsp</span></h1>
console.log(str2)
```
## 开源协议
ISC