fish-abbreviation-tips 项目教程
1. 项目的目录结构及介绍
fish-abbreviation-tips/
├── README.md
├── LICENSE
├── functions/
│ ├── __abbr_tips_alias_tips.fish
│ ├── __abbr_tips_check.fish
│ ├── __abbr_tips_find.fish
│ ├── __abbr_tips_init.fish
│ ├── __abbr_tips_prompt.fish
│ └── __abbr_tips_regexes.fish
├── conf.d/
│ └── abbr_tips.fish
└── completions/
└── abbr_tips.fish
- README.md: 项目介绍和使用说明。
- LICENSE: 项目许可证,采用 MIT 许可证。
- functions/: 包含项目的核心功能函数。
- __abbr_tips_alias_tips.fish: 处理别名提示的函数。
- __abbr_tips_check.fish: 检查别名提示的函数。
- __abbr_tips_find.fish: 查找别名提示的函数。
- __abbr_tips_init.fish: 初始化别名提示的函数。
- __abbr_tips_prompt.fish: 生成提示信息的函数。
- __abbr_tips_regexes.fish: 处理正则表达式的函数。
- conf.d/: 包含项目的配置文件。
- abbr_tips.fish: 配置别名提示的文件。
- completions/: 包含命令补全文件。
- abbr_tips.fish: 别名提示的命令补全文件。
2. 项目的启动文件介绍
项目的启动文件位于 conf.d/abbr_tips.fish
。这个文件在 Fish shell 启动时自动加载,负责初始化别名提示功能。
# conf.d/abbr_tips.fish
# 初始化别名提示功能
__abbr_tips_init
3. 项目的配置文件介绍
项目的配置通过环境变量进行,可以在 conf.d/abbr_tips.fish
文件中设置。以下是一些常用的配置项:
-
ABBR_TIPS_PROMPT: 提示信息的格式。
- 默认值:
"\n💡 \e[1m{{ abbr }}\e[0m => {{ cmd }}"
- 示例:
set -U ABBR_TIPS_PROMPT "\n💡 {{ abbr }} => {{ cmd }}"
- 默认值:
-
ABBR_TIPS_ALIAS_WHITELIST: 别名白名单,用于指定哪些别名需要提示。
- 默认值:未设置
- 示例:
set -U ABBR_TIPS_ALIAS_WHITELIST "alias1 alias2"
-
ABBR_TIPS_REGEXES: 正则表达式列表,用于匹配命令。
- 默认值:
'(^(\w+\s+)+(-{1,2})\w+)(\s\S+)' '(^( \w+){3}) *' '(^( \w+){2}) *' '(^( \w+){1}) *'
- 示例:
set -U ABBR_TIPS_REGEXES '(^(\w+\s+)+(-{1,2})\w+)(\s\S+)'
- 默认值:
通过设置这些环境变量,可以自定义别名提示的行为和显示格式。
# 设置环境变量示例
set -U ABBR_TIPS_PROMPT "\n💡 {{ abbr }} => {{ cmd }}"
set -U ABBR_TIPS_ALIAS_WHITELIST "alias1 alias2"
set -U ABBR_TIPS_REGEXES '(^(\w+\s+)+(-{1,2})\w+)(\s\S+)'
以上是 fish-abbreviation-tips
项目的目录结构、启动文件和配置文件的介绍。通过这些内容,您可以更好地理解和使用该项目。