@kokiito0926/completer 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,53 @@
|
|
|
1
1
|
## completer
|
|
2
2
|
|
|
3
|
-
completer
|
|
3
|
+
completerは、コマンドライン引数の入力補完をサポートするためのツールです。
|
|
4
|
+
設定ファイルで定義されたツリー構造に基づいて、次に続くべき引数の候補を提示します。
|
|
5
|
+
|
|
6
|
+
## インストール
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install --global @kokiito0926/completer
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## 使用方法
|
|
13
|
+
|
|
14
|
+
### コマンド
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
completer --config <設定ファイルへのパス> [入力途中のコマンド...]
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### 設定ファイル
|
|
21
|
+
|
|
22
|
+
```javascript
|
|
23
|
+
export default {
|
|
24
|
+
apps: {
|
|
25
|
+
list: [],
|
|
26
|
+
info: ["--json", "--short"],
|
|
27
|
+
delete: ["app-1", "app-2", "app-3"],
|
|
28
|
+
},
|
|
29
|
+
config: {
|
|
30
|
+
set: ["port", "host", "timeout"],
|
|
31
|
+
get: ["port", "host", "timeout"],
|
|
32
|
+
},
|
|
33
|
+
deploy: ["production", "staging"],
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### 実行例
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
$ completer --config ./example.js apps
|
|
41
|
+
list
|
|
42
|
+
info
|
|
43
|
+
delete
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
$ completer --config ./example.js apps info
|
|
48
|
+
--json
|
|
49
|
+
--short
|
|
50
|
+
```
|
|
4
51
|
|
|
5
52
|
## ライセンス
|
|
6
53
|
|