如何开发属于自己的包

最新推荐文章于 2024-10-07 20:56:37 发布

麦多馅饼

最新推荐文章于 2024-10-07 20:56:37 发布

阅读量388

点赞数

分类专栏： node.js 文章标签： npm 前端 node.js

本文链接：https://blog.csdn.net/zhang1509123907/article/details/122779360

版权

node.js 专栏收录该内容

20 篇文章 3 订阅

订阅专栏

本文介绍了如何创建一个npm包，包括初始化目录结构，编写package.json、index.js和README.md文件，实现时间格式化和HTML转义功能。详细步骤涵盖了包的发布流程，如设置许可证、注册npm账号、登录、发布及删除包的操作。此外，还讲解了src目录下两个核心功能模块的实现代码。

摘要由CSDN通过智能技术生成

初始化的包的基本结构

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

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

package.json文件

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

name（包的名字）
version （包的版本号）
main （包的入口）
description （包的简短描述信息）
keywords （包的搜索关键字）
license （包所遵循的开源许可协议）

关于更多license许可协议相关内容，可参考

https://www.jianshu.com/p/86251523e898

index.js文件

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

//向外暴露需要的成员
module.exports = {
    ...date,
    ...escape
}

README.md文件

##安装
```
npm install testtool
```

##导入
```js
const testtool = require('testtool')
```

##格式化时间
```js
//调用dateFormat
const dtStr = testtool = testtool.dateFormat(new Date())
//结果 2022-01-19 22:58:04
console.log(dtStr)
```

## 转义HTML中的特殊字符
```js
// 带转换的HTML字符串
const htmlStr1 = '<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>'
//调用htmlEscape 方法进行转换
const str1 = testtool.htmlEscape(htmlStr1)
// 转换的结果&lt;h1 title=&quot;abc&quot;&gt;这是h1标签&lt;span&gt;123&amp;nbsp;&lt;/span&gt;&lt;/h1&gt;
console.log(str1)
```

## 还原HTML中的特殊字符
```js
//待还原的HTML字符串
const str2 = testtool.htmlUnEscape(str)
//输出的结果<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>
console.log(str2)
```

## 开源协议
ISC

src文件夹下的两个文件

dateFormat.js文件

// 定义格式化时间的函数
function dateFormat(dtStr) {
    const dt = new Date(dtStr)

    const y = dt.getFullYear()
    const m = padZero(dt.getMonth() + 1)
    const d = padZero(dt.getDate())

    const hh = padZero(dt.getHours())
    const mm = padZero(dt.getMinutes())
    const ss = padZero(dt.getSeconds())

    return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}

//定义补零函数
function padZero(n) {
    return n > 9 ? n : '0' + n
}

module.exports = {
    dateFormat
}

htmlEscape.js文件

//定义转义HTML字符的函数
function htmlEscape(htmlstr) {
    return htmlstr.replace(/<|>|"|&/g, match => {
        switch (match) {
            case '<':
                return '&lt;'
            case '>':
                return '&gt;'
            case '"':
                return '&quot;'
            case '&':
                return '&amp;'
        }
    })
}

//定义还原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 '&'
        }
    })
}

module.exports = {
    htmlEscape,
    htmlUnEscape
}