nu-plugin-highlight

一个用于语法高亮的 nushell 插件。

关于

nu-plugin-highlight 是一个为 Nushell 提供语法高亮的插件。它使用 syntect 库进行语法高亮，并使用 bat 库来轻松访问其现成的资源。也可以加载自定义主题。

用法

可以使用 highlight 命令进行语法高亮。以下是一些示例

# Highlight a TOML file by its file extension
open Cargo.toml -r | highlight toml

# Highlight a Rust file by programming language name
open src/main.rs | highlight Rust

# Highlight a bash script by inferring the language (the file should start with a shebang)
open example.sh | highlight

# Highlight a TOML file with a different theme
open Cargo.toml -r | highlight toml -t ansi

# List all available themes
highlight --list-themes

参数

• language <字符串>：这是一个可选参数，可以用来指定语言或文件扩展名以帮助语言检测。

标志

• -h, --help：显示 highlight 命令的帮助信息。

• -t, --theme <字符串>：用于高亮显示的主题。

• --list-themes：列出所有可能的主题。

配置

该插件可以使用变量 $env.config.plugins.highlight 进行配置。

true_colors

启用或禁用真彩色（24位）。默认情况下，此选项已启用。

$env.config.plugins.highlight.true_colors = true

theme

设置要使用的主题。默认主题取决于操作系统。使用 highlight --list-themes | where default == true 查看默认主题。设置此环境变量应该允许 highlight --list-themes | where id == $env.config.plugins.highlight.theme 显示所选主题的单行。如果没有结果，您设置的选项无效。

$env.config.plugins.highlight.theme = ansi

custom_themes

设置一个目录来加载自定义主题。使用 synctect 的主题加载器，您可以从此配置值指定的目录中加载 .tmtheme 格式的自定义主题。

$env.config.plugins.highlight.custom_themes = ~/.nu/highlight/themes

插件安装

安装和注册 nu-plugin-highlight 是一个简单的过程。按照以下步骤操作

1. 使用 cargo 从 crates.io 安装插件

   cargo install nu_plugin_highlight
   

2. 重新启动您的终端会话以确保新安装的插件被识别。

3. 找到您的安装路径

   which nu_plugin_highlight
   

4. 使用 Nushell 注册插件

   如果您使用的是低于 0.93.0 的版本，请使用 register 而不是 plugin add。

   plugin add path/to/the/plugin/binary
   

5. 使插件可用于使用

   提示：您可以简单地重新启动 shell 或终端。当 nushell 启动时，它会加载所有插件。

   如果您使用的是低于 0.93.0 的版本，您无需这样做。

   plugin use highlight
   

注册后，插件可作为您的命令集的一部分使用

help commands | where command_type == "plugin"

版本编号

从版本 v1.1.0 开始，nu-plugin-highlight 的版本号结合了其依赖项 nu-plugin 的版本号。这表示为 v1.1.0+0.90.1 的格式，其中 v1.1.0 指的是 nu-plugin-highlight 的版本，而 0.90.1 指的是 nu-plugin 依赖项的版本。