File tree 2 files changed +10
-7
lines changed
2 files changed +10
-7
lines changed Original file line number Diff line number Diff line change 1
1
# BashCompletor
2
2
3
- A declarative generator for creating bash completion script.
3
+ Creating a bash completion script in a declarative way .
4
4
5
5
[ English] ( ./README.md ) | [ 中文] ( ./README.zh.md )
6
6
@@ -25,7 +25,7 @@ A declarative generator for creating bash completion script.
25
25
26
26
## Versioning
27
27
28
- Read [ tags] [ ] for verions .
28
+ Read [ tags] [ ] for versions .
29
29
The versions follow the rules of [ Semantic Versioning 2.0.0] ( http://semver.org/spec/v2.0.0.html ) .
30
30
31
31
## Installation
@@ -88,12 +88,14 @@ Enter `bash-completor` for help.
88
88
- [ ./completor.bash] ( ./completor.bash ) It's a simple example. Run ` make build ` to build the completion script of bash-completor.
89
89
- [ zig.completor.bash] ( https://github.com/adoyle-h/shell-completions/blob/feat/bash/zig.completor.bash )
90
90
- [ nvim-shell-completions/nvim.completor.bash] ( https://github.com/adoyle-h/nvim-shell-completions/blob/master/nvim.completor.bash )
91
+ - Other examples in [ ./example/] ( ./example/ )
91
92
92
93
### [ Syntax] ( ./docs/syntax.md )
93
94
94
95
## The completion script
95
96
96
- The generated completion script follows below code style. It's easy to debug at runtime.
97
+ The generated completion script follows below code style. No worry about naming conflict.
98
+ And it's easy to debug at runtime.
97
99
98
100
- The main command completion function must be ` _${cmd}_completions `
99
101
- All subcmd completion functions must be named with prefix ` _${cmd}_completions_${subcmd} ` .
Original file line number Diff line number Diff line change 1
1
# BashCompletor
2
2
3
- 声明式 Bash 补全脚本生成器 。
3
+ 声明式编写 Bash 补全脚本 。
4
4
5
5
[ English] ( ./README.md ) | [ 中文] ( ./README.zh.md )
6
6
26
26
27
27
## Versioning
28
28
29
- Read [ tags] [ ] for verions.
30
- The versions follow the rules of [ Semantic Versioning 2.0.0] ( http://semver.org/spec/v2.0.0.html ) .
29
+ 版本详见 [ tags] [ ] 。
30
+ 版本命名遵守 [ Semantic Versioning 2.0.0] ( http://semver.org/spec/v2.0.0.html ) 。
31
31
32
32
## 安装
33
33
@@ -89,12 +89,13 @@ sudo ln -s "$PWD/dist/bash-completor" /usr/local/bin/bash-completor
89
89
- [ ./completor.bash] ( ./completor.bash ) 一个很简单的例子。运行 ` make build ` 构建 bash-completor 自身的补全脚本。
90
90
- [ zig.completor.bash] ( https://github.com/adoyle-h/shell-completions/blob/feat/bash/zig.completor.bash )
91
91
- [ nvim-shell-completions/nvim.completor.bash] ( https://github.com/adoyle-h/nvim-shell-completions/blob/master/nvim.completor.bash )
92
+ - 其他例子见 [ ./example/] ( ./example/ )
92
93
93
94
### [ 语法] ( ./docs/syntax.md )
94
95
95
96
## 补全脚本
96
97
97
- 生成的补全脚本遵循以下代码风格。便于在运行时调试 。
98
+ 生成的补全脚本遵循以下代码风格。无需担心重名问题。而且这也便于在运行时调试 。
98
99
99
100
- 主命令的补全函数必须是 ` _${cmd}_completions ` 。
100
101
- 所有子命令的补全函数必须以 ` _${cmd}_completions_${subcmd} ` 为前缀命名。
You can’t perform that action at this time.
0 commit comments