nodeJs 自定义包和 package.json文件解释

[TOC]

### 自定义包
#### 包的规范
+ package.json必须在包的顶层目录下（强制要求规范）
+ 二进制文件应该在bin目录下
+ javascript代码应该在lib目录下
+ 文件应该在doc目录下
+ 单元测试应该在test目录下

#### package.json

##### 生成package.json文件命令

```Shell
npm init -y
```
##### package.json文件说明
```json
{
  "name": "nodejs",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}
```
|属性|说明|
|--|--|
|name|包名称，必须是唯一的，由小写英文字母、数字和下划线组成，不能包含空格|
|version|版本字符串|
|description|包的简要说明|
|keywords|关键字数组，用于搜索|
|maintainers|维护者数组，每个元素包含name，email`可选`、web`可选`|
|contributors|贡献者数组，格式和maintainers相同，包的作者是共享者数组的第一个元素|
|bugs|提交bug的地址，可以是网站或者邮箱|
|licenses|许可证数组，每个元素要包含type`许可证名称`和url`链接到许可证文本的地址`|
|repositories|仓库托管地址数组，每个元素要包含type`仓库类型，如git`、url`仓库地址`和path`相对于仓库的路径，可选`|
|dependencies|生成环境包的依赖，一个关联数组，由包的名称和版本号组成|
|devDependencies|开发环境包的依赖，一个关联数组，由包的名称和版本号组成|
|main|入口文件|

### 自定义包案例
实现一个markdown文件转换为html文件的案例
#### 第一步安装转换插件markdown-it
```Shell
npm install markdown-it
```
#### 第二步准备文件

+ markdown文件

```md
# 一级标题
## 二级标题
### 三级标题

- 列表一
 + 列表二
  * 列表三
```

+ html模板文件

```html
<!DOCTYPE html>
<html>
<head>
    <title>markdown文件转换</title>
</head>

<body>
    <%=content%>
</body>
</html>
```
#### 第三步实现转换功能

```Shell
node .
```

使用上面的命令执行下面的文件

```js
let path = require("path");
let fs = require("fs");
let md = require('markdown-it')();
let mdFilePath = path.join(__dirname, "00-temp/demo.md")
let tempPath = path.join(__dirname, "00-temp/mdTemplate.html")
let mdSavePath = path.join(__dirname, "00-temp/demo.html")
fs.readFile(mdFilePath, "utf8", (err, filedata) => {
    if (err) return
    let changedata = md.render(filedata)
    fs.readFile(tempPath, "utf8", (error, tempData) => {
        if (error) return
        tempData = tempData.replace("<%=content%>", changedata)
        fs.writeFile(mdSavePath, tempData, "utf8", (saveerror) => {
            if (saveerror) console.log(saveerror)
        })
    })
})
```

结果会在00-temp目录下面生成一个demo.html文件

```html
<!DOCTYPE html>
<html>
<head>
    <title>markdown文件转换</title>
</head>
<body>
    <h1>一级标题</h1>
    <h2>二级标题</h2>
    <h3>三级标题</h3>
    <ul>
        <li>列表一</li>
    </ul>
    <ul>
        <li>列表二</li>
    </ul>
    <ul>
        <li>列表三</li>
    </ul>
</body>
</html>
```