@acarl005/cli-highlight 中文文档教程

Question

cli-highlight

终端中的语法高亮

Example

CLI Usage

Output a file

$ highlight package.json

另一个带有管道的程序的颜色输出。 示例：记录 SQL 查询的数据库迁移脚本

$ db-migrate --dry-run | highlight

命令行选项：

Usage: highlight [options] [file]

Outputs a file or STDIN input with syntax highlighting

Options:
  --language, -l  Set the langugage explicitely
                  If omitted will try to auto-detect
  --theme, -t     Use a theme defined in a JSON file
  --version, -v   Show version number                                   [boolean]
  --help, -h      Show help                                             [boolean]

Programmatic Usage

您可以以编程方式使用此模块来突出显示 Node 应用程序的日志。 示例：

const highlight = require('cli-highlight').highlight
const Sequelize = require('sequelize')

const db = new Sequelize(process.env.DB, {
  logging(log) {
    console.log(highlight(log, {language: 'sql', ignoreIllegals: true}))
  }
})

详细的 API 文档可以在这里找到。

Themes

您可以在 JSON 文件中编写自己的主题，并使用 --theme 传递它。 键必须是 highlight.js CSS 类名之一 并且该值必须是一个或一组 Chalk 样式 以应用于该令牌。

{
  "keyword": "blue",
  "built_in": ["cyan", "dim"],
  "string": "red"
}

该主题结合了默认主题。 默认主题仍然没有很多颜色或针对多种语言进行优化，欢迎 PR！

Supported Languages

理论上highlight.js的所有语言都是支持的——我就是没适应 默认主题并为所有语言编写测试。 我的主要用例是 SQL，因此得到了很好的支持。

Contributing

该模块是用 TypeScript 编写的，可以用 npm run build 编译。 npm run watch 在监视模式下启动 tsc。 测试是用 mocha 编写的。

通过为默认主题中的标记添加更多颜色并编写更多测试来改进语言支持。