agmd 0.0.7 → 0.0.8

package/README.EN.md

@@ -0,0 +1,79 @@
+# agmd(auto generate md)
+
+
+
+>Enter 'AGMD' in any folder where documents need to be generated, and the directory MD description can be automatically generated
+
+
+
+[![]( https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667 )]( https://camo.githubusercontent.com/28479a7a834310a667f36760a27283f7389e864a/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f76322d646174657069636b65722e737667 )
+
+
+
+English| [中文](https://github.com/majun2232/vue3sketchRuler/blob/master/README.md)  
+
+
+
+### Case
+
+
+
+! [image]( https://github.com/majun2232/auto-generate-md/blob/master/md.png )
+
+
+
+### Method of use
+
+
+
+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)
+
+
+
+> 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.
+
+
+
+Example is some of the files I prepared for the demonstration, which is of no other use
+
+
+
+### Creative background
+
+
+
+1. Have you been asked to write a MD description of the directory file?
+
+2. Or if the project directory and files have been relocated and reconstructed, 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 instead of 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. Current support record js . vue . Ts and folders, of course, also support others. I've written so much about this version. You can mention PR if you need it later
+
+
+
+
+
+### Related articles
+
+[Nuggets - auto generate directory MD file](https://juejin.cn/post/7030030599268073508)  

package/README.md

@@ -1,105 +1,46 @@
-# 自动生成目录md目录说明文件
-
-## 说明
-
-### example，是我为演示准备的一些文件，并没有其他用
-
-![image](https://github.com/majun2232/auto-generate-md/blob/master/md.png)
-
-## 使用方法
-全局安装
-> npm i agmd -g
-
-安装完成后, 在需要记录md的文件夹下面输入`agmd`, 会自动生成相对路径下的文件夹和文件的名字，如果文件里面还有在头部写注释的话，那么会一并带过来自动生成md文件。对于工程比较大的开发来说，这个脚本或许会帮你省下些许时间。
-
-## 功能
-1. 自动生成匹配目录的文件夹名和文件(已经按名称进行排序)
-2. 自动进行层级目录判断进行缩进
-3. 如果文件顶部有注释, 那么会自动进行判断
-4. 支持在任意文件目录下递归查找下级文件(不要在很大目录下执行啊!!!递归直到该级目录下没有文件为止)
-5. 目前支持记录 .js .vue .ts 和文件夹, 当然也支持其他, 这个版本我就写这么多, 后续有需要的可以提pr
-
-## 背景
-1. 大家有没有被要求写一个目录文件的md说明呢？
-2. 或者工程目录和文件被移动位置重构了，这时还需要重新修改md文件里面的目录说明
-3. 接手老工程，看了md说明，能对文件夹里面的文件功能做到一目了然，而不是点开对应文件去看
-
-基于以上三点痛点，这边就开撸代码，分享出来，解决和我有相同需求的人。
-
-首先要得到所有文件夹和文件名，并且是children格式，那么必然会有个递归，从文件夹里面一直找到文件，
-下面先来个简单的，让大家一看就懂，这里主要是循环递归目录，把一个文件或文件夹当做一个obj，放到nodes里面，然后创建了一个level字段，记录文件的层级深度，为后面的排版按层级设置提供必要信息
-
-```js
-function getFileNodes(nodes = [], dir = './', 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
-      }
-    })
-  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 {
-
-      }
-      nodes.push(item)
-    }
-  }
-  // 控制返回时间节点,不让提前返回
-  return nodes
-}
-```
-调用上面的方法，就能够得到一个生成的children的对象，把它打印生成到js文件中，这样子方便后续调试`wirteJs(JSON.stringify(nodes), './readme-file.js')`
-
-```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 => {})
-}
-```
-再用一个递归取出所有需要的信息，有人可能会要讲一个递归不能搞定么？ 还要搞两个？我之前也是搞的一个，是能生成出来，但是因为生成出来的文件，没有按我们需要的要求，比如文件排前面，按名称排序，所以生成出来的对应不到编辑器，那还是个摆设，下面的两个push就不能合成一个，合成一个就会出现文件夹和文件位置摆放错误，虽然文字还是相同的文字，位置很重要
-
-```js
-/**
- * @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
-}
+# agmd(auto generate 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)
+
+### 案例
+
+![image](https://github.com/majun2232/auto-generate-md/blob/master/md.png)
+
+### 使用方法
+需要有node环境  
+1. 全局安装(必须全局安装，否则会报`无法将“agmd”项识别为 cmdlet、函数、脚本文件或可运行程序的名称`)
+
+> npm i agmd -g
+
+安装完成后，在需要记录 md 的文件夹下面输入`agmd`，会自动生成相对路径下的文件夹和文件的名字，如果文件里面还有在头部写注释的话，那么会一并带过来自动生成 md 文件。生成的文件名为`readme-md.md`， 路径为刚刚输入命名的路径同级别下，对于工程比较大的开发来说，这个脚本或许会帮你省下些许时间。
+
+example，是我为演示准备的一些文件，并没有其他用
+
+2. 高级用法
+   有些需要把自动生成的文档插入到某个自动生成的 md 当中, 该插件导出了自动生成的 md 数据方法, 还有`getFileNodes`获得所有文件的具体信息, 可以 DIY 做出不同的文档
+   > import {getFileNodes, getMd} from agmd  
+   > 其中 getFileNodes 可以获得具体文件相关的信息  
+   > getMd 得到最终输出的信息
+
+### 创作背景
+
+1. 大家有没有被要求写一个目录文件的 md 说明呢？
+2. 或者工程目录和文件被移动位置重构了，这时还需要重新修改 md 文件里面的目录说明
+3. 接手老工程，看了 md 说明，能对文件夹里面的文件功能做到一目了然，而不是点开对应文件去看
+4. 分析源码工程需要做点笔记
+
+### 功能
+
+1. 自动生成匹配目录的文件夹名和文件(已经按名称进行排序)
+2. 自动进行层级目录判断进行缩进
+3. 如果文件顶部有注释， 那么会自动进行判断
+4. 支持在任意文件目录下递归查找下级文件(不要在很大目录下执行啊!!!递归直到该级目录下没有文件为止)
+5. 目前支持记录 .js .vue .ts 和文件夹， 当然也支持其他， 这个版本我就写这么多， 后续有需要的可以提 pr
+
+### 相关文章
+
+[掘金-自动生成目录 md 文件](https://juejin.cn/post/7030030599268073508)

package/bin/agmd.js

@@ -1,171 +1,49 @@
-#!/usr/bin/env node
-// 获取文件的头部注释工具
-const fs = require("fs");
-const path = require("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",
-];
-
-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);
-    // 这里只获取js和vue文件的注释,需要其他这里加入
-    if ([".js", ".vue", ".ts"].includes(lastName) || index === -1) {
-      filesString += `${blank}  ${obj.name}            ${obj.note}\n`;
-    }
-  }
-  return filesString;
-}
-
-/**
- * @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) => {});
-}
-
-/**
- * @description: 把结果写入到js文件
- * @param {data}  要写的数据
- * @return {fileName}  要写入文件地址
- */
-function wirteMd(data, filePath) {
-  let file = path.resolve(__dirname, filePath);
-  const pre = "```js\n";
-  const last = "```\n";
-  // 异步写入数据到文件
-  fs.writeFile(file, pre + data + last, { encoding: "utf8" }, (err) => {});
-}
-
-/**
- * @description: 自动生成全流程
- * @param {*}
- * @return {*}
- */
-function agmd() {
-  console.log(path.resolve("./"), "执行位置");
-  const nodes = getFileNodes();
-  // console.log(__dirname + "\\readme-file.js", "nodes");
-  const note = getNote(nodes); // 得到所有note的数组
-  const md = note.join(""); // 数组转字符串
-  if (md.length > 0) {
-    console.log("Automatic generation completed ! ");
-  }
-  // 得到md对象
-  // wirteJs(JSON.stringify(nodes), __dirname + "\\readme-file.js");
-  // 得到md文档
-  console.log("生成位置", path.resolve("./") + "\\readme-md.md");
-  wirteMd(md, path.resolve("./") + "\\readme-md.md");
-}
-agmd();
+#!/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) => {});
+}
+
+/**
+ * @description: 把结果写入到js文件
+ * @param {data}  要写的数据
+ * @return {fileName}  要写入文件地址
+ */
+function wirteMd(data, filePath) {
+  let file = path.resolve(__dirname, filePath);
+  const pre = "```js\n";
+  const last = "```\n";
+  // 异步写入数据到文件
+  fs.writeFile(file, pre + data + last, { encoding: "utf8" }, (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");
+}
+agmd();

package/module.js

@@ -0,0 +1,145 @@
+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 };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "agmd",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "auto generate md for node",
+  "type": "module",
   "keywords": [
     "fs",
     "auto",