js-code-detector 0.0.3 → 0.0.4

package/README.md

@@ -21,9 +21,9 @@ $ npm run build
 
 ## 使用
 
-项目安装 js-code-detector
-package.json 中添加 scripts 命令 ```npx detect```
-执行该命令可在当前项目目录下生成报告
+1.项目安装 **js-code-detector**
+2.package.json 中添加 scripts 命令 ```detect```
+3.执行该命令可在当前项目目录下生成报告
 
 ## 报告说明
 - filePath 文件路径

package/dist/cjs/index.js

@@ -43,7 +43,8 @@ var import_fs2 = require("fs");
 var import_report_util = require("./util/report_util");
 var import_utils = require("@umijs/utils");
 var import_dayjs = __toESM(require("dayjs"));
-var jsonName = "git_diff_report.json";
+var import_createMdByJson = require("./util/report_util/createMdByJson");
+var jsonName = "git_diff_report.md";
 async function umiPluginCallback(api) {
   const diff_txt = (0, import_fs.readFileSync)((0, import_path.join)(api.cwd, "git_diff.txt"), "utf-8");
   const gitDiffDetail = (0, import_format_git_diff_content.formatGitDiffContent)(diff_txt);
@@ -57,7 +58,8 @@ async function umiPluginCallback(api) {
   const usingFileNoPrefix = usingFiles.map((item) => item.filePath.replace(absPathPrefix, ""));
   const groupGitDiffLines = gitDiffDetail.filter((item) => usingFileNoPrefix.includes(item.filePath));
   const reports = (0, import_report_util.createDetectReport)({ groupGitDiffLines, tree, absPathPrefix });
-  (0, import_fs2.writeFileSync)((0, import_path.join)(api.cwd, jsonName), JSON.stringify(reports, null, 2), { encoding: "utf-8", flag: "w" });
+  const mdContent = (0, import_createMdByJson.createMdByJson)(reports);
+  (0, import_fs2.writeFileSync)((0, import_path.join)(api.cwd, jsonName), mdContent, { encoding: "utf-8", flag: "w" });
 }
 var shellFileContent = `#!/bin/sh
 time=$(date "+%Y%-m%d")

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

@@ -0,0 +1,2 @@
+import { createDetectReport } from "../report_util";
+export declare function createMdByJson(report: ReturnType<typeof createDetectReport>): string;

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

@@ -0,0 +1,74 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/util/report_util/createMdByJson.ts
+var createMdByJson_exports = {};
+__export(createMdByJson_exports, {
+  createMdByJson: () => createMdByJson
+});
+module.exports = __toCommonJS(createMdByJson_exports);
+var mapReportType = {
+  modify: "修改",
+  add: "新增",
+  delete: "删除"
+};
+function createMdByJson(report) {
+  return report.map(reportItemToMd).join("\n\n\n");
+}
+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 ? `- 重点检查使用的变量` : "",
+    dangerIdentifiers.length > 0 ? `> ${dangerIdentifiers.join(", ")}` : "",
+    blockReports.length > 0 ? `### 代码块分析` : "",
+    ...blockReports.map(blockReportToMd)
+  ].filter(Boolean).join("\n\n");
+}
+function blockReportToMd(block) {
+  const {
+    kind,
+    diff_txt,
+    added,
+    addedEffects,
+    removed,
+    removedEffects
+  } = block;
+  return [
+    `#### 修改分类: ${kind}`,
+    `- 原始diff内容`,
+    `\`\`\`txt
+${diff_txt.join("\n")}
+\`\`\``,
+    added.length > 0 ? `- 新增标识符` : "",
+    added.length > 0 ? `> ${added.join(", ")}` : "",
+    addedEffects.length > 0 ? `- 新增标识符影响` : "",
+    addedEffects.map(({ causeBy, effects }) => `> ${causeBy}相关: ${effects.join()}`).join("\n\n"),
+    removed.length > 0 ? `- 删除标识符` : "",
+    removed.length > 0 ? `> ${removed.join(", ")}` : "",
+    removedEffects.length > 0 ? `- 删除标识符影响` : "",
+    removedEffects.map(({ causeBy, effects }) => `> ${causeBy}相关: ${effects.join()}`).join("\n\n")
+  ].filter(Boolean).join("\n\n");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createMdByJson
+});

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

@@ -1,4 +1,12 @@
 import { GitDiffDetail } from "./format_git_diff_content";
+import { BlockReport } from "./report_util/code_block_detect";
+export type DetectReport = {
+    filePath: string;
+    type: "modify" | "add" | "delete";
+    filesDependsOnMe: string[];
+    dangerIdentifiers: string[];
+    blockReports: BlockReport[];
+};
 type Arg = {
     groupGitDiffLines: GitDiffDetail[];
     tree: Record<string, string[]>;
@@ -23,7 +31,7 @@ export declare function createDetectReport(arg: Arg): {
         kind: "Import" | "Declaration" | "Assignment" | "SelfUpdate" | "Invoke" | "Other" | "Never";
     }[];
     filePath: string;
-    type: "add" | "delete" | "modify";
+    type: "modify" | "add" | "delete";
     filesDependsOnMe: string[];
     dangerIdentifiers: string[];
 }[];

package/package.json

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