agmd 0.3.14 → 0.4.0

package/README.EN.md

@@ -1,175 +1,67 @@
-# agmd(auto generate md)
-
-
-
->For any document that needs to be generated, enter 'AGMD' in the console under the folder to automatically generate the directory MD description
-
-
-
-[![]( https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667 )]( https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667 )
-
-
-🚀 Features
-
-🔥 Written in TypeScript
-
-🔋 build with esbuild
-
-💡 easy get foldName and fileName.
-
-
-
-### Case
-
-
-
-! [image]( https://github.com/kakajun/auto-generate-md/blob/master/md2.png )
-
-
-
-### Method of use
-
-Node environment is required
-
-1. Global installation
-
-> npm i agmd -g
-
-
-
-After installation, enter 'AGMD' under the folder where MD needs to be recorded, and the names of folders and files under the relative path will be automatically generated. If comments are written in the header of the file, it will be brought together to automatically generate MD files. The generated file name is' readme md.md ', and the path is the path just entered. At the same level, for the development of large projects, this script may save you some time.
-
-
-
-2. Install as a dependency
-
-> npm i agmd -D
-
-
-
-In package Configure AGMD in scripts of JSON: NPX AGMD -- ignore lib, node_ modules,dist --include . js,. ts,. Vue can automatically update the document with the command line every time it is started or packaged
-
-
-
-
-Example is some of the files I prepared for the demonstration, which is of no other use
-
-
-
-3. Advanced usage
-
-Some need to insert the automatically generated documents into an automatically generated MD. the plug-in exports the automatically generated MD data method, and 'getfilenodes' obtains the specific information of all files. You can DIY different documents (the method name does not need to be remembered, because it is written by TS, so it will be automatically clicked)
-
->const agmd = require('agmd')
-
-
-
-In es:
-
->import agmd from 'agmd'
-
-
-
-- AGMD Getfilenodes () can obtain information related to specific files, and this function can pass a parameter
-
-
-
-- agmd. Getmd() gets the final output information
-
-Note: the above two methods can pass an option input parameter in the following format:
-
-option: { ignore: string[] | undefined; include: string[] | undefined }
-
-#### Command line parameter description
-
-1. Use AGMD - h to view help
-
-2. You can bring -- ignore to ignore the output file or folder. The default is: IMG, styles, node_ modules,LICENSE,. git,. github,dist,. husky,. vscode,readme-file. js,readme-md.js
-
-3. You can bring -- include. Only files with this suffix are required to be output. By default, only files are output js,. vue,. TS, you can add JSX, JSON, etc
-
-
-
-### Creative background
-
-1. Have you been asked to write a MD description of the directory file?
-
-2. Or if the project directory and files are reconstructed after being moved, the directory description in the MD file needs to be modified again
-
-3. After taking over the old project and reading the MD instructions, you can see the file functions in the folder at a glance, rather than clicking on the corresponding file
-
-4. You need to take notes to analyze the source code project
-
-
-
-### Function
-
-1. Automatically generate folder names and files matching directories (sorted by name)
-
-2. Automatically determine the hierarchical directory and indent it
-
-3. If there is a comment at the top of the file, it will be judged automatically
-
-4. Support recursive search of subordinate files in any file directory (do not execute in a large directory!!! Recursion until there are no files in this directory)
-
-5. Support command line parameter configuration, and can customize ignore files and filter suffix files
-
-6. Command line parsing
-
-
-
-`Usage: agmd--include str--ignore str
-
-
-
-Options:
-
---include string / -i string.......... include file extension
-
---ignore string / -in string........... ignore file or fold
-
-
-
-Str deafult:
-
---ignore / -i img,styles,node_ modules,LICENSE,. git,. github,dist,. husky,. vscode,readme-file. js,readme-md.js
-
---include / -in . js,. vue,. ts
-
-
-
-Note:
-
-There should be no space between strings in a configuration
-
-
-
-Examples:
-
-$ agmd --ignore lib,node_ modules,dist --include . js,. ts,. vue`
-
-
-
-### Related articles
-
-[Nuggets - auto generate directory MD file]（ https://juejin.cn/post/7030030599268073508 )
-
-
-
-### Update record
-
-0.1.3
-
-1. Package with esbuild
-
-2. It is written in eslint and preter specification
-
-3. Rewrite with TS
-
-4. Support gitee one key synchronization test11253123
-
-
-
-0.2.0
-1
-Support command-line parsing parameters, and can transfer parameters dynamically
+# agmd (auto generate md)
+
+> A CLI and library that scans your project to generate Markdown docs for directory structures, counts code metrics, and provides utilities to normalize imports, rename paths, and classify files via routes.
+
+## Features
+- Count files and total lines/characters in the project
+- Auto-complete missing suffixes like `.js` and `.vue`
+- Rename files/folders from CamelCase to Kebab-Case
+- Convert imports from absolute to relative paths for easy navigation
+- Classify files by routes and export JSON of nodes
+- Interactive CLI for all operations
+- Output the full tree as JSON
+- TypeScript implementation with extensive tests
+- Convert relative imports to absolute alias-based paths using `@` (new)
+
+## Usage
+- Global: `npm i agmd -g`
+- Local: `npm i agmd -D`
+- Run: `agmd` in the directory you want to document
+
+The generated Markdown (`readme-md.md`) contains:
+- A “Directory Structure” section
+- A “Statistics” section with totals per suffix, lines and characters
+
+## Scripts
+Add to `package.json`:
+
+`npx agmd --ignore lib,node_modules,dist --include .js,.ts,.vue [--dry-run] [--silent]`
+
+## CLI Commands (interactive)
+- Help
+- Generate Structure Markdown
+- Change Relative Path
+- Change Absolute Path
+- Completion suffix
+- Rename folders to Kebab-Case
+- Rename files to Kebab-Case
+- Record nodes as JSON
+- Mark files for classification
+- Delete marks
+- Classification
+
+## CLI Options
+- `--include string` / `-in string` Include suffixes (space-separated)
+- `--ignore string` / `-i string` Ignore file or directory names (space-separated)
+- `--dry-run` / `-d` Preview changes without writing to disk
+- `--silent` / `-s` Minimize logs
+
+Defaults:
+- `--ignore` img,styles,node_modules,LICENSE,.git,.github,dist,.husky,.vscode,readme-file.js,readme-md.js
+- `--include` .js,.vue,.ts
+
+Example:
+`agmd --ignore lib node_modules dist --include .js .ts .vue --dry-run --silent`
+
+## Advanced
+Create `classify.js` at the project root to define route-based classification. Use `@` alias paths in the config. If missing, the tool scans `router/` automatically.
+
+## API
+- `getFileNodes(option?)` Get detailed file info
+- `getMd(option?)` Get composed Markdown string and nodes
+
+`option: { ignore?: string[]; include?: string[] }`
+
+## Notes
+- Prefer running path operations inside `src` due to alias resolution conventions
+- Dry-run and silent modes are supported across write operations

package/README.md

@@ -1,6 +1,6 @@
 # agmd(auto generate md)
 
-> 这是一个前端代码管理的辅助工具，在任何需要生成文档的，文件夹下的控制台中输入`agmd`， 就能自动生成目录 md 说明, 同时能够统计分析当前工程的各类型文件总量和代码总量，还提供一些实用的工具，具体看下面功能特征
+> 这是一个前端代码管理的辅助工具，在任何需要生成文档的，文件夹下的控制台中输入`agmd`， 就能自动生成目录 md 说明(部分功能需要在src目录下), 同时能够统计分析当前工程的各类型文件总量和代码总量，还提供一些实用的工具，具体看下面功能特征
 
 [![]( https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667)]( https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667)
 [![]( https://github.com/kakajun/auto-generate-md/actions/workflows/test.yml/badge.svg?branch=master)]( https://github.com/kakajun/auto-generate-md/actions/workflows/test.yml)
@@ -17,6 +17,7 @@
 🚘 一键更改文件或者文件名,驼峰命名为kable-case
 
 ⛵ 把工程所有引用更改绝对路径为相对路径(方便点击下钻查看文件)
+🔧 支持将相对路径统一转换为基于 '@' 别名的绝对路径
 
 ♨️ 把工程按路由标记分类(对拆分工程很重要)
 
@@ -26,11 +27,16 @@
 
 😍 得到一个包含整个工程结构树的json
 
-🔋 用esbuild进行打包
-
 💡 一键拿到文件和文件夹名字, 并生成JSON输出
 
-🔥 用TypeScript书写,80%的代码全部书写了测试用例
+🔥 用TypeScript书写,85%的代码全部书写了测试用例
+
+## 设计初衷
+
+1. 统计工程量, 看看咱们工程究竟有多少个文件, 多少代码量
+2. 如果仅仅只是为了重命文件和文件夹, 那么其实这个库没有存在的必要, 因为我们可以自己随手写个node代码, 就全部重命名了, 问题的关键是, 我们内部工程有很多依赖, 像这样子 `import { replaceName } from '../src/commands/rename-path'` , 我们需要一个工具, 能够帮我们自动生成目录, 快速定位到文件,也进行重命名来减少重复劳动, 提升效率.
+3. 如果想把工程1分2做成按路由拆分的微服务, 那么需要知道哪些文件被工程1用到了, 哪些文件被工程2用到了, 那么就需要一个工具, 来进行标记,甚至清除没有被标记的文件.
+
 
 ### 操作界面
 
@@ -49,7 +55,7 @@
 2. 作为依赖安装
 > npm i agmd -D
 
-在package.json的scripts 中配置 agmd: npx agmd --ignore lib,node_modules,dist --include .js,.ts,.vue   可以在每次启动或打包时,带上命令行来自动更新文档
+在package.json的scripts 中配置 agmd: npx agmd --ignore lib,node_modules,dist --include .js,.ts,.vue [--dry-run] [--silent]   可以在每次启动或打包时,带上命令行来自动更新文档
 
 
 example，是我为演示准备的一些文件，并没有其他用
@@ -57,14 +63,13 @@ example，是我为演示准备的一些文件，并没有其他用
 
 3. 命令说明
 - 帮助
-- 执行所有操作    (包含下面所有操作)
 - 生成结构树文档
-- 修改为相当路径
-- 修改为绝对路径(暂未实现)
+- 修改为相对路径
+- 修改为绝对路径
 - 补全文件后缀
-- 统一命名文件夹为KebabCase
-- 统一命名文件为KebabCase
-- 记录节点Json
+- 统一命名文件夹为 Kebab-Case
+- 统一命名文件为 Kebab-Case
+- 记录节点 JSON
 - 给需要分类的都打上标记
 - 删除标记
 - 分类
@@ -87,8 +92,6 @@ example，是我为演示准备的一些文件，并没有其他用
 │ │ └── index.ts
 │ ├── help
 │ │ └── index.ts
-│ ├── build.js
-│ └── builder.js
 ├── src
 │ ├── commands
 │ │ ├── agmd.ts
@@ -100,7 +103,6 @@ example，是我为演示准备的一些文件，并没有其他用
 │ │ └── wirte-md.ts            /* 生成md说明文档 */
 │ ├── shared
 │ │ ├── constant.ts
-│ │ └── logger.ts
 │ ├── bin.ts
 │ └── index.ts            /* 这里抛出一些高级操作方法 */
 ├── test
@@ -149,11 +151,13 @@ note: 上面两个方法均可传一个option入参,其格式为:
 5. 支持命令行参数配置, 可以自定义忽略文件和过滤后缀名文件
 6. 命令行解析
 
-控制台命令: agmd--include str--ignore str
+控制台命令: agmd --include <string> --ignore <string> [--dry-run] [--silent]
 
 可选项:
-  --include string  / -i string.......... 包含解析的后缀
-  --ignore string  / -in string........... 忽略文件名
+  --include string  / -in string.......... 包含解析的后缀 (以空格分隔)
+  --ignore string  / -i string........... 忽略文件名或目录 (以空格分隔)
+  --dry-run        / -d..................  预演模式, 不对文件系统进行写入
+  --silent         / -s..................  静默模式, 最小化日志输出
 
 例子:
   --ignore / -i  img,styles,node_modules,LICENSE,.git,.github,dist,.husky,.vscode,readme-file.js,readme-md.js
@@ -163,7 +167,7 @@ note: 上面两个方法均可传一个option入参,其格式为:
 配置中的字符串之间不应有空格
 
 命令行例子:
-$ agmd  --ignore lib,node_modules,dist --include .js,.ts,.vue`
+$ agmd --ignore lib node_modules dist --include .js .ts .vue --dry-run --silent
 
 ### 相关文章
 
@@ -171,7 +175,7 @@ $ agmd  --ignore lib,node_modules,dist --include .js,.ts,.vue`
 
 ### 写在最后
 
-本工程有26个测试, 大家如果想扩展什么功能, 测试代码跑起来, 很方便, 也欢迎大家克隆本工程然后提交进行PR！
+本工程有36个测试, 大家如果想扩展什么功能, 测试代码跑起来, 很方便, 也欢迎大家克隆本工程然后提交进行PR！
 
 ### 更新记录
 0.1.3
@@ -210,3 +214,12 @@ $ agmd  --ignore lib,node_modules,dist --include .js,.ts,.vue`
 
 0.3.8
 操作界面改成中文的, 我还是做不到大爱全世界, 先给自己和中国伙伴用好就行了, 同时增加功能只补全后缀, 但不更改路径
+
+0.3.14
+重构代码, 修改打包有esbuild转为tsc编译, 同时修改里面本身为异步操作的fs.readFileSync改为await  readFile ,同时新增部分测试用例使得覆盖率达到85%
+
+0.4.1
+重构代码, 新增功能:
+1. 新增命令行参数 --dry-run / -d 预演模式, 不对文件系统进行写入
+2. 新增命令行参数 --silent / -s 静默模式, 最小化日志输出
+3. 新增命令行参数 --absolute-alias / -a 把工程所有引用文件都加上绝对路径别名(方便点击下钻查看文件)

package/es6/package.json

@@ -1,9 +1,19 @@
 {
     "name": "agmd",
-    "version": "0.3.13",
-    "description": "auto generate markdown for node, Classification of engineering documents, Absolute path to relative path",
+    "version": "0.4.0",
+    "description": "Automatically generate a directory structure for any file or folder, create Markdown documentation for nodes, classify engineering documents, and convert absolute paths to relative paths.",
     "keywords": [
-        "node",
+        "fs",
+        "filesystem",
+        "fs.js",
+        "memory-fs",
+        "file",
+        "file system",
+        "mount",
+        "memory",
+        "mock",
+        "in-memory",
+        "directory",
         "auto",
         "generate",
         "relative path",
@@ -34,33 +44,36 @@
         "type": "git",
         "url": "git@github.com:kakajun/auto-generate-md.git"
     },
+    "dependencies": {
+        "consola": "^3.2.3",
+        "fs-extra": "^11.2.0",
+        "arg": "5.0.2",
+        "commander": "^11.1.0",
+        "node-environment": "^0.5.1",
+        "prompts": "^2.4.2",
+        "@types/prompts": "^2.4.9"
+    },
     "devDependencies": {
         "@types/debug": "^4.1.12",
         "@types/fs-extra": "^11.0.4",
         "@types/jest": "^29.5.11",
         "@types/node": "^20.11.10",
-        "@types/prompts": "^2.4.9",
         "eslint-plugin-import": "^2.29.1",
         "@typescript-eslint/eslint-plugin": "^6.19.1",
         "@typescript-eslint/parser": "^6.19.1",
-        "arg": "5.0.2",
-        "commander": "^11.1.0",
-        "debug": "^4.3.4",
         "eslint": "^8.56.0",
         "eslint-config-prettier": "^9.1.0",
-        "fs-extra": "^11.2.0",
         "husky": "^9.0.6",
         "jest": "^29.7.0",
         "lint-staged": "^15.2.0",
-        "node-environment": "^0.5.1",
         "nodemon": "^3.0.3",
         "prettier": "^3.2.4",
-        "prompts": "^2.4.2",
         "ts-jest": "^29.1.2",
         "ts-node": "^10.9.2",
-        "consola": "^3.2.3",
         "typescript": "^5.3.3",
-        "ts-node-dev": "^2.0.0"
+        "ts-node-dev": "^2.0.0",
+        "memfs": "^4.9.2",
+        "raf-stub": "3.0.0"
     },
     "lint-staged": {
         "*.{ts,tsx,js}": "prettier --write",
@@ -74,8 +87,5 @@
     "files": [
         "es6",
         "lib"
-    ],
-    "dependencies": {
-        "node-environment": "^0.5.1"
-    }
+    ]
 }

package/es6/script/cli/handle.js

@@ -14,6 +14,12 @@ function handle(settings) {
     if (settings.include) {
         settings.includes = settings.include.split(' ');
     }
+    if (settings.dryRun) {
+        process.env.AGMD_DRY_RUN = '1';
+    }
+    if (settings.silent) {
+        process.env.AGMD_SILENT = '1';
+    }
     return settings;
 }
 export default handle;

package/es6/script/cli/handle.js.map

@@ -1 +1 @@
-{"version":3,"file":"handle.js","sourceRoot":"","sources":["../../../script/cli/handle.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,SAAS,CAAA;AAC1B,OAAO,GAAG,MAAM,oBAAoB,CAAA;AASpC,SAAS,MAAM,CAAC,QAAmB;IACjC,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClB,IAAI,EAAE,CAAA;IACR,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,mBAAmB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QACnE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC/C,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjD,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"handle.js","sourceRoot":"","sources":["../../../script/cli/handle.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,SAAS,CAAA;AAC1B,OAAO,GAAG,MAAM,oBAAoB,CAAA;AAWpC,SAAS,MAAM,CAAC,QAAmB;IACjC,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClB,IAAI,EAAE,CAAA;IACR,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,mBAAmB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QACnE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC/C,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjD,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,GAAG,CAAA;IAChC,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,GAAG,CAAA;IAC/B,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,eAAe,MAAM,CAAA"}

package/es6/script/cli/index.js

@@ -5,10 +5,14 @@ const stringToArgs = (rawArgs) => {
         '--include': String,
         '--version': Boolean,
         '--help': Boolean,
+        '--dry-run': Boolean,
+        '--silent': Boolean,
         '-h': '--help',
         '-i': '--ignore',
         '-in': '--include',
-        '-v': '--version'
+        '-v': '--version',
+        '-d': '--dry-run',
+        '-s': '--silent'
     }, {
         argv: rawArgs.slice(2)
     });
@@ -16,7 +20,9 @@ const stringToArgs = (rawArgs) => {
         help: args['--help'],
         ignore: args['--ignore'],
         include: args['--include'],
-        version: args['--version']
+        version: args['--version'],
+        dryRun: args['--dry-run'],
+        silent: args['--silent']
     };
 };
 export default stringToArgs;

package/es6/script/cli/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../script/cli/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,MAAM,YAAY,GAAG,CAAC,OAAiB,EAAE,EAAE;IACzC,MAAM,IAAI,GAAG,GAAG,CACd;QACE,UAAU,EAAE,MAAM;QAClB,WAAW,EAAE,MAAM;QACnB,WAAW,EAAE,OAAO;QACpB,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,WAAW;KAClB,EACD;QACE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;KACvB,CACF,CAAA;IACD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;QACpB,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC;QACxB,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;QAC1B,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;KAC3B,CAAA;AACH,CAAC,CAAA;AAED,eAAe,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../script/cli/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,MAAM,YAAY,GAAG,CAAC,OAAiB,EAAE,EAAE;IACzC,MAAM,IAAI,GAAG,GAAG,CACd;QACE,UAAU,EAAE,MAAM;QAClB,WAAW,EAAE,MAAM;QACnB,WAAW,EAAE,OAAO;QACpB,QAAQ,EAAE,OAAO;QACjB,WAAW,EAAE,OAAO;QACpB,UAAU,EAAE,OAAO;QACnB,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,UAAU;KACjB,EACD;QACE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;KACvB,CACF,CAAA;IACD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;QACpB,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC;QACxB,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;QAC1B,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;QAC1B,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;QACzB,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC;KACzB,CAAA;AACH,CAAC,CAAA;AAED,eAAe,YAAY,CAAA"}

package/es6/script/help/index.js

@@ -1,21 +1,20 @@
-const st = `使用说明:
-1. 在控制台按上下切换功能并回车进行确认, 执行相对应的操作！
-2. 可以在package.json中的scripts下面配置如下，然后运行命令:
-agmd  --include str  --ignore str
-  选项:
-  --include string  / -i string..........  包括文件扩展名
-  --ignore string  / -in string........... 忽略文件或者文件夹
-
-  各选项的默认配置:
-  --ignore  img,styles,node_modules,LICENSE,.git,.github,dist,.husky,.vscode,readme-file.js,readme-md.js
-  --include  .js,.vue,.ts
-
-  说明:
-  配置中的字符串之间不应有空格
-
-  举例:
-
-  $ agmd  --ignore lib,node_modules,dist --include .js,.ts,.vue`;
+const st = `使用说明:
+1. 在控制台按上下切换功能并回车进行确认, 执行相对应的操作！
+2. 可以在 package.json 的 scripts 下配置如下, 然后运行命令:
+   agmd --include <string> --ignore <string> [--dry-run] [--silent]
+
+  选项:
+  --include string  / -in string..........  包括文件扩展名 (以空格分隔)
+  --ignore string  / -i string...........  忽略文件或文件夹 (以空格分隔)
+  --dry-run        / -d..................  预演模式, 不对文件系统进行写入
+  --silent         / -s..................  静默模式, 最小化日志输出
+
+  默认配置:
+  --ignore  img,styles,node_modules,LICENSE,.git,.github,dist,.husky,.vscode,readme-file.js,readme-md.js
+  --include .js,.vue,.ts,.tsx
+
+  示例:
+  $ agmd --ignore lib node_modules dist --include .js .ts .vue --dry-run --silent`;
 function help() {
     console.log(st);
     process.exit(0);

package/es6/script/help/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../script/help/index.ts"],"names":[],"mappings":"AAAA,MAAM,EAAE,GAAG;;;;;;;;;;;;;;;;;gEAiBqD,CAAA;AAEhE,SAAS,IAAI;IACX,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IACf,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC;AACD,eAAe,IAAI,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../script/help/index.ts"],"names":[],"mappings":"AAAA,MAAM,EAAE,GAAG;;;;;;;;;;;;;;;;kFAgBuE,CAAA;AAElF,SAAS,IAAI;IACX,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IACf,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC;AACD,eAAe,IAAI,CAAA"}

package/es6/src/bin.js

@@ -2,6 +2,7 @@
 import { Command } from 'commander';
 import { handleCommand } from './commands/command-handler';
 const program = new Command();
+program.allowUnknownOption(true);
 program.action(handleCommand);
 program.parse(process.argv);
 //# sourceMappingURL=bin.js.map

package/es6/src/bin.js.map

@@ -1 +1 @@
-{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;AAC7B,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;AAC7B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA"}
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;AAC7B,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;AAChC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;AAC7B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA"}

package/es6/src/commands/agmd.js.map

@@ -1 +1 @@
-{"version":3,"file":"agmd.js","sourceRoot":"","sources":["../../../src/commands/agmd.ts"],"names":[],"mappings":";;;;;;;;;;AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAC3C,OAAO,MAAM,MAAM,yBAAyB,CAAA;AAC3C,SAAe,IAAI;;QAClB,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC1C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;QAC9D,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAE,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QACrD,MAAM,iBAAiB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACpC,CAAC;CAAA;AAED,IAAI,EAAE,CAAA"}
+{"version":3,"file":"agmd.js","sourceRoot":"","sources":["../../../src/commands/agmd.ts"],"names":[],"mappings":";;;;;;;;;;AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAC3C,OAAO,MAAM,MAAM,yBAAyB,CAAA;AAE3C,SAAe,IAAI;;QAClB,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC1C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;QAC9D,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAE,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QACrD,MAAM,iBAAiB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACpC,CAAC;CAAA;AAED,IAAI,EAAE,CAAA"}