agmd 0.2.10 → 0.3.0-alpha0.1

package/README.md

@@ -14,6 +14,20 @@
 
 💡 easy get foldName and fileName.
 
+✈️ 全程界面命令选择操作
+
+😍 得到一个包含整个工程结构树的json
+
+⛵ 把工程所有引用更改绝对路径为相对路径(方便点击下钻查看文件)
+
+♨️ 把工程所有引用文件都加上后缀(方便点击下钻查看文件)
+
+👏 把工程按路由标记分类(对拆分工程很重要)
+
+☝️ 把工程按分类对拆分工程(自动拆分的错误可控, 手动拆分会有各种问题)
+
+
+
 ### 案例
 
 ![image](https://github.com/kakajun/auto-generate-md/blob/master/md2.png)
@@ -33,7 +47,57 @@
 
 example，是我为演示准备的一些文件，并没有其他用
 
-3. 高级用法
+
+3. 命令说明
+- Generate All     执行所有操作
+- Generate MD      只生成md文档
+- Change Path      所有绝对路径修改为相对路径
+- Mark File        给需要分类的都打上标记
+- Wirte Json Nodes  把node树写出来
+- Wirte  Nodes With Import(may change path)  把node树写出来,包含依赖关系, 但会修改路径
+
+4. 代码结构说明(由本插件agmd生成)
+```
+├── bin
+│ └── bin.js
+├── lib
+│ ├── commands
+│ │ ├── get-file.d.ts
+│ │ └── wirte-md.d.ts
+│ ├── index.cjs.js
+│ ├── index.d.ts
+│ └── index.esm.js
+├── script
+│ ├── cli
+│ │ ├── handle.ts
+│ │ └── index.ts
+│ ├── help
+│ │ └── index.ts
+│ ├── build.js
+│ └── builder.js
+├── src
+│ ├── commands
+│ │ ├── agmd.ts
+│ │ ├── base.ts            /* 界面命令注册在这里 */
+│ │ ├── change-path.ts            /* 整个文件主要把绝对路径修改为相对路径 */
+│ │ ├── get-file.ts            /* 获取文件相关方法 */
+│ │ ├── mark-file.ts
+│ │ ├── mark-write-file.ts
+│ │ └── wirte-md.ts            /* 生成md说明文档 */
+│ ├── shared
+│ │ ├── constant.ts
+│ │ └── logger.ts
+│ ├── bin.ts
+│ └── index.ts            /* 这里抛出一些高级操作方法 */
+├── test
+│ └── index.js
+└── unuse
+```
+
+5. 高级用法
+给文件打标记分类, 需要在src的同级目录下, 设置一个文件叫classify.js, 从里面读取需要配置的信息, 注意路径一定是带@符号的绝对路径, 没有配置, 那么程序会自动退出
+
+
 有些需要把自动生成的文档插入到某个自动生成的 md 当中, 该插件导出了自动生成的 md 数据方法, 还有`getFileNodes`获得所有文件的具体信息, 可以 DIY 做出不同的文档( 方法名不用记忆, 由于是ts写的,所以会自动点出来)
 >const agmd = require('agmd')
 
@@ -56,6 +120,10 @@ note: 上面两个方法均可传一个option入参,其格式为:
 2. 或者工程目录和文件被移动位置重构了，这时还需要重新修改 md 文件里面的目录说明
 3. 接手老工程，看了 md 说明，能对文件夹里面的文件功能做到一目了然，而不是点开对应文件去看
 4. 分析源码工程需要做点笔记
+5. 拆分老代码工程, 手工量大还容易出错, 程序控制又快又好
+6. 为什么绝对路径要改相对路径? 大家用vscode重命名文件时, 有没发现, 引用文件是绝对路径时, 文件没变化.....而且点击下钻查看文件详情还点不下去????但是相对路径不会有这个问题
+7. 文件有后缀能一目了然文件是js文件还是vue文件
+8. 一切需要手工重复操作的, 都可以用插件脚本搞定, 留时间学新知识更好
 
 ### 功能
 
@@ -101,3 +169,14 @@ $ agmd  --ignore lib,node_modules,dist --include .js,.ts,.vue`
 
 0.2.9
 新增文件统计功能
+
+0.3.0
+✈️ 全程界面命令选择操作
+
+⛵ 把工程所有引用更改绝对路径为相对路径(方便点击下钻查看文件)
+
+♨️ 把工程所有引用文件都加上后缀(方便点击下钻查看文件)
+
+👏 把工程按路由标记分类(对拆分工程很重要)
+
+☝️ 把工程按分类对拆分工程(自动拆分的错误可控, 手动拆分会有各种问题)