js-code-detector 0.0.8 → 0.0.10

package/README.md

@@ -1,31 +1,28 @@
 # js-code-detector
 
-[![NPM version](https://img.shields.io/npm/v/code-detector.svg?style=flat)](https://npmjs.com/package/code-detector)
-[![NPM downloads](http://img.shields.io/npm/dm/code-detector.svg?style=flat)](https://npmjs.com/package/code-detector)
+## 说明
+1.重复代码检测工具, 支持 React、Vue 项目
+2.git分支对比报告, 目前适用于 umi4.x 版本的项目
 
-## Install
 
-```bash
-$ yarn install
-```
+## 重复代码检测使用
 
-```bash
-$ npm run dev
-$ npm run build
-```
+1.项目安装 **js-code-detector**
+2.package.json 中添加 scripts 命令 ```sameCodeDetect```, 例如：```"same": "sameCodeDetect"```
+3.执行该命令可在当前项目目录下生成报告, ```npm run same```
 
-## 说明
+## git分支对比报告使用
 
-包用于检测项目当前分支 与 master分支的差异，并出具报告，展示代码改动的影响
-目前适用于 umi4.x 版本的项目
+1.项目安装 **js-code-detector**
+2.package.json 中添加 scripts 命令 ```detect```, 例如：```"detect": "detect"```
+3.执行该命令可在当前项目目录下生成报告, ```npm run detect```
 
-## 使用
+## 重复代码检测报告说明
+1.所有相似的代码片段为一组，每组有2个及以上的代码片段
+2.每组代码片段都有对应的文件路径，以及所在的行范围
 
-1.项目安装 **js-code-detector**
-2.package.json 中添加 scripts 命令 ```detect```
-3.执行该命令可在当前项目目录下生成报告
 
-## 报告说明
+## git分支对比报告说明
 - filePath 文件路径
 - type 改动类型 add remove modify
 - filesDependsOnMe 依赖当前文件的文件

package/dist/cjs/util/ast_util/Core.d.ts

@@ -1,5 +1,5 @@
-import { FileSegment, MapFilePathToDetail } from "./FileUtil";
-import AstFeatUtil, { AstFeatNode, MapHashKeyToAstNodeSet } from "./AstFeatUtil";
+import { FileSegment } from "./FileUtil";
+import { AstFeatNode } from "./AstFeatUtil";
 export default class Core {
     static createMarkdownFile(result: {
         list: {
@@ -40,31 +40,8 @@ export default class Core {
         countList: number[];
         depthList: number[];
     };
-    static getFileContentByLine(map: MapFilePathToDetail, filePath: string, start: number, end: number): {
-        location: string;
-        content: string;
-    };
-    static getListOfGroup(mapFilePathToDetail: MapFilePathToDetail, validFullNodeList: ReturnType<typeof Core.getListOfNodeGroup>['nodeGroupList']): {
-        list: {
-            astNode: AstFeatNode;
-            location: string;
-            content: string;
-        }[];
-        listOfNodeInfo: (typeof validFullNodeList)[number]["listOfNodeInfo"];
-        nodeCount: number;
-        depth: number;
-        hashKey: string;
-    }[];
-    static createMapHashKeyToAstNodeSet(fileList: FileSegment[]): readonly [MapHashKeyToAstNodeSet, Set<string>, string[]];
-    static getListOfNodeGroup(mapHashKeyToNodeSet: MapHashKeyToAstNodeSet): {
-        nodeGroupList: {
-            list: AstFeatNode[];
-            listOfNodeInfo: ReturnType<typeof AstFeatUtil.spreadSubNode>;
-            nodeCount: number;
-            depth: number;
-            hashKey: string;
-        }[];
-        countList: number[];
-        depthList: number[];
-    };
+    private static getFileContentByLine;
+    private static getListOfGroup;
+    private static createMapHashKeyToAstNodeSet;
+    private static getListOfNodeGroup;
 }

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

@@ -69,19 +69,21 @@ function codeBlockDetect(arg) {
   const filePathOfOld = (0, import_path.join)(process.cwd(), "..", "source", filePath);
   const { mapFileLineToNodeSet: mapFileLineToNodeSetOld } = (0, import_getAstKitByFilePath.default)(filePathOfOld, absPathPrefix);
   const programNode = mapUuidToNode.get("Program");
-  const lineNumberStartNew = Number(startLineOfNew);
-  const lineNumberEndNew = lineNumberStartNew + items.filter((item) => item.startsWith("+")).length - 1;
-  const lineNumberStartOld = Number(startLineOfOld);
-  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 });
-  iterateNodes(removeNodes, "remove", { blockReports, programNode });
-  const lastReport = blockReports.at(-1);
-  if (lastReport) {
-    lastReport.diff_txt = items;
-    lastReport.topAdded = addNodes;
-    lastReport.topRemoved = removeNodes;
+  if (programNode) {
+    const lineNumberStartNew = Number(startLineOfNew);
+    const lineNumberEndNew = lineNumberStartNew + items.filter((item) => item.startsWith("+")).length - 1;
+    const lineNumberStartOld = Number(startLineOfOld);
+    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 });
+    iterateNodes(removeNodes, "remove", { blockReports, programNode });
+    const lastReport = blockReports.at(-1);
+    if (lastReport) {
+      lastReport.diff_txt = items;
+      lastReport.topAdded = addNodes;
+      lastReport.topRemoved = removeNodes;
+    }
   }
   blockReports.push(createBlockReport("Never"));
 }

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

@@ -34,10 +34,10 @@ function reportItemToMd(report) {
   const { filePath, filesDependsOnMe, type, dangerIdentifiers, blockReports } = report;
   return [
     `## ${filePath}`,
-    `- 类型: ${mapReportType[type]}`,
-    filesDependsOnMe.length > 0 ? `- 依赖${filePath}的文件` : "",
-    ...filesDependsOnMe.map((file, i) => `${i + 1}. ${file}`),
-    dangerIdentifiers.length > 0 ? `- 重点检查使用的变量` : "",
+    `### 类型: ${mapReportType[type]}`,
+    filesDependsOnMe.length > 0 ? `### 依赖${filePath}的文件` : "",
+    ...filesDependsOnMe.map((file) => `- ${file}`),
+    dangerIdentifiers.length > 0 ? `### 重点检查使用的变量` : "",
     dangerIdentifiers.length > 0 ? `> ${dangerIdentifiers.join(", ")}` : "",
     blockReports.length > 0 ? `### 代码块分析` : "",
     ...blockReports.map(blockReportToMd)

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

@@ -37,6 +37,9 @@ var import_AstUtil = __toESM(require("../ast_util/AstUtil"));
 function fileIdentifierDetect(filePath, absPathPrefix) {
   const { mapUuidToNode } = (0, import_getAstKitByFilePath.default)(filePath, absPathPrefix);
   const programNode = mapUuidToNode.get("Program");
+  if (!programNode) {
+    return [];
+  }
   const { dependenceIds } = programNode._util;
   const ids = [...dependenceIds].filter((id) => {
     return import_AstUtil.default.isUntrackedId(id) || id._util.crossScope.size > 0;

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

@@ -31,7 +31,7 @@ export declare function createDetectReport(arg: Arg): {
         kind: "Import" | "Declaration" | "Assignment" | "SelfUpdate" | "Invoke" | "Other" | "Never";
     }[];
     filePath: string;
-    type: "add" | "delete" | "modify";
+    type: "add" | "modify" | "delete";
     filesDependsOnMe: string[];
     dangerIdentifiers: string[];
 }[];

package/package.json

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