js-code-detector 0.0.13 → 0.0.15

package/dist/cjs/util/report_util/code_block_detect.d.ts

@@ -1,14 +1,12 @@
 import { AstNode } from "../ast_util/AstUtil";
 import { GitDiffDetail } from "../format_git_diff_content";
-type BlockReportKind = "Import" | "Declaration" | "Assignment" | "SelfUpdate" | "Invoke" | "Other" | "Never";
+type BlockReportKind = "Import" | "Declaration" | "Assignment" | "SelfUpdate" | "Invoke" | "Other";
 type EffectItem = {
     causeBy: AstNode;
     effects: AstNode[];
 };
-export type BlockReport = {
-    index: number;
+type BlockReportInfoItem = {
     kind: BlockReportKind;
-    diff_txt: string[];
     topAdded: AstNode[];
     topRemoved: AstNode[];
     added: string[];
@@ -19,6 +17,11 @@ export type BlockReport = {
     removedStillUsing: string[];
     removedEffects: EffectItem[];
 };
+export type BlockReport = {
+    index: number;
+    diff_txt: string[];
+    infos: BlockReportInfoItem[];
+};
 type Arg = {
     gitDiffItem: GitDiffDetail;
     absPathPrefix: string;

package/dist/cjs/util/report_util/code_block_detect.js

@@ -37,8 +37,11 @@ var import_getAstKitByFilePath = __toESM(require("../ast_util/getAstKitByFilePat
 var import_AstUtil = __toESM(require("../ast_util/AstUtil"));
 var createBlockReport = (kind, index) => ({
   index,
-  kind,
   diff_txt: [],
+  infos: []
+});
+var createBlockReportInfoItem = (kind) => ({
+  kind,
   topAdded: [],
   topRemoved: [],
   added: [],
@@ -49,9 +52,17 @@ var createBlockReport = (kind, index) => ({
   removedStillUsing: [],
   removedEffects: []
 });
-var findOrCreateBlockReport = (blockReports, kind, index) => {
-  const res = blockReports.find((item) => item.index === index && item.kind === kind);
-  return res || createBlockReport(kind, index);
+var findOrCreateBlockReport = (blockReports, kind, index, diff_txt) => {
+  const res = blockReports.find((item) => item.index === index) || createBlockReport(kind, index);
+  res.diff_txt = diff_txt;
+  if (!blockReports.includes(res)) {
+    blockReports.push(res);
+  }
+  const tmpInfo = res.infos.find((info) => info.kind === kind) || createBlockReportInfoItem(kind);
+  if (!res.infos.includes(tmpInfo)) {
+    res.infos.push(tmpInfo);
+  }
+  return tmpInfo;
 };
 function codeBlockDetect(arg) {
   const { gitDiffItem, absPathPrefix, blockReports, index } = arg;
@@ -67,16 +78,9 @@ function codeBlockDetect(arg) {
     const lineNumberEndOld = lineNumberStartOld + items.filter((item) => item.startsWith("-")).length - 1;
     const addNodes = import_AstUtil.default.getTopScopeNodesByLineNumberRange(mapFileLineToNodeSet, lineNumberStartNew, lineNumberEndNew);
     const removeNodes = import_AstUtil.default.getTopScopeNodesByLineNumberRange(mapFileLineToNodeSetOld, lineNumberStartOld, lineNumberEndOld);
-    iterateNodes(addNodes, "add", { blockReports, programNode }, index);
-    iterateNodes(removeNodes, "remove", { blockReports, programNode }, index);
-    const lastReport = blockReports.at(-1);
-    if (lastReport) {
-      lastReport.diff_txt = items;
-      lastReport.topAdded = addNodes;
-      lastReport.topRemoved = removeNodes;
-    }
+    iterateNodes(addNodes, "add", { blockReports, programNode, diff_txt: items }, index);
+    iterateNodes(removeNodes, "remove", { blockReports, programNode, diff_txt: items }, index);
   }
-  blockReports.push(createBlockReport("Never", NaN));
 }
 function getPathsOfNode(topScopeNodes) {
   const paths = [];
@@ -99,32 +103,29 @@ function filterBySamePathAndLen(list, sameEffectsPaths) {
 function extractEffectItem(list) {
   return list.map((e) => ({ ...e, effects: e.effects.map((item) => item.ele) }));
 }
-function pushBlockReport(blockReports, blockReport, programNode, index) {
-  if (blockReport.kind.startsWith("Other:")) {
+function pushBlockReport(blockReportInfoItem, programNode, index) {
+  if (blockReportInfoItem.kind === "Other") {
     ["added", "removed"].forEach((key) => {
-      const tailElements = blockReport[key].map((ele) => ele.split(":").at(-1)).filter(Boolean);
-      blockReport[key] = [...new Set(tailElements)];
+      const tailElements = blockReportInfoItem[key].map((ele) => ele.split(":").at(-1)).filter(Boolean);
+      blockReportInfoItem[key] = [...new Set(tailElements)];
     });
   }
-  const sameNames = blockReport.added.filter((path) => blockReport.removed.includes(path));
+  const sameNames = blockReportInfoItem.added.filter((path) => blockReportInfoItem.removed.includes(path));
   if (sameNames.length) {
     ["added", "removed"].forEach((key) => {
-      blockReport[key] = blockReport[key].filter((path) => !sameNames.includes(path));
+      blockReportInfoItem[key] = blockReportInfoItem[key].filter((path) => !sameNames.includes(path));
     });
   }
-  const addedEffectsList = mapNodePath(blockReport.addedEffects);
-  const removedEffectsList = mapNodePath(blockReport.removedEffects);
+  const addedEffectsList = mapNodePath(blockReportInfoItem.addedEffects);
+  const removedEffectsList = mapNodePath(blockReportInfoItem.removedEffects);
   const addedEffectsPaths = addedEffectsList.map((item) => item.effects.map(({ path }) => path)).flat();
   const removedEffectsPaths = removedEffectsList.map((item) => item.effects.map(({ path }) => path)).flat();
   const sameEffectsPaths = addedEffectsPaths.filter((path) => removedEffectsPaths.includes(path));
   if (sameEffectsPaths.length) {
     const addedEffects = filterBySamePathAndLen(addedEffectsList, sameEffectsPaths);
     const removedEffects = filterBySamePathAndLen(removedEffectsList, sameEffectsPaths);
-    blockReport.addedEffects = extractEffectItem(addedEffects);
-    blockReport.removedEffects = extractEffectItem(removedEffects);
-  }
-  if (!blockReports.includes(blockReport)) {
-    blockReports.push(blockReport);
+    blockReportInfoItem.addedEffects = extractEffectItem(addedEffects);
+    blockReportInfoItem.removedEffects = extractEffectItem(removedEffects);
   }
 }
 function iterateNodes(topScopeNodes, operation, extra, index) {
@@ -150,17 +151,16 @@ function iterateNodes(topScopeNodes, operation, extra, index) {
   }
 }
 function detectOther(arg, index) {
-  const { topScopeNode, operation, extra: { blockReports, programNode } } = arg;
-  const blockReport = findOrCreateBlockReport(blockReports, "Other", index);
-  const { added, removed } = blockReport;
+  const { topScopeNode, operation, extra: { blockReports, programNode, diff_txt } } = arg;
+  const blockReportInfoItem = findOrCreateBlockReport(blockReports, "Other", index, diff_txt);
+  const { added, removed } = blockReportInfoItem;
   const nodePaths = getPathsOfNode(topScopeNode._util.nodeCollection);
   (operation === "add" ? added : removed).push(...nodePaths);
-  blockReport.kind = "Other:" + topScopeNode.type;
-  pushBlockReport(blockReports, blockReport, programNode, index);
+  pushBlockReport(blockReportInfoItem, programNode, index);
 }
 function detectImport(arg, index) {
-  const { topScopeNode, operation, extra: { blockReports, programNode } } = arg;
-  const blockReport = findOrCreateBlockReport(blockReports, "Import", index);
+  const { topScopeNode, operation, extra: { blockReports, programNode, diff_txt } } = arg;
+  const blockReport = findOrCreateBlockReport(blockReports, "Import", index, diff_txt);
   const { added, removed, addedEffects, removedEffects } = blockReport;
   const specifiers = topScopeNode.type === "ImportDeclaration" ? topScopeNode.specifiers : [topScopeNode];
   if (Array.isArray(specifiers)) {
@@ -170,23 +170,23 @@ function detectImport(arg, index) {
       (operation === "add" ? addedEffects : removedEffects).push({ causeBy: local, effects: [...local._util.effectIds] });
     });
   }
-  pushBlockReport(blockReports, blockReport, programNode, index);
+  pushBlockReport(blockReport, programNode, index);
 }
 function detectFnClsDeclaration(arg, index) {
-  const { topScopeNode, operation, extra: { blockReports, programNode } } = arg;
-  const blockReport = findOrCreateBlockReport(blockReports, "Declaration", index);
+  const { topScopeNode, operation, extra: { blockReports, programNode, diff_txt } } = arg;
+  const blockReport = findOrCreateBlockReport(blockReports, "Declaration", index, diff_txt);
   const { added, removed, addedEffects, removedEffects } = blockReport;
   const { id } = topScopeNode;
   (operation === "add" ? added : removed).push(id.name);
   (operation === "add" ? addedEffects : removedEffects).push({ causeBy: id, effects: [...id._util.effectIds] });
-  pushBlockReport(blockReports, blockReport, programNode, index);
+  pushBlockReport(blockReport, programNode, index);
 }
 function insertPrefix(n, prefix, sep = ":") {
   return [prefix, n].join(sep);
 }
 function detectVariableDeclaration(arg, index) {
-  const { topScopeNode, operation, extra: { blockReports, programNode } } = arg;
-  const blockReport = findOrCreateBlockReport(blockReports, "Declaration", index);
+  const { topScopeNode, operation, extra: { blockReports, programNode, diff_txt } } = arg;
+  const blockReport = findOrCreateBlockReport(blockReports, "Declaration", index, diff_txt);
   const { added, removed, addedEffects, removedEffects } = blockReport;
   if (["VariableDeclaration", "VariableDeclarator"].includes(topScopeNode.type)) {
     let declarations = [];
@@ -223,11 +223,11 @@ function detectVariableDeclaration(arg, index) {
       }
     });
   }
-  pushBlockReport(blockReports, blockReport, programNode, index);
+  pushBlockReport(blockReport, programNode, index);
 }
 function detectUpdateEffectExp(arg, index) {
-  const { topScopeNode, operation, extra: { blockReports, programNode } } = arg;
-  const blockReport = findOrCreateBlockReport(blockReports, "SelfUpdate", index);
+  const { topScopeNode, operation, extra: { blockReports, programNode, diff_txt } } = arg;
+  const blockReport = findOrCreateBlockReport(blockReports, "SelfUpdate", index, diff_txt);
   const { added, removed, addedEffects, removedEffects } = blockReport;
   const { argument: args } = topScopeNode;
   const createdExpIdSet = /* @__PURE__ */ new Set();
@@ -236,11 +236,11 @@ function detectUpdateEffectExp(arg, index) {
     (operation === "add" ? added : removed).push(createdExpId.name);
     (operation === "add" ? addedEffects : removedEffects).push({ causeBy: createdExpId, effects: [...createdExpId._util.effectIds] });
   }
-  pushBlockReport(blockReports, blockReport, programNode, index);
+  pushBlockReport(blockReport, programNode, index);
 }
 function detectFnCallExp(arg, index) {
-  const { topScopeNode, operation, extra: { blockReports, programNode } } = arg;
-  const blockReport = findOrCreateBlockReport(blockReports, "Invoke", index);
+  const { topScopeNode, operation, extra: { blockReports, programNode, diff_txt } } = arg;
+  const blockReport = findOrCreateBlockReport(blockReports, "Invoke", index, diff_txt);
   const { added, removed, addedEffects, removedEffects } = blockReport;
   const { callee, arguments: args } = topScopeNode;
   const argsIds = args.map((arg2) => arg2._util.nodeCollection.filter((n) => n.type === "Identifier")).flat();
@@ -254,11 +254,11 @@ function detectFnCallExp(arg, index) {
     (operation === "add" ? added : removed).push(createdExpId.name);
     (operation === "add" ? addedEffects : removedEffects).push({ causeBy: createdExpId, effects: [...createdExpId._util.effectIds] });
   }
-  pushBlockReport(blockReports, blockReport, programNode, index);
+  pushBlockReport(blockReport, programNode, index);
 }
 function detectAssignmentEffectExp(arg, index) {
-  const { topScopeNode, operation, extra: { blockReports, programNode } } = arg;
-  const blockReport = findOrCreateBlockReport(blockReports, "Assignment", index);
+  const { topScopeNode, operation, extra: { blockReports, programNode, diff_txt } } = arg;
+  const blockReport = findOrCreateBlockReport(blockReports, "Assignment", index, diff_txt);
   const { added, removed, addedEffects, removedEffects } = blockReport;
   const { left, right } = topScopeNode;
   const idSetLeft = /* @__PURE__ */ new Set();
@@ -272,5 +272,5 @@ function detectAssignmentEffectExp(arg, index) {
   for (const createdExp of idSetRight) {
     (operation === "add" ? added : removed).push(insertPrefix(createdExp.name, "right"));
   }
-  pushBlockReport(blockReports, blockReport, programNode, index);
+  pushBlockReport(blockReport, programNode, index);
 }

package/dist/cjs/util/report_util/createMdByJson.js

@@ -49,12 +49,8 @@ ${filesDependsOnMe.map((files) => `- ${files.join("、")}`).join("\n")}` : "",
 }
 function blockReportToMd(block, index) {
   const {
-    kind,
     diff_txt,
-    added,
-    addedEffects,
-    removed,
-    removedEffects
+    infos
   } = block;
   return [
     `### 对比${index + 1}分析`,
@@ -62,7 +58,19 @@ function blockReportToMd(block, index) {
 \`\`\`txt
 ${diff_txt.join("\n")}
 \`\`\``,
-    `#### 修改分类: ${kind}`,
+    ...infos.map(blockReportInfoItemToMd)
+  ].filter(Boolean).join("\n\n");
+}
+function blockReportInfoItemToMd(info, index) {
+  const {
+    kind,
+    added,
+    addedEffects,
+    removed,
+    removedEffects
+  } = info;
+  return [
+    `#### 分类${index + 1}: ${kind}`,
     added.length > 0 ? `- 新增标识符
 > ${added.join(", ")}` : "",
     addedEffects.length > 0 ? `- 新增标识符影响

package/dist/cjs/util/report_util.d.ts

@@ -14,25 +14,26 @@ type Arg = {
 };
 export declare function createDetectReport(arg: Arg): {
     blockReports: {
-        addedEffects: {
-            causeBy: string;
-            effects: string[];
-        }[];
-        removedEffects: {
-            causeBy: string;
-            effects: (string | undefined)[];
-        }[];
-        index: number;
         diff_txt: string[];
-        added: string[];
-        addedNotUsed: string[];
-        addedNotFound: string[];
-        removed: string[];
-        removedStillUsing: string[];
-        kind: "Import" | "Declaration" | "Assignment" | "SelfUpdate" | "Invoke" | "Other" | "Never";
+        infos: {
+            addedEffects: {
+                causeBy: string;
+                effects: string[];
+            }[];
+            removedEffects: {
+                causeBy: string;
+                effects: (string | undefined)[];
+            }[];
+            kind: "Import" | "Declaration" | "Assignment" | "SelfUpdate" | "Invoke" | "Other";
+            added: string[];
+            addedNotUsed: string[];
+            addedNotFound: string[];
+            removed: string[];
+            removedStillUsing: string[];
+        }[];
     }[];
     filePath: string;
-    type: "add" | "modify" | "delete";
+    type: "modify" | "add" | "delete";
     filesDependsOnMe: string[][];
     dangerIdentifiers: string[];
 }[];

package/dist/cjs/util/report_util.js

@@ -65,32 +65,38 @@ function createDetectReport(arg) {
     const allNodes = new Map([...astKit.mapUuidToNode.values()].map((ele) => [import_AstUtil.default.getNodePath(ele), ele]));
     return {
       ...report,
-      blockReports: report.blockReports.filter((e) => e.kind !== "Never").map((blockReport) => {
-        const { kind, addedEffects, removedEffects, topAdded, topRemoved, ...rest } = blockReport;
-        const removedEffectsInfos = removedEffects.map((item) => {
-          const tmpList = item.effects.map((ele) => {
-            const nodePath = import_AstUtil.default.getNodePath(ele);
-            const item2 = allNodes.get(nodePath);
-            return item2 && import_AstUtil.default.createScopeContent(item2);
-          }).filter(Boolean);
-          const effects = [...new Set(tmpList)];
+      blockReports: report.blockReports.map((blockReport) => {
+        const { infos, diff_txt } = blockReport;
+        const infosList = infos.map((info) => {
+          const { addedEffects, removedEffects, topAdded, topRemoved, ...rest } = info;
+          const removedEffectsInfos = removedEffects.map((item) => {
+            const tmpList = item.effects.map((ele) => {
+              const nodePath = import_AstUtil.default.getNodePath(ele);
+              const item2 = allNodes.get(nodePath);
+              return item2 && import_AstUtil.default.createScopeContent(item2);
+            }).filter(Boolean);
+            const effects = [...new Set(tmpList)];
+            return {
+              causeBy: item.causeBy.name || item.causeBy.type,
+              effects
+            };
+          }).filter((item) => item.effects.length > 0);
+          const addedEffectsInfos = addedEffects.map((item) => {
+            const effects = [...new Set(item.effects.map(import_AstUtil.default.createScopeContent))];
+            return {
+              causeBy: item.causeBy.name || item.causeBy.type,
+              effects
+            };
+          }).filter((item) => item.effects.length > 0);
           return {
-            causeBy: item.causeBy.name || item.causeBy.type,
-            effects
+            ...rest,
+            addedEffects: addedEffectsInfos,
+            removedEffects: removedEffectsInfos
           };
-        }).filter((item) => item.effects.length > 0);
-        const addedEffectsInfos = addedEffects.map((item) => {
-          const effects = [...new Set(item.effects.map(import_AstUtil.default.createScopeContent))];
-          return {
-            causeBy: item.causeBy.name || item.causeBy.type,
-            effects
-          };
-        }).filter((item) => item.effects.length > 0);
+        });
         return {
-          kind,
-          ...rest,
-          addedEffects: addedEffectsInfos,
-          removedEffects: removedEffectsInfos
+          diff_txt,
+          infos: infosList
         };
       })
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-code-detector",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "",
   "main": "dist/cjs/index.js",
   "types": "dist/cjs/index.d.ts",