agmd 0.0.8 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <year> <author>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.EN.md

@@ -2,7 +2,7 @@
 
 
 
->Enter 'AGMD' in any folder where documents need to be generated, and the directory MD description can be automatically generated
+>If you need to generate documents, enter 'AGMD' in the console under the folder to automatically generate the directory MD description
 
 
 
@@ -10,9 +10,6 @@
 
 
 
-English| [中文](https://github.com/majun2232/vue3sketchRuler/blob/master/README.md)  
-
-
 
 ### Case
 
@@ -24,9 +21,9 @@ English| [中文](https://github.com/majun2232/vue3sketchRuler/blob/master/READM
 
 ### Method of use
 
+Node environment is required
 
-
-Global installation (Global installation is required, otherwise it will be reported that the "AGMD" item cannot be recognized as the name of cmdlet, function, script file or runnable program)
+1. Global installation (Global installation is required, otherwise it will be reported that the "AGMD" item cannot be recognized as the name of cmdlet, function, script file or runnable program)
 
 
 
@@ -42,6 +39,26 @@ Example is some of the files I prepared for the demonstration, which is of no ot
 
 
 
+2. Advanced usage
+
+Some need to insert 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
+
+>const { getFileNodes, getMd } = require('agmd')
+
+
+
+In es:
+
+>import {getFileNodes, getMd} from 'agmd'
+
+
+
+-Getfilenodes can obtain information related to specific files
+
+-Getmd gets the final output information
+
+
+
 ### Creative background
 
 
@@ -72,8 +89,20 @@ Example is some of the files I prepared for the demonstration, which is of no ot
 
 
 
+### Related articles
 
 
-### Related articles
 
-[Nuggets - auto generate directory MD file](https://juejin.cn/post/7030030599268073508)  
+[Nuggets - auto generate directory MD file]（ https://juejin.cn/post/7030030599268073508 )
+
+
+
+### Update record
+
+0.1. 0
+
+1. Package with esbuild
+
+2. It is written in eslint and preter specifications
+
+3. Rewrite with TS

package/README.md

@@ -1,17 +1,17 @@
 # agmd(auto generate md)
 
-> 在任何需要生成文档的，文件夹下输入`agmd`， 就能自动生成目录 md 说明
+> 在任何需要生成文档的，文件夹下的控制台中输入`agmd`， 就能自动生成目录 md 说明
 
 [![](https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667)](https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667)
 
-简体中文 | [English](https://github.com/majun2232/vue3sketchRuler/blob/master/README.EN.md)
+简体中文 | [English](https://github.com/majun2232/auto-generate-md/blob/master/README.EN.md)
 
 ### 案例
 
 ![image](https://github.com/majun2232/auto-generate-md/blob/master/md.png)
 
 ### 使用方法
-需要有node环境  
+需要有node环境
 1. 全局安装(必须全局安装，否则会报`无法将“agmd”项识别为 cmdlet、函数、脚本文件或可运行程序的名称`)
 
 > npm i agmd -g
@@ -21,10 +21,14 @@
 example，是我为演示准备的一些文件，并没有其他用
 
 2. 高级用法
-   有些需要把自动生成的文档插入到某个自动生成的 md 当中, 该插件导出了自动生成的 md 数据方法, 还有`getFileNodes`获得所有文件的具体信息, 可以 DIY 做出不同的文档
-   > import {getFileNodes, getMd} from agmd  
-   > 其中 getFileNodes 可以获得具体文件相关的信息  
-   > getMd 得到最终输出的信息
+有些需要把自动生成的文档插入到某个自动生成的 md 当中, 该插件导出了自动生成的 md 数据方法, 还有`getFileNodes`获得所有文件的具体信息, 可以 DIY 做出不同的文档
+>const { getFileNodes, getMd } = require('agmd')
+
+es中:
+ >import {getFileNodes, getMd} from 'agmd'
+
+- 其中 getFileNodes 可以获得具体文件相关的信息
+- getMd 得到最终输出的信息
 
 ### 创作背景
 
@@ -44,3 +48,9 @@ example，是我为演示准备的一些文件，并没有其他用
 ### 相关文章
 
 [掘金-自动生成目录 md 文件](https://juejin.cn/post/7030030599268073508)
+
+### 更新记录
+0.1.3
+1. 采用esbuild 进行打包
+2. 并且用eslint, preter规范写法, 规范
+3. 用ts进行改写

package/bin/agmd.js

@@ -1,49 +1,139 @@
 #!/usr/bin/env node
-// 获取文件的头部注释工具
-import path from "path";
-import fs from "fs";
-const __dirname = path.resolve();
-import { getMd } from "../module.js";
-/**
- * @description: 把结果写入到js文件
- * @param {data}  要写的数据
- * @return {fileName}  要写入文件地址
- */
-function wirteJs(data, filePath) {
-  let file = path.resolve(__dirname, filePath);
-  const pre = "export default";
-  // 异步写入数据到文件
-  fs.writeFile(file, pre + data, { encoding: "utf8" }, (err) => {});
+/*!
+* agmd v0.0.11
+* author:majun <253495832@qq.com>
+* Fri Dec 17 2021 09:30:50 GMT+0800 (中国标准时间)
+*/
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __reExport = (target, module2, copyDefault, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
+        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+  }
+  return target;
+};
+var __toESM = (module2, isNodeMode) => {
+  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+};
+
+// src/agmd.ts
+var import_path2 = __toESM(require("path"));
+var import_fs2 = __toESM(require("fs"));
+
+// src/index.ts
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+function getFile(file) {
+  const str = import_fs.default.readFileSync(file, "utf-8");
+  const sarr = str.split(/[\n,]/g);
+  const f = sarr[0].indexOf("eslint") === -1 && (sarr[0].indexOf("-->") > -1 || sarr[0].indexOf("*/") > -1 || sarr[0].indexOf("//") > -1) ? sarr[0] : "";
+  return f;
+}
+var filterArr = ["img", "styles", "node_modules", "LICENSE", ".git", ".github", "dist", ".husky", ".vscode"];
+var includeArrs = [".js", ".vue", ".ts"];
+function getFileNodes(nodes = [], dir = import_path.default.resolve("./"), level = 0) {
+  const files = import_fs.default.readdirSync(dir).map((item) => {
+    const fullPath = import_path.default.join(dir, item);
+    const isDir = import_fs.default.lstatSync(fullPath).isDirectory();
+    return {
+      name: item,
+      isDir,
+      level,
+      note: ""
+    };
+  }).sort((a, b) => {
+    if (!a.isDir && b.isDir)
+      return 1;
+    if (a.isDir && !b.isDir)
+      return -1;
+    if (a.isDir && b.isDir || !a.isDir && !b.isDir)
+      return 0;
+    return 0;
+  });
+  for (let index = 0; index < files.length; index += 1) {
+    const item = files[index];
+    let note = "";
+    const arr = filterArr.findIndex((obj) => obj === item.name);
+    if (arr === -1) {
+      const fullPath = import_path.default.join(dir, item.name);
+      const isDir = import_fs.default.lstatSync(fullPath).isDirectory();
+      if (isDir) {
+        getFileNodes(item.children = [], fullPath, level + 1);
+      } else {
+        const i = fullPath.lastIndexOf(".");
+        const lastName = fullPath.substring(i);
+        if ([".js", ".vue", ".ts"].includes(lastName)) {
+          note = getFile(fullPath);
+        }
+        item.note = note;
+      }
+      nodes.push(item);
+    }
+  }
+  return nodes;
+}
+function getNote(datas, keys) {
+  const nodes = keys || [];
+  datas.forEach((obj) => {
+    if (obj.children) {
+      const md = setMd(obj);
+      nodes.push(md);
+      getNote(obj.children, nodes);
+    } else {
+      const md = setMd(obj);
+      nodes.push(md);
+    }
+  });
+  return nodes;
+}
+function setMd(obj) {
+  let filesString = "";
+  const blank = "  ".repeat(obj.level);
+  if (obj.isDir) {
+    filesString += `${blank}+ ${obj.name}
+`;
+  } else {
+    const index = obj.name.lastIndexOf(".");
+    const lastName = obj.name.substring(index);
+    if (includeArrs.includes(lastName) || index === -1) {
+      filesString += `${blank}  ${obj.name}            ${obj.note}
+`;
+    }
+  }
+  return filesString;
+}
+function getMd() {
+  console.log("%s", "*** run location: ", import_path.default.resolve("./"));
+  const nodes = getFileNodes();
+  const note = getNote(nodes);
+  const md = note.join("");
+  if (md.length > 0) {
+    console.log("%s", "*** Automatic generation completed ! ");
+  }
+  return md;
 }
 
-/**
- * @description: 把结果写入到js文件
- * @param {data}  要写的数据
- * @return {fileName}  要写入文件地址
- */
+// src/agmd.ts
+var __dirname = import_path2.default.resolve();
 function wirteMd(data, filePath) {
-  let file = path.resolve(__dirname, filePath);
+  const file = import_path2.default.resolve(__dirname, filePath);
   const pre = "```js\n";
   const last = "```\n";
-  // 异步写入数据到文件
-  fs.writeFile(file, pre + data + last, { encoding: "utf8" }, (err) => {});
+  import_fs2.default.writeFile(file, pre + data + last, { encoding: "utf8" }, (err) => {
+    console.error(err);
+  });
 }
-
-/**
- * @description: 自动生成全流程
- * @param {*}
- * @return {*}
- */
 function agmd() {
   const md = getMd();
-  // 得到md对象
-  // wirteJs(JSON.stringify(nodes), __dirname + "\\readme-file.js");
-  // 得到md文档
-  console.log(
-    "\x1B[36m%s\x1B[0m",
-    "*** location: ",
-    path.resolve("./") + "\\readme-md.md"
-  );
-  wirteMd(md, path.resolve("./") + "\\readme-md.md");
+  console.log("%s", "*** location: ", `${import_path2.default.resolve("./")}\\readme-md.md`);
+  wirteMd(md, `${import_path2.default.resolve("./")}\\readme-md.md`);
 }
 agmd();
+//# sourceMappingURL=agmd.js.map

package/bin/agmd.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/agmd.ts", "../src/index.ts"],
+  "sourcesContent": ["#!/usr/bin/env node\r\n// \u83B7\u53D6\u6587\u4EF6\u7684\u5934\u90E8\u6CE8\u91CA\u5DE5\u5177\r\nimport path from 'path'\r\nimport fs from 'fs'\r\nimport { getMd } from './index'\r\n\r\nconst __dirname = path.resolve()\r\n/**\r\n * @description: \u628A\u7ED3\u679C\u5199\u5165\u5230js\u6587\u4EF6\r\n * @param {data}  \u8981\u5199\u7684\u6570\u636E\r\n * @return {fileName}  \u8981\u5199\u5165\u6587\u4EF6\u5730\u5740\r\n */\r\n// function wirteJs(data: string, filePath: string) {\r\n//   const file = path.resolve(__dirname, filePath)\r\n//   const pre = 'export default'\r\n//   // \u5F02\u6B65\u5199\u5165\u6570\u636E\u5230\u6587\u4EF6\r\n//   fs.writeFile(file, pre + data, { encoding: 'utf8' }, (err) => {\r\n//     console.error(err);\r\n//   })\r\n// }\r\n\r\n/**\r\n * @description: \u628A\u7ED3\u679C\u5199\u5165\u5230js\u6587\u4EF6\r\n * @param {data}  \u8981\u5199\u7684\u6570\u636E\r\n * @return {fileName}  \u8981\u5199\u5165\u6587\u4EF6\u5730\u5740\r\n */\r\nfunction wirteMd(data: string, filePath: string) {\r\n  const file = path.resolve(__dirname, filePath)\r\n  const pre = '```js\\n'\r\n  const last = '```\\n'\r\n  // \u5F02\u6B65\u5199\u5165\u6570\u636E\u5230\u6587\u4EF6\r\n  fs.writeFile(file, pre + data + last, { encoding: 'utf8' }, (err) => { console.error(err);})\r\n}\r\n\r\n/**\r\n * @description: \u81EA\u52A8\u751F\u6210\u5168\u6D41\u7A0B\r\n * @param {*}\r\n * @return {*}\r\n */\r\nfunction agmd() {\r\n  const md = getMd()\r\n  // \u5F97\u5230md\u5BF9\u8C61\r\n  // wirteJs(JSON.stringify(nodes), __dirname + \"\\\\readme-file.js\");\r\n  // \u5F97\u5230md\u6587\u6863\r\n  console.log('\\x1B[36m%s\\x1B[0m', '*** location: ', `${path.resolve('./')}\\\\readme-md.md`)\r\n  wirteMd(md, `${path.resolve('./')}\\\\readme-md.md`)\r\n}\r\nagmd()\r\n", "import fs from 'fs'\nimport path from 'path'\n\n/**\n * @description: \u83B7\u53D6\u6587\u4EF6\u7684\u5934\u90E8\u6CE8\u91CA\n * @param {*} file\n * @return {*}\n */\nfunction getFile(file: fs.PathOrFileDescriptor) {\n  const str = fs.readFileSync(file, 'utf-8')\n  const sarr = str.split(/[\\n,]/g)\n  // console.log(file);\n  const f =\n    sarr[0].indexOf('eslint') === -1 &&\n    (sarr[0].indexOf('-->') > -1 || sarr[0].indexOf('*/') > -1 || sarr[0].indexOf('//') > -1)\n      ? sarr[0]\n      : ''\n  // console.log(f);\n  return f\n}\n// \u8FC7\u6EE4\u6587\u4EF6\u5939\nconst filterArr = ['img', 'styles', 'node_modules', 'LICENSE', '.git', '.github', 'dist', '.husky', '.vscode']\n// \u8FD9\u91CC\u53EA\u83B7\u53D6\u67D0\u540E\u7F00\u6587\u4EF6\u7684\u6CE8\u91CA,\u9700\u8981\u5176\u4ED6\u8FD9\u91CC\u52A0\u5165\nconst includeArrs = ['.js', '.vue', '.ts']\n\nexport type ItemType ={\n  name: string\n  isDir: boolean\n  level: number\n  note: string\n  children?: ItemType[]\n}\n\n/**\n * @description: \u751F\u6210\u6240\u6709\u6587\u4EF6\u7684node\u4FE1\u606F\n * @param {*} nodes\n * @param {*} dir\n * @param {*} level\n * @return {*}\n */\n export function getFileNodes(nodes: Array<ItemType> = [], dir = path.resolve('./'), level = 0): Array<ItemType> {\n  const files = fs\n    .readdirSync(dir)\n    .map((item) => {\n      const fullPath = path.join(dir, item)\n      const isDir = fs.lstatSync(fullPath).isDirectory()\n      return {\n        name: item,\n        isDir,\n        level,\n        note: ''\n      } as ItemType\n    })\n    // \u5BF9\u6587\u4EF6\u5939\u548C\u6587\u4EF6\u8FDB\u884C\u6392\u5E8F,\u8981\u4E0D\u7136\u751F\u6210\u7684\u548C\u7F16\u8F91\u5668\u6253\u5F00\u7684\u987A\u5E8F\u4E0D\u5BF9\u5E94\n    .sort((a, b) => {\n      if (!a.isDir && b.isDir) return 1\n      if (a.isDir && !b.isDir) return -1\n      if ((a.isDir && b.isDir) || (!a.isDir && !b.isDir)) return 0\n      return 0\n    })\n  for (let index = 0; index < files.length; index += 1) {\n    const item = files[index]\n    let note = '' // \u6587\u4EF6\u6CE8\u91CA\n    const arr = filterArr.findIndex((obj) => obj === item.name)\n    if (arr === -1) {\n      const fullPath = path.join(dir, item.name)\n      const isDir = fs.lstatSync(fullPath).isDirectory()\n      if (isDir) {\n        // \u9012\u5F52\n        getFileNodes((item.children = []), fullPath, level + 1)\n      } else {\n        const i = fullPath.lastIndexOf('.')\n        const lastName = fullPath.substring(i)\n        // \u8FD9\u91CC\u53EA\u83B7\u53D6js\u548Cvue,ts\u6587\u4EF6\u7684\u6CE8\u91CA\n        if (['.js', '.vue', '.ts'].includes(lastName)) {\n          note = getFile(fullPath)\n        }\n        item.note = note\n      }\n      nodes.push(item)\n    }\n  }\n  // \u63A7\u5236\u8FD4\u56DE\u65F6\u95F4\u8282\u70B9,\u4E0D\u8BA9\u63D0\u524D\u8FD4\u56DE\n  return nodes\n}\n\n/**\n * @description: \u9012\u5F52\u5F97\u5230\u6587\u4EF6\u540D+note\n * @param {*} datas\n * @param {*} keys\n * @return {*}\n */\nfunction getNote(datas: Array<ItemType>, keys?: string[]) {\n  const nodes = keys || []\n  datas.forEach((obj: ItemType) => {\n    if (obj.children) {\n      // \u6587\u4EF6\u5939\n      const md = setMd(obj)\n      nodes.push(md)\n      getNote(obj.children, nodes)\n    }\n    // \u6587\u4EF6\n    else {\n      const md = setMd(obj)\n      nodes.push(md)\n    }\n  })\n  return nodes\n}\n\n/**\n * @description: \u4E00\u4E2Aobj\u751F\u6210\u4E00\u4E2A\u4E00\u884C\u6587\u5B57\n * @param {*} obj\n * @return {*}\n */\nfunction setMd(obj: ItemType): string {\n  let filesString = ''\n  // \u628A\u6587\u4EF6\u5939\u8F93\u51FA,\u5E76\u4E14level+1\n  const blank = '  '.repeat(obj.level) // \u91CD\u590D\u7A7A\u767D\n  if (obj.isDir) {\n    filesString += `${blank}+ ${obj.name}\\n`\n  } else {\n    const index = obj.name.lastIndexOf('.')\n    const lastName = obj.name.substring(index)\n    // \u8FD9\u91CC\u53EA\u83B7\u53D6\u67D0\u540E\u7F00\u6587\u4EF6\u7684\u6CE8\u91CA\n    if (includeArrs.includes(lastName) || index === -1) {\n      filesString += `${blank}  ${obj.name}            ${obj.note}\\n`\n    }\n  }\n  return filesString\n}\n\nexport function getMd() {\n  console.log('\\x1B[36m%s\\x1B[0m', '*** run location: ', path.resolve('./'))\n  const nodes = getFileNodes()\n  const note = getNote(nodes) // \u5F97\u5230\u6240\u6709note\u7684\u6570\u7EC4\n  const md = note.join('') // \u6570\u7EC4\u8F6C\u5B57\u7B26\u4E32\n  if (md.length > 0) {\n    console.log('\\x1B[36m%s\\x1B[0m', '*** Automatic generation completed ! ')\n  }\n  return md\n}\n\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,mBAAiB;AACjB,iBAAe;;;ACHf,gBAAe;AACf,kBAAiB;AAOjB,iBAAiB,MAA+B;AAC9C,QAAM,MAAM,kBAAG,aAAa,MAAM;AAClC,QAAM,OAAO,IAAI,MAAM;AAEvB,QAAM,IACJ,KAAK,GAAG,QAAQ,cAAc,MAC7B,MAAK,GAAG,QAAQ,SAAS,MAAM,KAAK,GAAG,QAAQ,QAAQ,MAAM,KAAK,GAAG,QAAQ,QAAQ,MAClF,KAAK,KACL;AAEN,SAAO;AAAA;AAGT,IAAM,YAAY,CAAC,OAAO,UAAU,gBAAgB,WAAW,QAAQ,WAAW,QAAQ,UAAU;AAEpG,IAAM,cAAc,CAAC,OAAO,QAAQ;AAiB5B,sBAAsB,QAAyB,IAAI,MAAM,oBAAK,QAAQ,OAAO,QAAQ,GAAoB;AAC/G,QAAM,QAAQ,kBACX,YAAY,KACZ,IAAI,CAAC,SAAS;AACb,UAAM,WAAW,oBAAK,KAAK,KAAK;AAChC,UAAM,QAAQ,kBAAG,UAAU,UAAU;AACrC,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MACA;AAAA,MACA,MAAM;AAAA;AAAA,KAIT,KAAK,CAAC,GAAG,MAAM;AACd,QAAI,CAAC,EAAE,SAAS,EAAE;AAAO,aAAO;AAChC,QAAI,EAAE,SAAS,CAAC,EAAE;AAAO,aAAO;AAChC,QAAK,EAAE,SAAS,EAAE,SAAW,CAAC,EAAE,SAAS,CAAC,EAAE;AAAQ,aAAO;AAC3D,WAAO;AAAA;AAEX,WAAS,QAAQ,GAAG,QAAQ,MAAM,QAAQ,SAAS,GAAG;AACpD,UAAM,OAAO,MAAM;AACnB,QAAI,OAAO;AACX,UAAM,MAAM,UAAU,UAAU,CAAC,QAAQ,QAAQ,KAAK;AACtD,QAAI,QAAQ,IAAI;AACd,YAAM,WAAW,oBAAK,KAAK,KAAK,KAAK;AACrC,YAAM,QAAQ,kBAAG,UAAU,UAAU;AACrC,UAAI,OAAO;AAET,qBAAc,KAAK,WAAW,IAAK,UAAU,QAAQ;AAAA,aAChD;AACL,cAAM,IAAI,SAAS,YAAY;AAC/B,cAAM,WAAW,SAAS,UAAU;AAEpC,YAAI,CAAC,OAAO,QAAQ,OAAO,SAAS,WAAW;AAC7C,iBAAO,QAAQ;AAAA;AAEjB,aAAK,OAAO;AAAA;AAEd,YAAM,KAAK;AAAA;AAAA;AAIf,SAAO;AAAA;AAST,iBAAiB,OAAwB,MAAiB;AACxD,QAAM,QAAQ,QAAQ;AACtB,QAAM,QAAQ,CAAC,QAAkB;AAC/B,QAAI,IAAI,UAAU;AAEhB,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK;AACX,cAAQ,IAAI,UAAU;AAAA,WAGnB;AACH,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK;AAAA;AAAA;AAGf,SAAO;AAAA;AAQT,eAAe,KAAuB;AACpC,MAAI,cAAc;AAElB,QAAM,QAAQ,KAAK,OAAO,IAAI;AAC9B,MAAI,IAAI,OAAO;AACb,mBAAe,GAAG,UAAU,IAAI;AAAA;AAAA,SAC3B;AACL,UAAM,QAAQ,IAAI,KAAK,YAAY;AACnC,UAAM,WAAW,IAAI,KAAK,UAAU;AAEpC,QAAI,YAAY,SAAS,aAAa,UAAU,IAAI;AAClD,qBAAe,GAAG,UAAU,IAAI,mBAAmB,IAAI;AAAA;AAAA;AAAA;AAG3D,SAAO;AAAA;AAGF,iBAAiB;AACtB,UAAQ,IAAI,eAAqB,sBAAsB,oBAAK,QAAQ;AACpE,QAAM,QAAQ;AACd,QAAM,OAAO,QAAQ;AACrB,QAAM,KAAK,KAAK,KAAK;AACrB,MAAI,GAAG,SAAS,GAAG;AACjB,YAAQ,IAAI,eAAqB;AAAA;AAEnC,SAAO;AAAA;;;ADtIT,IAAM,YAAY,qBAAK;AAoBvB,iBAAiB,MAAc,UAAkB;AAC/C,QAAM,OAAO,qBAAK,QAAQ,WAAW;AACrC,QAAM,MAAM;AACZ,QAAM,OAAO;AAEb,qBAAG,UAAU,MAAM,MAAM,OAAO,MAAM,EAAE,UAAU,UAAU,CAAC,QAAQ;AAAE,YAAQ,MAAM;AAAA;AAAA;AAQvF,gBAAgB;AACd,QAAM,KAAK;AAIX,UAAQ,IAAI,eAAqB,kBAAkB,GAAG,qBAAK,QAAQ;AACnE,UAAQ,IAAI,GAAG,qBAAK,QAAQ;AAAA;AAE9B;",
+  "names": []
+}

package/lib/index.cjs.js

@@ -0,0 +1,137 @@
+/*!
+* agmd v0.0.11
+* author:majun <253495832@qq.com>
+* Fri Dec 17 2021 09:30:50 GMT+0800 (中国标准时间)
+*/
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __reExport = (target, module2, copyDefault, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
+        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+  }
+  return target;
+};
+var __toESM = (module2, isNodeMode) => {
+  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+};
+var __toCommonJS = /* @__PURE__ */ ((cache) => {
+  return (module2, temp) => {
+    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
+  };
+})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  getFileNodes: () => getFileNodes,
+  getMd: () => getMd
+});
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+function getFile(file) {
+  const str = import_fs.default.readFileSync(file, "utf-8");
+  const sarr = str.split(/[\n,]/g);
+  const f = sarr[0].indexOf("eslint") === -1 && (sarr[0].indexOf("-->") > -1 || sarr[0].indexOf("*/") > -1 || sarr[0].indexOf("//") > -1) ? sarr[0] : "";
+  return f;
+}
+var filterArr = ["img", "styles", "node_modules", "LICENSE", ".git", ".github", "dist", ".husky", ".vscode"];
+var includeArrs = [".js", ".vue", ".ts"];
+function getFileNodes(nodes = [], dir = import_path.default.resolve("./"), level = 0) {
+  const files = import_fs.default.readdirSync(dir).map((item) => {
+    const fullPath = import_path.default.join(dir, item);
+    const isDir = import_fs.default.lstatSync(fullPath).isDirectory();
+    return {
+      name: item,
+      isDir,
+      level,
+      note: ""
+    };
+  }).sort((a, b) => {
+    if (!a.isDir && b.isDir)
+      return 1;
+    if (a.isDir && !b.isDir)
+      return -1;
+    if (a.isDir && b.isDir || !a.isDir && !b.isDir)
+      return 0;
+    return 0;
+  });
+  for (let index = 0; index < files.length; index += 1) {
+    const item = files[index];
+    let note = "";
+    const arr = filterArr.findIndex((obj) => obj === item.name);
+    if (arr === -1) {
+      const fullPath = import_path.default.join(dir, item.name);
+      const isDir = import_fs.default.lstatSync(fullPath).isDirectory();
+      if (isDir) {
+        getFileNodes(item.children = [], fullPath, level + 1);
+      } else {
+        const i = fullPath.lastIndexOf(".");
+        const lastName = fullPath.substring(i);
+        if ([".js", ".vue", ".ts"].includes(lastName)) {
+          note = getFile(fullPath);
+        }
+        item.note = note;
+      }
+      nodes.push(item);
+    }
+  }
+  return nodes;
+}
+function getNote(datas, keys) {
+  const nodes = keys || [];
+  datas.forEach((obj) => {
+    if (obj.children) {
+      const md = setMd(obj);
+      nodes.push(md);
+      getNote(obj.children, nodes);
+    } else {
+      const md = setMd(obj);
+      nodes.push(md);
+    }
+  });
+  return nodes;
+}
+function setMd(obj) {
+  let filesString = "";
+  const blank = "  ".repeat(obj.level);
+  if (obj.isDir) {
+    filesString += `${blank}+ ${obj.name}
+`;
+  } else {
+    const index = obj.name.lastIndexOf(".");
+    const lastName = obj.name.substring(index);
+    if (includeArrs.includes(lastName) || index === -1) {
+      filesString += `${blank}  ${obj.name}            ${obj.note}
+`;
+    }
+  }
+  return filesString;
+}
+function getMd() {
+  console.log("%s", "*** run location: ", import_path.default.resolve("./"));
+  const nodes = getFileNodes();
+  const note = getNote(nodes);
+  const md = note.join("");
+  if (md.length > 0) {
+    console.log("%s", "*** Automatic generation completed ! ");
+  }
+  return md;
+}
+module.exports = __toCommonJS(src_exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getFileNodes,
+  getMd
+});
+//# sourceMappingURL=index.cjs.js.map

package/lib/index.cjs.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["import fs from 'fs'\nimport path from 'path'\n\n/**\n * @description: \u83B7\u53D6\u6587\u4EF6\u7684\u5934\u90E8\u6CE8\u91CA\n * @param {*} file\n * @return {*}\n */\nfunction getFile(file: fs.PathOrFileDescriptor) {\n  const str = fs.readFileSync(file, 'utf-8')\n  const sarr = str.split(/[\\n,]/g)\n  // console.log(file);\n  const f =\n    sarr[0].indexOf('eslint') === -1 &&\n    (sarr[0].indexOf('-->') > -1 || sarr[0].indexOf('*/') > -1 || sarr[0].indexOf('//') > -1)\n      ? sarr[0]\n      : ''\n  // console.log(f);\n  return f\n}\n// \u8FC7\u6EE4\u6587\u4EF6\u5939\nconst filterArr = ['img', 'styles', 'node_modules', 'LICENSE', '.git', '.github', 'dist', '.husky', '.vscode']\n// \u8FD9\u91CC\u53EA\u83B7\u53D6\u67D0\u540E\u7F00\u6587\u4EF6\u7684\u6CE8\u91CA,\u9700\u8981\u5176\u4ED6\u8FD9\u91CC\u52A0\u5165\nconst includeArrs = ['.js', '.vue', '.ts']\n\nexport type ItemType ={\n  name: string\n  isDir: boolean\n  level: number\n  note: string\n  children?: ItemType[]\n}\n\n/**\n * @description: \u751F\u6210\u6240\u6709\u6587\u4EF6\u7684node\u4FE1\u606F\n * @param {*} nodes\n * @param {*} dir\n * @param {*} level\n * @return {*}\n */\n export function getFileNodes(nodes: Array<ItemType> = [], dir = path.resolve('./'), level = 0): Array<ItemType> {\n  const files = fs\n    .readdirSync(dir)\n    .map((item) => {\n      const fullPath = path.join(dir, item)\n      const isDir = fs.lstatSync(fullPath).isDirectory()\n      return {\n        name: item,\n        isDir,\n        level,\n        note: ''\n      } as ItemType\n    })\n    // \u5BF9\u6587\u4EF6\u5939\u548C\u6587\u4EF6\u8FDB\u884C\u6392\u5E8F,\u8981\u4E0D\u7136\u751F\u6210\u7684\u548C\u7F16\u8F91\u5668\u6253\u5F00\u7684\u987A\u5E8F\u4E0D\u5BF9\u5E94\n    .sort((a, b) => {\n      if (!a.isDir && b.isDir) return 1\n      if (a.isDir && !b.isDir) return -1\n      if ((a.isDir && b.isDir) || (!a.isDir && !b.isDir)) return 0\n      return 0\n    })\n  for (let index = 0; index < files.length; index += 1) {\n    const item = files[index]\n    let note = '' // \u6587\u4EF6\u6CE8\u91CA\n    const arr = filterArr.findIndex((obj) => obj === item.name)\n    if (arr === -1) {\n      const fullPath = path.join(dir, item.name)\n      const isDir = fs.lstatSync(fullPath).isDirectory()\n      if (isDir) {\n        // \u9012\u5F52\n        getFileNodes((item.children = []), fullPath, level + 1)\n      } else {\n        const i = fullPath.lastIndexOf('.')\n        const lastName = fullPath.substring(i)\n        // \u8FD9\u91CC\u53EA\u83B7\u53D6js\u548Cvue,ts\u6587\u4EF6\u7684\u6CE8\u91CA\n        if (['.js', '.vue', '.ts'].includes(lastName)) {\n          note = getFile(fullPath)\n        }\n        item.note = note\n      }\n      nodes.push(item)\n    }\n  }\n  // \u63A7\u5236\u8FD4\u56DE\u65F6\u95F4\u8282\u70B9,\u4E0D\u8BA9\u63D0\u524D\u8FD4\u56DE\n  return nodes\n}\n\n/**\n * @description: \u9012\u5F52\u5F97\u5230\u6587\u4EF6\u540D+note\n * @param {*} datas\n * @param {*} keys\n * @return {*}\n */\nfunction getNote(datas: Array<ItemType>, keys?: string[]) {\n  const nodes = keys || []\n  datas.forEach((obj: ItemType) => {\n    if (obj.children) {\n      // \u6587\u4EF6\u5939\n      const md = setMd(obj)\n      nodes.push(md)\n      getNote(obj.children, nodes)\n    }\n    // \u6587\u4EF6\n    else {\n      const md = setMd(obj)\n      nodes.push(md)\n    }\n  })\n  return nodes\n}\n\n/**\n * @description: \u4E00\u4E2Aobj\u751F\u6210\u4E00\u4E2A\u4E00\u884C\u6587\u5B57\n * @param {*} obj\n * @return {*}\n */\nfunction setMd(obj: ItemType): string {\n  let filesString = ''\n  // \u628A\u6587\u4EF6\u5939\u8F93\u51FA,\u5E76\u4E14level+1\n  const blank = '  '.repeat(obj.level) // \u91CD\u590D\u7A7A\u767D\n  if (obj.isDir) {\n    filesString += `${blank}+ ${obj.name}\\n`\n  } else {\n    const index = obj.name.lastIndexOf('.')\n    const lastName = obj.name.substring(index)\n    // \u8FD9\u91CC\u53EA\u83B7\u53D6\u67D0\u540E\u7F00\u6587\u4EF6\u7684\u6CE8\u91CA\n    if (includeArrs.includes(lastName) || index === -1) {\n      filesString += `${blank}  ${obj.name}            ${obj.note}\\n`\n    }\n  }\n  return filesString\n}\n\nexport function getMd() {\n  console.log('\\x1B[36m%s\\x1B[0m', '*** run location: ', path.resolve('./'))\n  const nodes = getFileNodes()\n  const note = getNote(nodes) // \u5F97\u5230\u6240\u6709note\u7684\u6570\u7EC4\n  const md = note.join('') // \u6570\u7EC4\u8F6C\u5B57\u7B26\u4E32\n  if (md.length > 0) {\n    console.log('\\x1B[36m%s\\x1B[0m', '*** Automatic generation completed ! ')\n  }\n  return md\n}\n\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAAe;AACf,kBAAiB;AAOjB,iBAAiB,MAA+B;AAC9C,QAAM,MAAM,kBAAG,aAAa,MAAM;AAClC,QAAM,OAAO,IAAI,MAAM;AAEvB,QAAM,IACJ,KAAK,GAAG,QAAQ,cAAc,MAC7B,MAAK,GAAG,QAAQ,SAAS,MAAM,KAAK,GAAG,QAAQ,QAAQ,MAAM,KAAK,GAAG,QAAQ,QAAQ,MAClF,KAAK,KACL;AAEN,SAAO;AAAA;AAGT,IAAM,YAAY,CAAC,OAAO,UAAU,gBAAgB,WAAW,QAAQ,WAAW,QAAQ,UAAU;AAEpG,IAAM,cAAc,CAAC,OAAO,QAAQ;AAiB5B,sBAAsB,QAAyB,IAAI,MAAM,oBAAK,QAAQ,OAAO,QAAQ,GAAoB;AAC/G,QAAM,QAAQ,kBACX,YAAY,KACZ,IAAI,CAAC,SAAS;AACb,UAAM,WAAW,oBAAK,KAAK,KAAK;AAChC,UAAM,QAAQ,kBAAG,UAAU,UAAU;AACrC,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MACA;AAAA,MACA,MAAM;AAAA;AAAA,KAIT,KAAK,CAAC,GAAG,MAAM;AACd,QAAI,CAAC,EAAE,SAAS,EAAE;AAAO,aAAO;AAChC,QAAI,EAAE,SAAS,CAAC,EAAE;AAAO,aAAO;AAChC,QAAK,EAAE,SAAS,EAAE,SAAW,CAAC,EAAE,SAAS,CAAC,EAAE;AAAQ,aAAO;AAC3D,WAAO;AAAA;AAEX,WAAS,QAAQ,GAAG,QAAQ,MAAM,QAAQ,SAAS,GAAG;AACpD,UAAM,OAAO,MAAM;AACnB,QAAI,OAAO;AACX,UAAM,MAAM,UAAU,UAAU,CAAC,QAAQ,QAAQ,KAAK;AACtD,QAAI,QAAQ,IAAI;AACd,YAAM,WAAW,oBAAK,KAAK,KAAK,KAAK;AACrC,YAAM,QAAQ,kBAAG,UAAU,UAAU;AACrC,UAAI,OAAO;AAET,qBAAc,KAAK,WAAW,IAAK,UAAU,QAAQ;AAAA,aAChD;AACL,cAAM,IAAI,SAAS,YAAY;AAC/B,cAAM,WAAW,SAAS,UAAU;AAEpC,YAAI,CAAC,OAAO,QAAQ,OAAO,SAAS,WAAW;AAC7C,iBAAO,QAAQ;AAAA;AAEjB,aAAK,OAAO;AAAA;AAEd,YAAM,KAAK;AAAA;AAAA;AAIf,SAAO;AAAA;AAST,iBAAiB,OAAwB,MAAiB;AACxD,QAAM,QAAQ,QAAQ;AACtB,QAAM,QAAQ,CAAC,QAAkB;AAC/B,QAAI,IAAI,UAAU;AAEhB,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK;AACX,cAAQ,IAAI,UAAU;AAAA,WAGnB;AACH,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK;AAAA;AAAA;AAGf,SAAO;AAAA;AAQT,eAAe,KAAuB;AACpC,MAAI,cAAc;AAElB,QAAM,QAAQ,KAAK,OAAO,IAAI;AAC9B,MAAI,IAAI,OAAO;AACb,mBAAe,GAAG,UAAU,IAAI;AAAA;AAAA,SAC3B;AACL,UAAM,QAAQ,IAAI,KAAK,YAAY;AACnC,UAAM,WAAW,IAAI,KAAK,UAAU;AAEpC,QAAI,YAAY,SAAS,aAAa,UAAU,IAAI;AAClD,qBAAe,GAAG,UAAU,IAAI,mBAAmB,IAAI;AAAA;AAAA;AAAA;AAG3D,SAAO;AAAA;AAGF,iBAAiB;AACtB,UAAQ,IAAI,eAAqB,sBAAsB,oBAAK,QAAQ;AACpE,QAAM,QAAQ;AACd,QAAM,OAAO,QAAQ;AACrB,QAAM,KAAK,KAAK,KAAK;AACrB,MAAI,GAAG,SAAS,GAAG;AACjB,YAAQ,IAAI,eAAqB;AAAA;AAEnC,SAAO;AAAA;",
+  "names": []
+}

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+export declare type ItemType = {
+    name: string;
+    isDir: boolean;
+    level: number;
+    note: string;
+    children?: ItemType[];
+};
+export declare function getFileNodes(nodes?: Array<ItemType>, dir?: string, level?: number): Array<ItemType>;
+export declare function getMd(): string;

package/lib/index.esm.js

@@ -0,0 +1,102 @@
+/*!
+* agmd v0.0.11
+* author:majun <253495832@qq.com>
+* Fri Dec 17 2021 09:30:50 GMT+0800 (中国标准时间)
+*/
+// src/index.ts
+import fs from "fs";
+import path from "path";
+function getFile(file) {
+  const str = fs.readFileSync(file, "utf-8");
+  const sarr = str.split(/[\n,]/g);
+  const f = sarr[0].indexOf("eslint") === -1 && (sarr[0].indexOf("-->") > -1 || sarr[0].indexOf("*/") > -1 || sarr[0].indexOf("//") > -1) ? sarr[0] : "";
+  return f;
+}
+var filterArr = ["img", "styles", "node_modules", "LICENSE", ".git", ".github", "dist", ".husky", ".vscode"];
+var includeArrs = [".js", ".vue", ".ts"];
+function getFileNodes(nodes = [], dir = path.resolve("./"), level = 0) {
+  const files = fs.readdirSync(dir).map((item) => {
+    const fullPath = path.join(dir, item);
+    const isDir = fs.lstatSync(fullPath).isDirectory();
+    return {
+      name: item,
+      isDir,
+      level,
+      note: ""
+    };
+  }).sort((a, b) => {
+    if (!a.isDir && b.isDir)
+      return 1;
+    if (a.isDir && !b.isDir)
+      return -1;
+    if (a.isDir && b.isDir || !a.isDir && !b.isDir)
+      return 0;
+    return 0;
+  });
+  for (let index = 0; index < files.length; index += 1) {
+    const item = files[index];
+    let note = "";
+    const arr = filterArr.findIndex((obj) => obj === item.name);
+    if (arr === -1) {
+      const fullPath = path.join(dir, item.name);
+      const isDir = fs.lstatSync(fullPath).isDirectory();
+      if (isDir) {
+        getFileNodes(item.children = [], fullPath, level + 1);
+      } else {
+        const i = fullPath.lastIndexOf(".");
+        const lastName = fullPath.substring(i);
+        if ([".js", ".vue", ".ts"].includes(lastName)) {
+          note = getFile(fullPath);
+        }
+        item.note = note;
+      }
+      nodes.push(item);
+    }
+  }
+  return nodes;
+}
+function getNote(datas, keys) {
+  const nodes = keys || [];
+  datas.forEach((obj) => {
+    if (obj.children) {
+      const md = setMd(obj);
+      nodes.push(md);
+      getNote(obj.children, nodes);
+    } else {
+      const md = setMd(obj);
+      nodes.push(md);
+    }
+  });
+  return nodes;
+}
+function setMd(obj) {
+  let filesString = "";
+  const blank = "  ".repeat(obj.level);
+  if (obj.isDir) {
+    filesString += `${blank}+ ${obj.name}
+`;
+  } else {
+    const index = obj.name.lastIndexOf(".");
+    const lastName = obj.name.substring(index);
+    if (includeArrs.includes(lastName) || index === -1) {
+      filesString += `${blank}  ${obj.name}            ${obj.note}
+`;
+    }
+  }
+  return filesString;
+}
+function getMd() {
+  console.log("%s", "*** run location: ", path.resolve("./"));
+  const nodes = getFileNodes();
+  const note = getNote(nodes);
+  const md = note.join("");
+  if (md.length > 0) {
+    console.log("%s", "*** Automatic generation completed ! ");
+  }
+  return md;
+}
+export {
+  getFileNodes,
+  getMd
+};
+//# sourceMappingURL=index.esm.js.map

package/lib/index.esm.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["import fs from 'fs'\nimport path from 'path'\n\n/**\n * @description: \u83B7\u53D6\u6587\u4EF6\u7684\u5934\u90E8\u6CE8\u91CA\n * @param {*} file\n * @return {*}\n */\nfunction getFile(file: fs.PathOrFileDescriptor) {\n  const str = fs.readFileSync(file, 'utf-8')\n  const sarr = str.split(/[\\n,]/g)\n  // console.log(file);\n  const f =\n    sarr[0].indexOf('eslint') === -1 &&\n    (sarr[0].indexOf('-->') > -1 || sarr[0].indexOf('*/') > -1 || sarr[0].indexOf('//') > -1)\n      ? sarr[0]\n      : ''\n  // console.log(f);\n  return f\n}\n// \u8FC7\u6EE4\u6587\u4EF6\u5939\nconst filterArr = ['img', 'styles', 'node_modules', 'LICENSE', '.git', '.github', 'dist', '.husky', '.vscode']\n// \u8FD9\u91CC\u53EA\u83B7\u53D6\u67D0\u540E\u7F00\u6587\u4EF6\u7684\u6CE8\u91CA,\u9700\u8981\u5176\u4ED6\u8FD9\u91CC\u52A0\u5165\nconst includeArrs = ['.js', '.vue', '.ts']\n\nexport type ItemType ={\n  name: string\n  isDir: boolean\n  level: number\n  note: string\n  children?: ItemType[]\n}\n\n/**\n * @description: \u751F\u6210\u6240\u6709\u6587\u4EF6\u7684node\u4FE1\u606F\n * @param {*} nodes\n * @param {*} dir\n * @param {*} level\n * @return {*}\n */\n export function getFileNodes(nodes: Array<ItemType> = [], dir = path.resolve('./'), level = 0): Array<ItemType> {\n  const files = fs\n    .readdirSync(dir)\n    .map((item) => {\n      const fullPath = path.join(dir, item)\n      const isDir = fs.lstatSync(fullPath).isDirectory()\n      return {\n        name: item,\n        isDir,\n        level,\n        note: ''\n      } as ItemType\n    })\n    // \u5BF9\u6587\u4EF6\u5939\u548C\u6587\u4EF6\u8FDB\u884C\u6392\u5E8F,\u8981\u4E0D\u7136\u751F\u6210\u7684\u548C\u7F16\u8F91\u5668\u6253\u5F00\u7684\u987A\u5E8F\u4E0D\u5BF9\u5E94\n    .sort((a, b) => {\n      if (!a.isDir && b.isDir) return 1\n      if (a.isDir && !b.isDir) return -1\n      if ((a.isDir && b.isDir) || (!a.isDir && !b.isDir)) return 0\n      return 0\n    })\n  for (let index = 0; index < files.length; index += 1) {\n    const item = files[index]\n    let note = '' // \u6587\u4EF6\u6CE8\u91CA\n    const arr = filterArr.findIndex((obj) => obj === item.name)\n    if (arr === -1) {\n      const fullPath = path.join(dir, item.name)\n      const isDir = fs.lstatSync(fullPath).isDirectory()\n      if (isDir) {\n        // \u9012\u5F52\n        getFileNodes((item.children = []), fullPath, level + 1)\n      } else {\n        const i = fullPath.lastIndexOf('.')\n        const lastName = fullPath.substring(i)\n        // \u8FD9\u91CC\u53EA\u83B7\u53D6js\u548Cvue,ts\u6587\u4EF6\u7684\u6CE8\u91CA\n        if (['.js', '.vue', '.ts'].includes(lastName)) {\n          note = getFile(fullPath)\n        }\n        item.note = note\n      }\n      nodes.push(item)\n    }\n  }\n  // \u63A7\u5236\u8FD4\u56DE\u65F6\u95F4\u8282\u70B9,\u4E0D\u8BA9\u63D0\u524D\u8FD4\u56DE\n  return nodes\n}\n\n/**\n * @description: \u9012\u5F52\u5F97\u5230\u6587\u4EF6\u540D+note\n * @param {*} datas\n * @param {*} keys\n * @return {*}\n */\nfunction getNote(datas: Array<ItemType>, keys?: string[]) {\n  const nodes = keys || []\n  datas.forEach((obj: ItemType) => {\n    if (obj.children) {\n      // \u6587\u4EF6\u5939\n      const md = setMd(obj)\n      nodes.push(md)\n      getNote(obj.children, nodes)\n    }\n    // \u6587\u4EF6\n    else {\n      const md = setMd(obj)\n      nodes.push(md)\n    }\n  })\n  return nodes\n}\n\n/**\n * @description: \u4E00\u4E2Aobj\u751F\u6210\u4E00\u4E2A\u4E00\u884C\u6587\u5B57\n * @param {*} obj\n * @return {*}\n */\nfunction setMd(obj: ItemType): string {\n  let filesString = ''\n  // \u628A\u6587\u4EF6\u5939\u8F93\u51FA,\u5E76\u4E14level+1\n  const blank = '  '.repeat(obj.level) // \u91CD\u590D\u7A7A\u767D\n  if (obj.isDir) {\n    filesString += `${blank}+ ${obj.name}\\n`\n  } else {\n    const index = obj.name.lastIndexOf('.')\n    const lastName = obj.name.substring(index)\n    // \u8FD9\u91CC\u53EA\u83B7\u53D6\u67D0\u540E\u7F00\u6587\u4EF6\u7684\u6CE8\u91CA\n    if (includeArrs.includes(lastName) || index === -1) {\n      filesString += `${blank}  ${obj.name}            ${obj.note}\\n`\n    }\n  }\n  return filesString\n}\n\nexport function getMd() {\n  console.log('\\x1B[36m%s\\x1B[0m', '*** run location: ', path.resolve('./'))\n  const nodes = getFileNodes()\n  const note = getNote(nodes) // \u5F97\u5230\u6240\u6709note\u7684\u6570\u7EC4\n  const md = note.join('') // \u6570\u7EC4\u8F6C\u5B57\u7B26\u4E32\n  if (md.length > 0) {\n    console.log('\\x1B[36m%s\\x1B[0m', '*** Automatic generation completed ! ')\n  }\n  return md\n}\n\n"],
+  "mappings": ";;;;;;AAAA;AACA;AAOA,iBAAiB,MAA+B;AAC9C,QAAM,MAAM,GAAG,aAAa,MAAM;AAClC,QAAM,OAAO,IAAI,MAAM;AAEvB,QAAM,IACJ,KAAK,GAAG,QAAQ,cAAc,MAC7B,MAAK,GAAG,QAAQ,SAAS,MAAM,KAAK,GAAG,QAAQ,QAAQ,MAAM,KAAK,GAAG,QAAQ,QAAQ,MAClF,KAAK,KACL;AAEN,SAAO;AAAA;AAGT,IAAM,YAAY,CAAC,OAAO,UAAU,gBAAgB,WAAW,QAAQ,WAAW,QAAQ,UAAU;AAEpG,IAAM,cAAc,CAAC,OAAO,QAAQ;AAiB5B,sBAAsB,QAAyB,IAAI,MAAM,KAAK,QAAQ,OAAO,QAAQ,GAAoB;AAC/G,QAAM,QAAQ,GACX,YAAY,KACZ,IAAI,CAAC,SAAS;AACb,UAAM,WAAW,KAAK,KAAK,KAAK;AAChC,UAAM,QAAQ,GAAG,UAAU,UAAU;AACrC,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MACA;AAAA,MACA,MAAM;AAAA;AAAA,KAIT,KAAK,CAAC,GAAG,MAAM;AACd,QAAI,CAAC,EAAE,SAAS,EAAE;AAAO,aAAO;AAChC,QAAI,EAAE,SAAS,CAAC,EAAE;AAAO,aAAO;AAChC,QAAK,EAAE,SAAS,EAAE,SAAW,CAAC,EAAE,SAAS,CAAC,EAAE;AAAQ,aAAO;AAC3D,WAAO;AAAA;AAEX,WAAS,QAAQ,GAAG,QAAQ,MAAM,QAAQ,SAAS,GAAG;AACpD,UAAM,OAAO,MAAM;AACnB,QAAI,OAAO;AACX,UAAM,MAAM,UAAU,UAAU,CAAC,QAAQ,QAAQ,KAAK;AACtD,QAAI,QAAQ,IAAI;AACd,YAAM,WAAW,KAAK,KAAK,KAAK,KAAK;AACrC,YAAM,QAAQ,GAAG,UAAU,UAAU;AACrC,UAAI,OAAO;AAET,qBAAc,KAAK,WAAW,IAAK,UAAU,QAAQ;AAAA,aAChD;AACL,cAAM,IAAI,SAAS,YAAY;AAC/B,cAAM,WAAW,SAAS,UAAU;AAEpC,YAAI,CAAC,OAAO,QAAQ,OAAO,SAAS,WAAW;AAC7C,iBAAO,QAAQ;AAAA;AAEjB,aAAK,OAAO;AAAA;AAEd,YAAM,KAAK;AAAA;AAAA;AAIf,SAAO;AAAA;AAST,iBAAiB,OAAwB,MAAiB;AACxD,QAAM,QAAQ,QAAQ;AACtB,QAAM,QAAQ,CAAC,QAAkB;AAC/B,QAAI,IAAI,UAAU;AAEhB,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK;AACX,cAAQ,IAAI,UAAU;AAAA,WAGnB;AACH,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK;AAAA;AAAA;AAGf,SAAO;AAAA;AAQT,eAAe,KAAuB;AACpC,MAAI,cAAc;AAElB,QAAM,QAAQ,KAAK,OAAO,IAAI;AAC9B,MAAI,IAAI,OAAO;AACb,mBAAe,GAAG,UAAU,IAAI;AAAA;AAAA,SAC3B;AACL,UAAM,QAAQ,IAAI,KAAK,YAAY;AACnC,UAAM,WAAW,IAAI,KAAK,UAAU;AAEpC,QAAI,YAAY,SAAS,aAAa,UAAU,IAAI;AAClD,qBAAe,GAAG,UAAU,IAAI,mBAAmB,IAAI;AAAA;AAAA;AAAA;AAG3D,SAAO;AAAA;AAGF,iBAAiB;AACtB,UAAQ,IAAI,eAAqB,sBAAsB,KAAK,QAAQ;AACpE,QAAM,QAAQ;AACd,QAAM,OAAO,QAAQ;AACrB,QAAM,KAAK,KAAK,KAAK;AACrB,MAAI,GAAG,SAAS,GAAG;AACjB,YAAQ,IAAI,eAAqB;AAAA;AAEnC,SAAO;AAAA;",
+  "names": []
+}

package/package.json

@@ -1,29 +1,58 @@
 {
   "name": "agmd",
-  "version": "0.0.8",
-  "description": "auto generate md for node",
-  "type": "module",
+  "version": "0.1.3",
+  "description": "auto generate markdown for node",
   "keywords": [
-    "fs",
+    "node",
     "auto",
     "generate",
-    "md"
+    "md",
+    "markdown"
   ],
-  "main": "module.js",
+  "main": "lib/index.cjs.js",
+  "module": "lib/index.esm.js",
+  "typings": "lib/index.d.ts",
   "bin": {
     "agmd": "./bin/agmd.js"
   },
-  "author": "kakajun <253495832@qq.com>",
+  "scripts": {
+    "lint": "eslint \"src/**/*.{ts}\" --max-warnings=0",
+    "build": "node builder.js",
+    "prepare": "husky install",
+    "lint-fix": "eslint --fix  --ext .js,.ts",
+    "test": "npm run build && node bin/agmd"
+  },
+  "author": "majun <253495832@qq.com>",
   "repository": {
     "type": "git",
     "url": "git@github.com:majun2232/auto-generate-md.git"
   },
+  "devDependencies": {
+    "@types/node": "^17.0.0",
+    "@typescript-eslint/eslint-plugin": "^4.31.0",
+    "@typescript-eslint/parser": "^4.31.0",
+    "agmd": "0.1.1",
+    "esbuild": "^0.14.5",
+    "esbuild-plugin-d.ts": "^1.1.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "fs-extra": "^10.0.0",
+    "husky": "^7.0.2",
+    "lint-staged": "^11.1.2",
+    "prettier": "^2.5.1",
+    "typescript": "^4.4.3"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js}": "prettier --write",
+    "*.{ts,tsx}": "eslint --fix"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/majun2232/auto-generate-md/issues"
   },
   "homepage": "https://github.com/majun2232/auto-generate-md",
   "files": [
-    "bin"
+    "bin",
+    "lib"
   ]
 }

package/module.js

@@ -1,145 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-/**
- * @description: 获取文件的头部注释
- * @param {*} file
- * @return {*}
- */
-function getFile(file) {
-  var str = fs.readFileSync(file, "utf-8");
-  let sarr = str.split(/[\n,]/g);
-  // console.log(file);
-  let f =
-    sarr[0].indexOf("eslint") == -1 &&
-    (sarr[0].indexOf("-->") > -1 ||
-      sarr[0].indexOf("*/") > -1 ||
-      sarr[0].indexOf("//") > -1)
-      ? sarr[0]
-      : "";
-  // console.log(f);
-  return f;
-}
-// 过滤文件夹
-const filterArr = [
-  "img",
-  "styles",
-  "node_modules",
-  ".git",
-  ".github",
-  "dist",
-  ".husky",
-  ".vscode",
-];
-// 这里只获取某后缀文件的注释,需要其他这里加入
-const includeArrs = [".js", ".vue", ".ts"];
-
-/**
- * @description: 生成所有文件的node信息
- * @param {*} nodes
- * @param {*} dir
- * @param {*} level
- * @return {*}
- */
-function getFileNodes(nodes = [], dir = path.resolve("./"), level = 0) {
-  let files = fs
-    .readdirSync(dir)
-    .map((item) => {
-      const fullPath = path.join(dir, item);
-      const isDir = fs.lstatSync(fullPath).isDirectory();
-      return {
-        name: item,
-        isDir: isDir,
-        level,
-      };
-    })
-    // 对文件夹和文件进行排序,要不然生成的和编辑器打开的顺序不对应
-    .sort((a, b) => {
-      if (!a.isDir && b.isDir) return 1;
-      if (a.isDir && !b.isDir) return -1;
-      if ((a.isDir && b.isDir) || (!a.isDir && !b.isDir)) return 0;
-    });
-  for (let index = 0; index < files.length; index++) {
-    const item = files[index];
-    let note = ""; // 文件注释
-    let arr = filterArr.findIndex((obj) => obj === item.name);
-    if (arr === -1) {
-      const fullPath = path.join(dir, item.name);
-      const isDir = fs.lstatSync(fullPath).isDirectory();
-      if (isDir) {
-        // 递归
-        getFileNodes((item.children = []), fullPath, level + 1);
-      } else {
-        const index = fullPath.lastIndexOf(".");
-        const lastName = fullPath.substring(index);
-        // 这里只获取js和vue,ts文件的注释
-        if ([".js", ".vue", ".ts"].includes(lastName)) {
-          note = getFile(fullPath);
-        }
-        item.note = note;
-      }
-      nodes.push(item);
-    }
-  }
-  // 控制返回时间节点,不让提前返回
-  return nodes;
-}
-
-/**
- * @description: 递归得到文件名+note
- * @param {*} datas
- * @param {*} keys
- * @return {*}
- */
-function getNote(datas, keys) {
-  let nodes = keys ? keys : [];
-  datas.forEach((obj) => {
-    if (obj.children) {
-      // 文件夹
-      let md = setMd(obj);
-      nodes.push(md);
-      getNote(obj.children, nodes);
-    }
-    // 文件
-    else {
-      let md = setMd(obj);
-      nodes.push(md);
-    }
-  });
-  return nodes;
-}
-
-/**
- * @description: 一个obj生成一个一行文字
- * @param {*} obj
- * @return {*}
- */
-function setMd(obj) {
-  let filesString = "";
-  // 把文件夹输出,并且level+1
-  const blank = "  ".repeat(obj.level); // 重复空白
-  if (obj.isDir) {
-    filesString += `${blank}+ ${obj.name}\n`;
-  } else {
-    var index = obj.name.lastIndexOf(".");
-    const lastName = obj.name.substring(index);
-    // 这里只获取某后缀文件的注释
-    if ( includeArrs.includes(lastName) || index === -1) {
-      filesString += `${blank}  ${obj.name}            ${obj.note}\n`;
-    }
-  }
-  return filesString;
-}
-
-function getMd() {
-  console.log("\x1B[36m%s\x1B[0m", "*** run location: ", path.resolve("./"));
-  const nodes = getFileNodes();
-  const note = getNote(nodes); // 得到所有note的数组
-  const md = note.join(""); // 数组转字符串
-  if (md.length > 0) {
-    console.log("\x1B[36m%s\x1B[0m", "*** Automatic generation completed ! ");
-  }
-  return md;
-}
-/* 导出获取md的getMd方法 */
-export { getMd, getFileNodes };