@xubill/xx-cli 1.0.2 → 1.0.4
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/lib/core/index.js +147 -251
- package/lib/plugins/config-manager.js +140 -0
- package/lib/plugins/history.js +97 -0
- package/lib/{core/commands.js → plugins/plugin-manager.js} +225 -181
- package/package.json +1 -1
- package/readme.md +59 -11
package/readme.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
# 全局安装 xx-cli
|
|
9
|
-
npm i @xubill/xx-cli
|
|
9
|
+
npm i @xubill/xx-cli -g
|
|
10
10
|
|
|
11
11
|
# 添加插件
|
|
12
12
|
xx p add xxxx.js
|
|
@@ -26,10 +26,14 @@ xx <command> [options]
|
|
|
26
26
|
### v1.0.1
|
|
27
27
|
- 文档更新
|
|
28
28
|
|
|
29
|
-
### v1.0.
|
|
29
|
+
### v1.0.3
|
|
30
30
|
- 创建插件和配置管理插件移动壳功能
|
|
31
31
|
- 完善文档
|
|
32
32
|
|
|
33
|
+
### v1.0.4
|
|
34
|
+
- 修复原生插件和用户插件区别
|
|
35
|
+
- 壳功能移动到原生插件目录
|
|
36
|
+
|
|
33
37
|
## 框架自带命令
|
|
34
38
|
|
|
35
39
|
xx-cli 框架自带以下核心命令（位于 core 模块中）：
|
|
@@ -46,12 +50,12 @@ xx-cli 框架自带以下核心命令（位于 core 模块中）：
|
|
|
46
50
|
|
|
47
51
|
| 命令 | 别名 | 描述 |
|
|
48
52
|
|------|------|------|
|
|
49
|
-
| `create-plugin <name>` | `crp <name>` | 创建指定名称的插件模板 |
|
|
50
53
|
| `plugin list` | `p ls` | 列出所有插件 |
|
|
51
54
|
| `plugin enable <plugin>` | `p en <plugin>` | 启用插件 |
|
|
52
55
|
| `plugin disable <plugin>` | `p dis <plugin>` | 禁用插件 |
|
|
53
56
|
| `plugin add <url>` | `p add <url>` | 添加外部自定义插件 |
|
|
54
57
|
| `plugin remove <plugin>` | `p rm <plugin>` | 删除指定插件 |
|
|
58
|
+
| `plugin create <name>` | `p cr <name>` | 创建指定名称的插件模板 |
|
|
55
59
|
| `plugin config <plugin> [key] [value]` | `p c <plugin> [key] [value]` | 查看和设置插件配置 |
|
|
56
60
|
|
|
57
61
|
### 配置管理命令
|
|
@@ -62,37 +66,81 @@ xx-cli 框架自带以下核心命令（位于 core 模块中）：
|
|
|
62
66
|
| `config-manager import [source]` | `conf import [source]` | 从指定目录导入配置并覆盖 |
|
|
63
67
|
| `config-manager list` | `conf list` | 列出所有插件的配置文件位置和状态 |
|
|
64
68
|
|
|
69
|
+
## 项目结构
|
|
70
|
+
|
|
71
|
+
xx-cli 项目采用模块化设计，主要包含以下核心目录：
|
|
72
|
+
|
|
73
|
+
### 核心模块目录 (`/Users/hthj/xx-cli/lib/core`)
|
|
74
|
+
|
|
75
|
+
核心模块目录包含 xx-cli 的核心功能实现，负责初始化系统、注册命令、管理插件等。
|
|
76
|
+
|
|
77
|
+
#### 文件结构
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
lib/core/
|
|
81
|
+
├── index.js # 核心模块，负责初始化系统、注册命令、管理插件等
|
|
82
|
+
└── base-plugin.js # 插件基础类，提供标准化的插件接口和通用功能
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
#### 核心文件说明
|
|
86
|
+
|
|
87
|
+
- **index.js**：核心模块，负责初始化系统、注册命令、管理插件等。它包含了插件加载、命令注册、钩子管理等核心功能。
|
|
88
|
+
- **base-plugin.js**：插件基础类，提供标准化的插件接口和通用功能。所有插件应该继承此类以确保一致性，它提供了命令注册、配置管理、用户界面等通用功能。
|
|
89
|
+
|
|
90
|
+
### 插件目录 (`/Users/hthj/xx-cli/lib/plugins`)
|
|
91
|
+
|
|
92
|
+
插件目录包含 xx-cli 的内置插件，这些插件提供了各种功能，如配置管理、历史记录管理、插件管理等。
|
|
93
|
+
|
|
94
|
+
#### 文件结构
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
lib/plugins/
|
|
98
|
+
├── config-manager.js # 配置管理插件，用于管理所有插件的配置文件
|
|
99
|
+
├── history.js # 历史记录插件，用于查看命令历史记录
|
|
100
|
+
└── plugin-manager.js # 插件管理插件，用于管理所有插件
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
#### 内置插件说明
|
|
104
|
+
|
|
105
|
+
- **config-manager.js**：配置管理插件，用于管理所有插件的配置文件。它提供了导出、导入、列出配置等功能。
|
|
106
|
+
- **history.js**：历史记录插件，用于查看命令历史记录。它提供了查看、清除、搜索历史记录等功能。
|
|
107
|
+
- **plugin-manager.js**：插件管理插件，用于管理所有插件。它提供了列出、启用、禁用、添加、删除、创建插件等功能。
|
|
108
|
+
|
|
65
109
|
## 插件开发
|
|
66
110
|
|
|
67
111
|
本部分将详细介绍如何在 xx-cli 中创建、开发和部署插件。
|
|
68
112
|
|
|
69
113
|
### 创建插件
|
|
70
114
|
|
|
71
|
-
#### 使用
|
|
115
|
+
#### 使用 plugin create 命令
|
|
72
116
|
|
|
73
|
-
xx-cli 提供了 `create
|
|
117
|
+
xx-cli 提供了 `plugin create` 命令，可以快速生成插件模板。这是推荐的创建插件的方式。
|
|
74
118
|
|
|
75
119
|
##### 基本用法
|
|
76
120
|
|
|
77
121
|
```bash
|
|
78
122
|
# 创建插件到插件目录
|
|
79
|
-
xx
|
|
123
|
+
xx plugin create <plugin-name>
|
|
80
124
|
|
|
81
125
|
# 或者使用别名
|
|
82
|
-
xx
|
|
126
|
+
xx p create <plugin-name>
|
|
127
|
+
|
|
128
|
+
# 或者使用更短的别名
|
|
129
|
+
xx p cr <plugin-name>
|
|
83
130
|
```
|
|
84
131
|
|
|
85
132
|
##### 示例
|
|
86
133
|
|
|
87
134
|
```bash
|
|
88
135
|
# 创建一个名为 `hello-world` 的插件
|
|
89
|
-
xx
|
|
136
|
+
xx plugin create hello-world
|
|
90
137
|
|
|
91
138
|
# 输出：
|
|
92
139
|
# 创建插件模板...
|
|
93
|
-
# 插件模板已成功创建到：/Users/hthj
|
|
140
|
+
# 插件模板已成功创建到：/Users/hthj/.xx-cli/plugins/hello-world.js
|
|
94
141
|
# 提示：请编辑插件文件，实现具体功能
|
|
95
142
|
# 测试方法：运行 "node bin/cli.js <插件命令>"
|
|
143
|
+
# 已自动打开 vscode 编辑插件文件
|
|
96
144
|
```
|
|
97
145
|
|
|
98
146
|
#### 手动创建插件
|
|
@@ -106,7 +154,7 @@ xx create-plugin hello-world
|
|
|
106
154
|
|
|
107
155
|
#### 基本插件结构
|
|
108
156
|
|
|
109
|
-
使用 `create
|
|
157
|
+
使用 `plugin create` 命令生成的插件模板包含以下结构：
|
|
110
158
|
|
|
111
159
|
```javascript
|
|
112
160
|
/**
|
|
@@ -380,7 +428,7 @@ module.exports = MyPlugin;
|
|
|
380
428
|
|
|
381
429
|
1. 创建插件：
|
|
382
430
|
```bash
|
|
383
|
-
xx
|
|
431
|
+
xx plugin create <plugin-name>
|
|
384
432
|
```
|
|
385
433
|
|
|
386
434
|
2. 编辑插件文件，实现具体功能
|