@anren-utils/mcp-audit 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/.editorconfig +13 -0
  2. package/dist/audit/auditUtils.d.ts +12 -0
  3. package/dist/audit/auditUtils.d.ts.map +1 -0
  4. package/dist/audit/auditUtils.js +22 -0
  5. package/dist/audit/auditUtils.js.map +1 -0
  6. package/dist/audit/currentAudit.d.ts +53 -0
  7. package/dist/audit/currentAudit.d.ts.map +1 -0
  8. package/dist/audit/currentAudit.js +54 -0
  9. package/dist/audit/currentAudit.js.map +1 -0
  10. package/dist/audit/getDepChain.d.ts +16 -0
  11. package/dist/audit/getDepChain.d.ts.map +1 -0
  12. package/dist/audit/getDepChain.js +60 -0
  13. package/dist/audit/getDepChain.js.map +1 -0
  14. package/dist/audit/index.d.ts +11 -0
  15. package/dist/audit/index.d.ts.map +1 -0
  16. package/dist/audit/index.js +64 -0
  17. package/dist/audit/index.js.map +1 -0
  18. package/dist/audit/normalizeAuditResult.d.ts +13 -0
  19. package/dist/audit/normalizeAuditResult.d.ts.map +1 -0
  20. package/dist/audit/normalizeAuditResult.js +81 -0
  21. package/dist/audit/normalizeAuditResult.js.map +1 -0
  22. package/dist/audit/remoteAudit.d.ts +3 -0
  23. package/dist/audit/remoteAudit.d.ts.map +1 -0
  24. package/dist/audit/remoteAudit.js +24 -0
  25. package/dist/audit/remoteAudit.js.map +1 -0
  26. package/dist/generateLock/index.d.ts +17 -0
  27. package/dist/generateLock/index.d.ts.map +1 -0
  28. package/dist/generateLock/index.js +141 -0
  29. package/dist/generateLock/index.js.map +1 -0
  30. package/dist/index.d.ts +7 -0
  31. package/dist/index.d.ts.map +1 -0
  32. package/dist/index.js +48 -0
  33. package/dist/index.js.map +1 -0
  34. package/dist/mcpServer.d.ts +2 -0
  35. package/dist/mcpServer.d.ts.map +1 -0
  36. package/dist/mcpServer.js +34 -0
  37. package/dist/mcpServer.js.map +1 -0
  38. package/dist/parseProject/detectPackageManager.d.ts +8 -0
  39. package/dist/parseProject/detectPackageManager.d.ts.map +1 -0
  40. package/dist/parseProject/detectPackageManager.js +22 -0
  41. package/dist/parseProject/detectPackageManager.js.map +1 -0
  42. package/dist/parseProject/index.d.ts +11 -0
  43. package/dist/parseProject/index.d.ts.map +1 -0
  44. package/dist/parseProject/index.js +20 -0
  45. package/dist/parseProject/index.js.map +1 -0
  46. package/dist/parseProject/parseLocalProject.d.ts +17 -0
  47. package/dist/parseProject/parseLocalProject.d.ts.map +1 -0
  48. package/dist/parseProject/parseLocalProject.js +28 -0
  49. package/dist/parseProject/parseLocalProject.js.map +1 -0
  50. package/dist/parseProject/parseLocalWorkspace.d.ts +2 -0
  51. package/dist/parseProject/parseLocalWorkspace.d.ts.map +1 -0
  52. package/dist/parseProject/parseLocalWorkspace.js +2 -0
  53. package/dist/parseProject/parseLocalWorkspace.js.map +1 -0
  54. package/dist/parseProject/parseRemoteProject.d.ts +41 -0
  55. package/dist/parseProject/parseRemoteProject.d.ts.map +1 -0
  56. package/dist/parseProject/parseRemoteProject.js +180 -0
  57. package/dist/parseProject/parseRemoteProject.js.map +1 -0
  58. package/dist/parseProject/parseRemoteWorkspace.d.ts +2 -0
  59. package/dist/parseProject/parseRemoteWorkspace.d.ts.map +1 -0
  60. package/dist/parseProject/parseRemoteWorkspace.js +2 -0
  61. package/dist/parseProject/parseRemoteWorkspace.js.map +1 -0
  62. package/dist/parseProject/parseWorkspace.d.ts +19 -0
  63. package/dist/parseProject/parseWorkspace.d.ts.map +1 -0
  64. package/dist/parseProject/parseWorkspace.js +140 -0
  65. package/dist/parseProject/parseWorkspace.js.map +1 -0
  66. package/dist/render/index.d.ts +9 -0
  67. package/dist/render/index.d.ts.map +1 -0
  68. package/dist/render/index.js +24 -0
  69. package/dist/render/index.js.map +1 -0
  70. package/dist/render/markdown.d.ts +12 -0
  71. package/dist/render/markdown.d.ts.map +1 -0
  72. package/dist/render/markdown.js +16 -0
  73. package/dist/render/markdown.js.map +1 -0
  74. package/dist/render/template/audit.ejs +30 -0
  75. package/dist/render/template/detail-item.ejs +32 -0
  76. package/dist/render/template/detail.ejs +7 -0
  77. package/dist/render/template/index.ejs +8 -0
  78. package/dist/types.d.ts +371 -0
  79. package/dist/types.d.ts.map +1 -0
  80. package/dist/types.js +2 -0
  81. package/dist/types.js.map +1 -0
  82. package/dist/utils/dirUtils.d.ts +11 -0
  83. package/dist/utils/dirUtils.d.ts.map +1 -0
  84. package/dist/utils/dirUtils.js +28 -0
  85. package/dist/utils/dirUtils.js.map +1 -0
  86. package/dist/utils/index.d.ts +34 -0
  87. package/dist/utils/index.d.ts.map +1 -0
  88. package/dist/utils/index.js +74 -0
  89. package/dist/utils/index.js.map +1 -0
  90. package/eslint.config.js +38 -0
  91. package/package.json +38 -0
  92. package/src/audit/auditUtils.ts +24 -0
  93. package/src/audit/currentAudit.ts +116 -0
  94. package/src/audit/getDepChain.ts +71 -0
  95. package/src/audit/index.ts +90 -0
  96. package/src/audit/normalizeAuditResult.ts +99 -0
  97. package/src/audit/remoteAudit.ts +26 -0
  98. package/src/generateLock/index.ts +203 -0
  99. package/src/index.ts +48 -0
  100. package/src/mcpServer.ts +43 -0
  101. package/src/parseProject/detectPackageManager.ts +24 -0
  102. package/src/parseProject/index.ts +20 -0
  103. package/src/parseProject/parseLocalProject.ts +39 -0
  104. package/src/parseProject/parseRemoteProject.ts +225 -0
  105. package/src/parseProject/parseWorkspace.ts +202 -0
  106. package/src/render/index.ts +30 -0
  107. package/src/render/markdown.ts +29 -0
  108. package/src/render/template/audit.ejs +30 -0
  109. package/src/render/template/detail-item.ejs +32 -0
  110. package/src/render/template/detail.ejs +7 -0
  111. package/src/render/template/index.ejs +8 -0
  112. package/src/types.ts +429 -0
  113. package/src/utils/dirUtils.ts +31 -0
  114. package/src/utils/index.ts +88 -0
  115. package/tsconfig.json +42 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parseRemoteProject.js","sourceRoot":"","sources":["../../src/parseProject/parseRemoteProject.ts"],"names":[],"mappings":"AAmBA;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QAEpC,OAAO;QACP,IAAI,QAAgB,CAAC;QACrB,IAAI,QAAQ,KAAK,YAAY,IAAI,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAClE,QAAQ,GAAG,QAAQ,CAAC;QACtB,CAAC;aAAM,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YACvE,QAAQ,GAAG,OAAO,CAAC;QACrB,CAAC;aAAM,IAAI,QAAQ,KAAK,YAAY,IAAI,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YACzE,QAAQ,GAAG,QAAQ,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,SAAS,CAAC;QACvB,CAAC;QAED,sBAAsB;QACtB,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE5D,oCAAoC;QACpC,sCAAsC;QACtC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACxB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACvB,+DAA+D;QAC/D,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,uCAAuC;QAExE,sCAAsC;QACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEjE,MAAM,cAAc,GAAyB;YAC3C,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,QAAQ;YACR,WAAW,EAAE,GAAG;SACjB,CAAC;QACF,OAAO,cAAc,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,uBAAuB,CACpC,cAAoC;IAEpC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC;IAC7C,IAAI,UAAkB,CAAC;IAEvB,qEAAqE;IACrE,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAClD,UAAU,GAAG,SAAS,CAAC,CAAC,CAAE,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,yBAAyB;QACzB,MAAM,GAAG,GAAG,gCAAgC,KAAK,IAAI,IAAI,EAAE,CAAC;QAC5D,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3C,IAAI,CAAC,IAAI,EAAE,CACZ,CAAmB,CAAC;QACrB,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;IACnC,CAAC;IACD,OAAO;QACL,UAAU;QACV,cAAc,EAAE,qCAAqC,KAAK,IAAI,IAAI,IAAI,UAAU,eAAe;KAChG,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,sBAAsB,CACnC,cAAoC;IAEpC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC;IAC7C,IAAI,UAAkB,CAAC;IAEvB,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAClD,UAAU,GAAG,SAAS,CAAC,CAAC,CAAE,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,yBAAyB;QACzB,MAAM,GAAG,GAAG,kCAAkC,KAAK,IAAI,IAAI,EAAE,CAAC;QAC9D,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3C,IAAI,CAAC,IAAI,EAAE,CACZ,CAAmB,CAAC;QACrB,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;IACnC,CAAC;IACD,OAAO;QACL,UAAU;QACV,cAAc,EAAE,qBAAqB,KAAK,IAAI,IAAI,QAAQ,UAAU,eAAe;KACpF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,uBAAuB,CACpC,cAAoC;IAEpC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC;IAC7C,IAAI,UAAkB,CAAC;IAEvB,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAClD,UAAU,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IACjC,CAAC;SAAM,CAAC;QACN,yBAAyB;QACzB,eAAe;QACf,MAAM,GAAG,GAAG,sCAAsC,KAAK,IAAI,IAAI,EAAE,CAAC;QAClE,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3C,IAAI,CAAC,IAAI,EAAE,CACZ,CAAmB,CAAC;QACrB,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;IACnC,CAAC;IACD,OAAO;QACL,UAAU;QACV,cAAc,EAAE,sBAAsB,KAAK,IAAI,IAAI,UAAU,UAAU,eAAe;KACvF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAgC;IACtE,+BAA+B;IAC/B,QAAQ,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC5B,KAAK,QAAQ;YACX,OAAO,MAAM,uBAAuB,CAAC,UAAU,CAAC,CAAC;QACnD,KAAK,OAAO;YACV,OAAO,MAAM,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAClD,KAAK,QAAQ;YACX,OAAO,MAAM,uBAAuB,CAAC,UAAU,CAAC,CAAC;QACnD;YACE,MAAM,IAAI,KAAK,CAAC,yBAAyB,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpE,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAc;IACrD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC5D,SAAS;IACT,OAAO,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAChD,IAAI,CAAC,IAAI,EAAE,CACZ,CAA6B,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,iCAAiC,CAC9C,cAAoC,EACpC,cAAwB;IAExB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC;IAC7C,IAAI,UAAkB,CAAC;IAEvB,qEAAqE;IACrE,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAClD,UAAU,GAAG,SAAS,CAAC,CAAC,CAAE,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,yBAAyB;QACzB,MAAM,GAAG,GAAG,gCAAgC,KAAK,IAAI,IAAI,EAAE,CAAC;QAC5D,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3C,IAAI,CAAC,IAAI,EAAE,CACZ,CAAmB,CAAC;QACrB,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;IACnC,CAAC;IACD,0FAA0F;IAC1F,OAAO,mFAAmF,CAAC;AAC7F,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=parseRemoteWorkspace.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parseRemoteWorkspace.d.ts","sourceRoot":"","sources":["../../src/parseProject/parseRemoteWorkspace.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=parseRemoteWorkspace.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parseRemoteWorkspace.js","sourceRoot":"","sources":["../../src/parseProject/parseRemoteWorkspace.ts"],"names":[],"mappings":""}
