zhlint

一个中文内容的格式化工具。

如何安装

您可以通过 npm 或 yarn 安装 zhlint：

``bash


通过 npm 安装

npm install zhlint -g

或通过 yarn

yarn global add zhlint

或通过 pnpm

pnpm add zhlint -g
`

用法

$3

`bash


Glob 文件，执行格式化命令，并打印错误报告，




如果有任何错误被发现，则会以错误码 1 退出。

zhlint

Glob 文件，并修复所有可能发现的错误。

zhlint --fix

格式化文件并将修复后的内容输出到另一个文件。

zhlint --output=

打印用法信息

zhlint --help
`

错误报告看起来像这样：


#### 高阶用法

zhlint 还支持 rc 和 ignore 配置文件：

`bash


默认为 .zhlintrc

zhlint --config

默认为 .zhlintignore

zhlint --ignore
zhlint --file-ignore

默认为 .zhlintcaseignore

zhlint --case-ignore

默认为 current directory

zhlint --dir
`

在 rc 配置文件中，您可以写一个 JSON，例如：

`json
{
"preset": "default",
"rules": {
"adjustedFullwidthPunctuation": ""
}
}
`

关于更多细节，请参见支持的规则。

在 file-ignore 文件中，您可以写多行内容来忽略相应的文件，其语法遵循 .gitignore 语法：

在 case-ignore 文件中，您可以写多行内容来忽略一些特例，例如：

`txt
( , )
`

关于更多细节：请参见设置被忽略的特例。

$3

`js
const { run, report } = require('zhlint')

const value = '自动在中文和English之间加入空格'
const options = { rules: { preset: 'default' }}
const output = run(value, options)

// 打印 '自动在中文和 English 之间加入空格'
console.log(output.result)

// 打印错误报告
report([output])
`

错误报告的格式像这样：

`bash
1:6 - 此处中英文内容之间需要一个空格

自动在中文和English之间加入空格
　　　　　　^

1:13 - 此处中英文内容之间需要一个空格

自动在中文和English之间加入空格
　　　　　　^
Invalid files:
- foo.md

Found 2 errors.
`

#### 高阶用法

zhlint 还支持 rc 和 ignore 配置文件：

`js
const { readRc, runWithConfig } = require('zhlint')

const value = '自动在中文和English之间加入空格'

const dir = '...' // 目标文件所在的目录
const configPath = '...' // rc 配置文件路径
const fileIgnorePath = '...' // file-ignore 文件路径
const caseIgnorePath = '...' // case-ignore 文件路径

const config = readRc(dir, configPath, fileIgnorePath, caseIgnorePath)
const output = runWithConfig(value, config)

// ... 后续操作
`

$3

您可以找到一个 JavaScript 文件 dist/zhlint.js 作为独立版本。 例如，要使用它，您可以直接将它添加到您的浏览器中作为