agmd 0.3.6 → 0.3.8
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 +41 -20
- package/bin/bin.js +98 -92
- package/bin/bin.js.map +4 -4
- package/lib/commands/change-path.d.ts +3 -3
- package/lib/commands/get-file.d.ts +1 -1
- package/lib/index.cjs.js +45 -22
- package/lib/index.cjs.js.map +4 -4
- package/lib/index.esm.js +44 -22
- package/lib/index.esm.js.map +4 -4
- package/package.json +22 -22
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# agmd(auto generate md)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 这是一个前端代码管理的辅助工具，在任何需要生成文档的，文件夹下的控制台中输入`agmd`， 就能自动生成目录 md 说明, 同时能够统计分析当前工程的各类型文件总量和代码总量，还提供一些实用的工具，具体看下面功能特征
|
|
4
4
|
|
|
5
5
|
[]( https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667)
|
|
6
6
|
[]( https://github.com/kakajun/auto-generate-md/actions/workflows/test.yml)
|
|
@@ -8,30 +8,33 @@
|
|
|
8
8
|
|
|
9
9
|
简体中文 | [English](https://github.com/kakajun/auto-generate-md/blob/master/README.EN.md)
|
|
10
10
|
|
|
11
|
-
## 🚀
|
|
11
|
+
## 🚀 功能特性
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
😍 一键统计工程的文件数和代码总量
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
📦 一键补充缺省后缀名 .js .vue 这样子能方便vscode编辑器点击直接跳转查看代码
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
🚘 一键更改文件或者文件名,驼峰命名为kable-case
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
⛵ 把工程所有引用更改绝对路径为相对路径(方便点击下钻查看文件)
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
♨️ 把工程按路由标记分类(对拆分工程很重要)
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
☝️ 把工程按分类对拆分工程(自动拆分的错误可控, 手动拆分会有各种问题)
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
✈️ 全程界面命令选择操作, 不用记命令
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
😍 得到一个包含整个工程结构树的json
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
🔋 用esbuild进行打包
|
|
30
|
+
|
|
31
|
+
💡 一键拿到文件和文件夹名字, 并生成JSON输出
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
🔥 用TypeScript书写,80%的代码全部书写了测试用例
|
|
32
34
|
|
|
33
|
-
|
|
35
|
+
### 操作界面
|
|
34
36
|
|
|
37
|
+
|
|
35
38
|
### 案例
|
|
36
39
|
|
|
37
40
|
|
|
@@ -53,12 +56,19 @@ example，是我为演示准备的一些文件，并没有其他用
|
|
|
53
56
|
|
|
54
57
|
|
|
55
58
|
3. 命令说明
|
|
56
|
-
-
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
-
|
|
61
|
-
-
|
|
59
|
+
- 帮助
|
|
60
|
+
- 执行所有操作 (包含下面所有操作)
|
|
61
|
+
- 生成结构树文档
|
|
62
|
+
- 修改为相当路径
|
|
63
|
+
- 修改为绝对路径(暂未实现)
|
|
64
|
+
- 补全文件后缀
|
|
65
|
+
- 统一命名文件夹为KebabCase
|
|
66
|
+
- 统一命名文件为KebabCase
|
|
67
|
+
- 记录节点Json
|
|
68
|
+
- 给需要分类的都打上标记
|
|
69
|
+
- 删除标记
|
|
70
|
+
- 分类
|
|
71
|
+
|
|
62
72
|
|
|
63
73
|
4. 代码结构说明(由本插件agmd生成)
|
|
64
74
|
```
|
|
@@ -128,6 +138,7 @@ note: 上面两个方法均可传一个option入参,其格式为:
|
|
|
128
138
|
6. 为什么绝对路径要改相对路径? 大家用vscode重命名文件时, 有没发现, 引用文件是绝对路径时, 文件没变化.....而且点击下钻查看文件详情还点不下去????但是相对路径不会有这个问题
|
|
129
139
|
7. 文件有后缀能一目了然文件是js文件还是vue文件
|
|
130
140
|
8. 一切需要手工重复操作的, 都可以用插件脚本搞定, 留时间学新知识更好
|
|
141
|
+
9. 补全缀是刚需, 很多伙伴就不喜欢写文件后缀, 所以import引入的是组件还是js 得去查看, 很不方便
|
|
131
142
|
|
|
132
143
|
### 功能
|
|
133
144
|
|
|
@@ -158,6 +169,10 @@ $ agmd --ignore lib,node_modules,dist --include .js,.ts,.vue`
|
|
|
158
169
|
|
|
159
170
|
[掘金-自动生成目录 md 文件](https://juejin.cn/post/7030030599268073508)
|
|
160
171
|
|
|
172
|
+
### 写在最后
|
|
173
|
+
|
|
174
|
+
本工程有26个测试, 大家如果想扩展什么功能, 测试代码跑起来, 很方便, 也欢迎大家克隆本工程然后提交进行PR！
|
|
175
|
+
|
|
161
176
|
### 更新记录
|
|
162
177
|
0.1.3
|
|
163
178
|
1. 采用esbuild 进行打包
|
|
@@ -188,4 +203,10 @@ $ agmd --ignore lib,node_modules,dist --include .js,.ts,.vue`
|
|
|
188
203
|
0.3.3
|
|
189
204
|
优化提示日志打印
|
|
190
205
|
对路由进行自动分析
|
|
191
|
-
增加单元测试到26个,覆盖率达到84%,一些没必要的方法就没测试
|
|
206
|
+
增加单元测试到26个,覆盖率达到84%,一些没必要的方法就没测试
|
|
207
|
+
|
|
208
|
+
0.3.7
|
|
209
|
+
升级所有依赖到最新
|
|
210
|
+
|
|
211
|
+
0.3.8
|
|
212
|
+
操作界面改成中文的, 我还是做不到大爱全世界, 先给自己和中国伙伴用好就行了, 同时增加功能只补全后缀, 但不更改路径
|