@@ -0,0 +1,19 @@
1
+ import type { PackageJsonInfo } from "../types.js";
2
+ import { type RemoteProjectUrlInfo } from "./parseRemoteProject.js";
3
+ interface ParseWorkspaceOptions {
4
+ /** 项目地址链接 */
5
+ projectRoot: string;
6
+ /** 项目根package.json文件内容 */
7
+ packageJsonRoot: PackageJsonInfo;
8
+ }
9
+ export interface RemoteWorkspaceInfo {
10
+ gitInfo?: RemoteProjectUrlInfo;
11
+ branchName?: string;
12
+ subPackageNames: string[];
13
+ }
14
+ /**
15
+ * 工具项目地址,判断是本地工程还是远程仓库
16
+ */
17
+ export declare function parseWorkspace(options: ParseWorkspaceOptions): Promise<RemoteWorkspaceInfo | null>;
18
+ export {};
19
+ //# sourceMappingURL=parseWorkspace.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parseWorkspace.d.ts","sourceRoot":"","sources":["../../src/parseProject/parseWorkspace.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,UAAU,qBAAqB;IAC7B,aAAa;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,eAAe,EAAE,eAAe,CAAC;CAClC;AAWD,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,uCAQ5D"}
@@ -0,0 +1,140 @@
1
+ import { readdirSync, promises } from "fs";
2
+ import { join } from "path";
3
+ import yaml from "js-yaml";
4
+ import { getPackageJsonUrl, parseGitUrl, } from "./parseRemoteProject.js";
5
+ /**
6
+ * 工具项目地址,判断是本地工程还是远程仓库
7
+ */
8
+ export function parseWorkspace(options) {
9
+ const { projectRoot } = options;
10
+ // 分辨是本地工程还是远程仓库
11
+ if (projectRoot.startsWith("http://") || projectRoot.startsWith("https://")) {
12
+ // 远程项目
13
+ return parseRemoteWorkspace(options);
14
+ }
15
+ return parseLocalWorkspace(options);
16
+ }
17
+ /**
18
+ * @Desc: 获取本地项目中Monorepo项目相关信息
19
+ * @param {string} projectRoot 本地项目地址
20
+ * @param {PackageJsonInfo} packageJsonRoot 项目根package.json文件内容
21
+ * @return {string[]} 项目中的子包位置信息,例如:[ 'packages/**', 'apps/**', 'features/**' ]
22
+ */
23
+ async function getMonorepoInfoByLocal(projectRoot, packageJsonRoot) {
24
+ // 判断指定目录下是否有文件名包含workspace.yaml的文件,例如:pnpm-workspace.yaml
25
+ const fileNames = await readdirSync(projectRoot);
26
+ const workspaceFileName = fileNames.find((fileName) => fileName.includes("workspace.yaml"));
27
+ if (workspaceFileName) {
28
+ const workspaceFile = join(projectRoot, workspaceFileName);
29
+ const fileContent = await promises.readFile(workspaceFile, "utf8");
30
+ const fileInfo = yaml.load(fileContent);
31
+ return {
32
+ workspaces: fileInfo.packages,
33
+ };
34
+ }
35
+ // 判断packageJson文件中是否有workspaces字段
36
+ if (packageJsonRoot.workspaces && packageJsonRoot.workspaces.length > 0) {
37
+ return {
38
+ workspaces: packageJsonRoot.workspaces,
39
+ };
40
+ }
41
+ return null;
42
+ }
43
+ /**
44
+ * @Desc: 获取本地项目中workspace相关信息
45
+ * @param {options} options 包含projectRoot和packageJsonRoot 项目根package.json文件内容
46
+ * @param {string[]} options.projectRoot 本地项目地址
47
+ * @param {string} options.packageJsonRoot package.json文件内容
48
+ */
49
+ async function parseLocalWorkspace(options) {
50
+ const { projectRoot, packageJsonRoot } = options;
51
+ const monorepoInfo = await getMonorepoInfoByLocal(projectRoot, packageJsonRoot);
52
+ if (!monorepoInfo) {
53
+ // 本地项目不是monorepo工程
54
+ return null;
55
+ }
56
+ const { workspaces } = monorepoInfo;
57
+ // 获取子包所在位置
58
+ const workspaceNames = workspaces.map((workspace) => workspace.split("/")[0]);
59
+ const subPackageNames = await Promise.all(workspaceNames.map(async (workspaceName) => {
60
+ if (!workspaceName) {
61
+ return [];
62
+ }
63
+ const packageName = join(projectRoot, workspaceName);
64
+ // 获取所有子包项目
65
+ const subFileNames = await readdirSync(packageName);
66
+ return subFileNames.map((sub) => workspaceName + "/" + sub);
67
+ }));
68
+ return {
69
+ subPackageNames: subPackageNames.flat(),
70
+ };
71
+ }
72
+ /**
73
+ * @Desc: 获取远程项目中Monorepo项目相关信息
74
+ * @param {string} projectRoot 远程项目地址
75
+ * @param {PackageJsonInfo} packageJsonRoot 项目根package.json文件内容
76
+ * @return {string[]} 项目中的子包位置信息,例如:[ 'packages/**', 'apps/**', 'features/**' ]
77
+ */
78
+ async function getMonorepoInfoByRemote(projectRoot, packageJsonRoot) {
79
+ const gitInfo = parseGitUrl(projectRoot);
80
+ const { owner, repo } = gitInfo;
81
+ const { branchName } = await getPackageJsonUrl(gitInfo);
82
+ const projectInfoUrl = `https://api.github.com/repos/${owner}/${repo}/contents?ref=${branchName}`;
83
+ const contentInfoList = (await fetch(projectInfoUrl).then((resp) => resp.json()));
84
+ const workspaceFileInfo = contentInfoList.findLast((item) => item.name.includes("workspace.yaml"));
85
+ if (workspaceFileInfo) {
86
+ const fileContent = await fetch(workspaceFileInfo.download_url).then((resp) => resp.text());
87
+ const fileInfo = yaml.load(fileContent);
88
+ return {
89
+ gitInfo,
90
+ branchName,
91
+ workspaces: fileInfo.packages,
92
+ };
93
+ }
94
+ // 判断packageJson文件中是否有workspaces字段
95
+ if (packageJsonRoot.workspaces && packageJsonRoot.workspaces.length > 0) {
96
+ return {
97
+ gitInfo,
98
+ branchName,
99
+ workspaces: packageJsonRoot.workspaces,
100
+ };
101
+ }
102
+ return null;
103
+ }
104
+ /**
105
+ * @Desc: 获取远程项目中workspace相关信息
106
+ * @param {options} options 包含gitInfo和packageJsonRoot 项目根package.json文件内容
107
+ * @param {string[]} options.projectRoot 远程项目地址
108
+ * @param {string} options.packageJsonRoot package.json文件内容
109
+ */
110
+ async function parseRemoteWorkspace(options) {
111
+ const { projectRoot, packageJsonRoot } = options;
112
+ const monorepoInfo = await getMonorepoInfoByRemote(projectRoot, packageJsonRoot);
113
+ if (!monorepoInfo) {
114
+ // 远程项目不是monorepo工程
115
+ return null;
116
+ }
117
+ const { gitInfo, branchName, workspaces } = monorepoInfo;
118
+ const { owner, repo } = gitInfo;
119
+ // 获取子包所在位置
120
+ const workspaceNames = workspaces.map((workspace) => workspace.split("/")[0]);
121
+ const subPackageNames = await Promise.all(workspaceNames.map(async (workspaceName) => {
122
+ if (!workspaceName) {
123
+ return [];
124
+ }
125
+ const packageInfoUrl = `https://api.github.com/repos/${owner}/${repo}/contents/${workspaceName}?ref=${branchName}`;
126
+ // 获取所有子包项目
127
+ const subFileInfoList = (await fetch(packageInfoUrl)
128
+ .then((resp) => resp.json())
129
+ .catch((err) => {
130
+ return [];
131
+ }));
132
+ return subFileInfoList.map((sub) => workspaceName + "/" + sub.name);
133
+ }));
134
+ return {
135
+ gitInfo,
136
+ branchName,
137
+ subPackageNames: subPackageNames.flat(),
138
+ };
139
+ }
140
+ //# sourceMappingURL=parseWorkspace.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parseWorkspace.js","sourceRoot":"","sources":["../../src/parseProject/parseWorkspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,IAAI,MAAM,SAAS,CAAC;AAE3B,OAAO,EACL,iBAAiB,EACjB,WAAW,GAEZ,MAAM,yBAAyB,CAAC;AAwBjC;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,OAA8B;IAC3D,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAChC,gBAAgB;IAChB,IAAI,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5E,OAAO;QACP,OAAO,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,sBAAsB,CACnC,WAAmB,EACnB,eAAgC;IAEhC,0DAA0D;IAC1D,MAAM,SAAS,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,iBAAiB,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpD,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CACpC,CAAC;IACF,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;QAC3D,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAA2B,CAAC;QAClE,OAAO;YACL,UAAU,EAAE,QAAQ,CAAC,QAAQ;SAC9B,CAAC;IACJ,CAAC;IACD,kCAAkC;IAClC,IAAI,eAAe,CAAC,UAAU,IAAI,eAAe,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxE,OAAO;YACL,UAAU,EAAE,eAAe,CAAC,UAAsB;SACnD,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,mBAAmB,CAChC,OAA8B;IAE9B,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IACjD,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAC/C,WAAW,EACX,eAAe,CAChB,CAAC;IACF,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,mBAAmB;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC;IACpC,WAAW;IACX,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;QACzC,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACrD,WAAW;QACX,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC;IAC9D,CAAC,CAAC,CACH,CAAC;IACF,OAAO;QACL,eAAe,EAAE,eAAe,CAAC,IAAI,EAAE;KACxC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,uBAAuB,CACpC,WAAmB,EACnB,eAAgC;IAEhC,MAAM,OAAO,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IACzC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAChC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACxD,MAAM,cAAc,GAAG,gCAAgC,KAAK,IAAI,IAAI,iBAAiB,UAAU,EAAE,CAAC;IAClG,MAAM,eAAe,GAAG,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACjE,IAAI,CAAC,IAAI,EAAE,CACZ,CAAqB,CAAC;IACvB,MAAM,iBAAiB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAC1D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CACrC,CAAC;IAEF,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,IAAI,CAClE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CACtB,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAA2B,CAAC;QAClE,OAAO;YACL,OAAO;YACP,UAAU;YACV,UAAU,EAAE,QAAQ,CAAC,QAAQ;SAC9B,CAAC;IACJ,CAAC;IACD,kCAAkC;IAClC,IAAI,eAAe,CAAC,UAAU,IAAI,eAAe,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxE,OAAO;YACL,OAAO;YACP,UAAU;YACV,UAAU,EAAE,eAAe,CAAC,UAAU;SACvC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,oBAAoB,CACjC,OAA8B;IAE9B,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IACjD,MAAM,YAAY,GAAG,MAAM,uBAAuB,CAChD,WAAW,EACX,eAAe,CAChB,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,mBAAmB;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC;IACzD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAChC,WAAW;IACX,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;QACzC,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,cAAc,GAAG,gCAAgC,KAAK,IAAI,IAAI,aAAa,aAAa,QAAQ,UAAU,EAAE,CAAC;QACnH,WAAW;QACX,MAAM,eAAe,GAAG,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC;aACjD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aAC3B,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAqB,CAAC;QAE1B,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC,CACH,CAAC;IACF,OAAO;QACL,OAAO;QACP,UAAU;QACV,eAAe,EAAE,eAAe,CAAC,IAAI,EAAE;KACxC,CAAC;AACJ,CAAC"}
@@ -0,0 +1,9 @@
1
+ import type { NormalizedResult } from "../audit/normalizeAuditResult.js";
2
+ import type { PackageJsonInfo } from "../types.js";
3
+ /**
4
+ * 讲auditResult渲染为markdown格式的字符串
5
+ * @param {object} auditResult 规范化的审计结果
6
+ * @param {object} packageJson 包的package.json内容
7
+ */
8
+ export declare function render(auditResult: NormalizedResult, packageJson: PackageJsonInfo): Promise<string>;
9
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/render/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAanD;;;;GAIG;AACH,wBAAsB,MAAM,CAC1B,WAAW,EAAE,gBAAgB,EAC7B,WAAW,EAAE,eAAe,mBAQ7B"}
@@ -0,0 +1,24 @@
1
+ import { renderMarkdown } from "./markdown.js";
2
+ const desc = {
3
+ severityLevels: {
4
+ low: "低危",
5
+ moderate: "中危",
6
+ high: "高危",
7
+ critical: "严重",
8
+ info: "信息",
9
+ },
10
+ };
11
+ /**
12
+ * 讲auditResult渲染为markdown格式的字符串
13
+ * @param {object} auditResult 规范化的审计结果
14
+ * @param {object} packageJson 包的package.json内容
15
+ */
16
+ export async function render(auditResult, packageJson) {
17
+ const data = {
18
+ audit: auditResult,
19
+ desc,
20
+ packageJson,
21
+ };
22
+ return await renderMarkdown(data);
23
+ }
24
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/render/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAqB,MAAM,eAAe,CAAC;AAElE,MAAM,IAAI,GAAG;IACX,cAAc,EAAE;QACd,GAAG,EAAE,IAAI;QACT,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,IAAI;KACX;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,WAA6B,EAC7B,WAA4B;IAE5B,MAAM,IAAI,GAAiB;QACzB,KAAK,EAAE,WAAW;QAClB,IAAI;QACJ,WAAW;KACZ,CAAC;IACF,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { NormalizedResult } from "../audit/normalizeAuditResult.js";
2
+ import type { AuditSeverity, PackageJsonInfo } from "../types.js";
3
+ export interface MarkdownDesc {
4
+ severityLevels: Record<AuditSeverity, string>;
5
+ }
6
+ export interface MarkdownData {
7
+ audit: NormalizedResult;
8
+ desc: MarkdownDesc;
9
+ packageJson: PackageJsonInfo;
10
+ }
11
+ export declare function renderMarkdown(data: MarkdownData): Promise<string>;
12
+ //# sourceMappingURL=markdown.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/render/markdown.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAElE,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;CAC/C;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,EAAE,eAAe,CAAC;CAC9B;AAID,wBAAgB,cAAc,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAUlE"}
@@ -0,0 +1,16 @@
1
+ import ejs from "ejs";
2
+ import { join } from "path";
3
+ import { getDirname } from "../utils/index.js";
4
+ const templatePath = join(getDirname(import.meta.url), "./template/index.ejs");
5
+ export function renderMarkdown(data) {
6
+ return new Promise((resolve, reject) => {
7
+ ejs.renderFile(templatePath, data, (err, str) => {
8
+ if (err) {
9
+ reject(err);
10
+ return;
11
+ }
12
+ resolve(str);
13
+ });
14
+ });
15
+ }
16
+ //# sourceMappingURL=markdown.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../src/render/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAc/C,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,sBAAsB,CAAC,CAAC;AAE/E,MAAM,UAAU,cAAc,CAAC,IAAkB;IAC/C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,GAAG,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC9C,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,30 @@
1
+ 您所审计的工程总共有 **<%- audit.summary.total %>** 个风险漏洞。
2
+
3
+ 其中:
4
+
5
+ - **<%- desc.severityLevels.critical %>漏洞**:共计 **<%- audit.summary.critical %>** 个
6
+ - **<%- desc.severityLevels.high %>漏洞**:共计 **<%- audit.summary.high %>** 个
7
+ - **<%- desc.severityLevels.moderate %>漏洞**:共计 **<%- audit.summary.moderate %>** 个
8
+ - **<%- desc.severityLevels.low %>漏洞**:共计 **<%- audit.summary.low %>** 个
9
+
10
+ > 说明:
11
+ >
12
+ > - **<%- desc.severityLevels.critical %>**漏洞被认为是极其严重的,应该立即修复。
13
+ > - **<%- desc.severityLevels.high %>**漏洞被认为是严重的,应该尽快修复。
14
+ > - **<%- desc.severityLevels.moderate %>**漏洞被认为是中等严重的,可以选择在时间允许时修复。
15
+ > - **<%- desc.severityLevels.low %>**漏洞被认为是轻微的,可以根据自行需要进行修复。
16
+
17
+ 下面是漏洞的详细信息
18
+
19
+ <% if (audit.summary.critical) { %>
20
+ <%- include('./detail.ejs', {type:'critical'}); %>
21
+ <% } %>
22
+ <% if (audit.summary.high) { %>
23
+ <%- include('./detail.ejs', {type:'high'}); %>
24
+ <% } %>
25
+ <% if (audit.summary.moderate) { %>
26
+ <%- include('./detail.ejs', {type:'moderate'}); %>
27
+ <% } %>
28
+ <% if (audit.summary.low) { %>
29
+ <%- include('./detail.ejs', {type:'low'}); %>
30
+ <% } %>
@@ -0,0 +1,32 @@
1
+ ### `<%- item.name -%>`
2
+
3
+ **漏洞描述**:
4
+ <% item.problems.forEach((problem) => { %>
5
+ - <%- problem.title %>
6
+ - npm漏洞编号:`<%- problem.source %>`
7
+ - 漏洞详细说明:<%- problem.url %>
8
+ - 漏洞等级:<%- desc.severityLevels[problem.severity] %>
9
+ - 受影响的版本:`<%- problem.range %>`
10
+ <% }); %>
11
+
12
+ **依赖关系**:
13
+ <% if(item.depChains.length === 0) { %>
14
+ <% if(item.name === packageJson.name) { %>
15
+ 当前工程
16
+ <% } else { %>
17
+ - `<%- packageJson.name %>` / <%- item.name %>
18
+ <% } %>
19
+ <% } else { %>
20
+ <% item.depChains.forEach((chain) => { %>
21
+ <% if(chain.length === 1 && chain[0] === packageJson.name) { %>
22
+ 当前工程
23
+ <% } else { %>
24
+ - `<%- packageJson.name %>` / <%- chain.map(c=>`\`${c}\``).join(' / ') %>
25
+ <% } %>
26
+ <% }); %>
27
+ <% } %>
28
+
29
+ **漏洞包所在目录**:
30
+ <% item.nodes.forEach((path) => { %>
31
+ - `<%- path %>`
32
+ <% }); %>
@@ -0,0 +1,7 @@
1
+ ## <%-desc.severityLevels[type] %>漏洞
2
+
3
+ 共计 **<%- audit.summary[type] %>** 个
4
+
5
+ <% audit.vulnerabilities[type].forEach(function(item){ %>
6
+ <%- include('./detail-item.ejs', {item: item}) %>
7
+ <% }); %>
@@ -0,0 +1,8 @@
1
+ # `<%- packageJson.name %>`审计结果
2
+
3
+ <% if(audit.summary.total) { %>
4
+ <%- include('./audit.ejs'); %>
5
+ <% } %>
6
+ <% if(audit.summary.total === 0) { %>
7
+ 你项目的所有直接依赖和间接依赖都没有发现任何风险漏洞。
8
+ <% } %>