@dragonshorn-studios/elyseum-cli 0.1.0 → 0.1.1

package/dist/commands/diff-coverage-command.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"diff-coverage-command.d.ts","sourceRoot":"","sources":["../../src/commands/diff-coverage-command.ts"],"names":[],"mappings":"AAaA,qBAAa,mBAAmB;;IAGjB,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;YAwD5B,qBAAqB;YAoIrB,iBAAiB;YAYjB,eAAe;CA4E9B"}
+{"version":3,"file":"diff-coverage-command.d.ts","sourceRoot":"","sources":["../../src/commands/diff-coverage-command.ts"],"names":[],"mappings":"AAaA,qBAAa,mBAAmB;;IAGjB,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;YAuD5B,qBAAqB;YAuIrB,iBAAiB;YAYjB,eAAe;CA4E9B"}

package/dist/index.js

@@ -38910,21 +38910,40 @@ class GithubPRCommentCoverageReporter {
         this.quality_gate_failed = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm8.036-4.024a.751.751 0 0 0-1.042.018.751.751 0 0 0-.018 1.042L10.939 12l-2.963 2.963a.749.749 0 0 0 .326 1.275.749.749 0 0 0 .734-.215L12 13.06l2.963 2.964a.75.75 0 0 0 1.061-1.06L13.061 12l2.963-2.964a.749.749 0 0 0-.326-1.275.749.749 0 0 0-.734.215L12 10.939Z"></path></svg>`;
     }
     report(diffCoverage) {
-        const reportName = Config.getInstance().getFirst(["reporter.coverage.github-pr-comment.file"], "github.pr.coverage.md");
+        // check if we have github ci environment variables, and if not, return
+        if (!process.env.GITHUB_ACTIONS || !process.env.GITHUB_EVENT_NAME) {
+            console.error("Not running in GitHub CI environment, skipping GitHub PR comment coverage reporter");
+            return;
+        }
+        const reportPath = Config.getInstance().getFirst(["reporter.coverage.github-pr-comment.comment-file-path"], "coverage/github.pr.coverage.md");
+        const commentName = Config.getInstance().getFirst(["reporter.coverage.github-pr-comment.comment-name"], "coverage/github.pr.coverage.md");
         const qualityGate = Config.getInstance().getFirst(["reporter.coverage.qualityGate"], 80);
+        let repoName = process.env.GITHUB_REPOSITORY;
+        let runId = process.env.GITHUB_RUN_ID;
+        let markdown = `## ${commentName}\n\n`;
+        // lines, functions, branches average percentage must be greater than or equal to qualityGate
+        const qualityGateFailed = diffCoverage.lines.percent < qualityGate ||
+            diffCoverage.functions.percent < qualityGate ||
+            diffCoverage.branches.percent < qualityGate;
+        let coverageQualityText = ``;
+        if (qualityGate) {
+            if (qualityGateFailed) {
+                coverageQualityText += `> [!CAUTION]\n### Coverage Quality Gate Failed ${qualityGateFailed}`;
+            }
+            else {
+                coverageQualityText += `> [!TIP]\n### Coverage Quality Gate Passed ${qualityGateFailed}`;
+            }
+            coverageQualityText += `> ${this.getIcon(diffCoverage.lines.percent)} Lines: ${diffCoverage.lines.percent.toFixed(2)}% (baseline: ${qualityGate}%)\n`;
+            coverageQualityText += `> ${this.getIcon(diffCoverage.functions.percent)} Functions: ${diffCoverage.functions.percent.toFixed(2)}% (baseline: ${qualityGate}%)\n`;
+            coverageQualityText += `> ${this.getIcon(diffCoverage.branches.percent)} Branches: ${diffCoverage.branches.percent.toFixed(2)}% (baseline: ${qualityGate}%)\n\n`;
+        }
         let summary = `| Type      | Total | Covered | Percent |\n`;
         summary += `|-----------|-------|---------|---------|\n`;
         summary += `| Lines     | ${diffCoverage.lines.total} | ${diffCoverage.lines.covered} | ${this.getIcon(diffCoverage.lines.percent)} ${diffCoverage.lines.percent.toFixed(2)}% |\n`;
         summary += `| Functions | ${diffCoverage.functions.total} | ${diffCoverage.functions.covered} | ${this.getIcon(diffCoverage.functions.percent)} ${diffCoverage.functions.percent.toFixed(2)}% |\n`;
         summary += `| Branches  | ${diffCoverage.branches.total} | ${diffCoverage.branches.covered} | ${this.getIcon(diffCoverage.branches.percent)} ${diffCoverage.branches.percent.toFixed(2)}% |\n`;
-        let markdown = `## Coverage Summary\n\n${summary}`;
-        // lines, functions, branches average percentage must be greater than or equal to qualityGate
-        const qualityGateFailed = diffCoverage.lines.percent < qualityGate ||
-            diffCoverage.functions.percent < qualityGate ||
-            diffCoverage.branches.percent < qualityGate;
-        markdown += `\n\n### Coverage Quality Gate: ${qualityGateFailed
-            ? `Failed <span style='color: #cb2431;'>${this.quality_gate_failed}</span>`
-            : `Passed <span style='color: #28a745;'>${this.quality_gate_passed}</span>`}`;
+        markdown += `### Coverage Summary\n\n${summary}`;
+        markdown += coverageQualityText;
         let detailsTable = `\n<details>\n<summary>Coverage Details</summary>\n\n`;
         detailsTable += `| File | Lines (%) | Functions (%) | Branches (%) |\n`;
         detailsTable += `|------|-----------|---------------|--------------|\n`;
@@ -38933,10 +38952,15 @@ class GithubPRCommentCoverageReporter {
         }
         detailsTable += `\n</details>\n`;
         markdown += detailsTable;
-        if (!fs$1.statSync("coverage")) {
-            fs$1.mkdirSync("coverage");
+        let reportInfo = `Report for commit ${diffCoverage.headSha}`;
+        if (diffCoverage.baseSha) {
+            reportInfo += ` against base commit ${diffCoverage.baseSha}`;
         }
-        fs$1.writeFileSync(`coverage/${reportName}`, markdown);
+        reportInfo += ` (triggering run: <a href="/${repoName}/actions/runs/${runId}">${runId}</a>)`;
+        fs$1.mkdirSync(reportPath.substring(0, reportPath.lastIndexOf("/")), {
+            recursive: true,
+        });
+        fs$1.writeFileSync(reportPath, markdown);
     }
     getIcon(percent) {
         if (percent >= 80) {
@@ -38989,17 +39013,17 @@ class DiffCoverageCommand {
             "**/*.vue",
         ];
         try {
-            args.head =
-                args.head ||
-                    (await git.resolveRef({ fs: fs$2, dir: process.cwd(), ref: "HEAD" }));
-            args.base =
-                args.base ||
-                    (await git.resolveRef({
-                        fs: fs$2,
-                        dir: process.cwd(),
-                        ref: "origin/master",
-                    }));
-            let files = await this.getChangedFiles(process.cwd(), args.head, args.base);
+            let headSha = await git.resolveRef({
+                fs: fs$2,
+                dir: process.cwd(),
+                ref: args.head || process.env.GITHUB_SHA || "HEAD",
+            });
+            let baseSha = await git.resolveRef({
+                fs: fs$2,
+                dir: process.cwd(),
+                ref: args.base || process.env.GITHUB_BASE_REF || "origin/main",
+            });
+            let files = await this.getChangedFiles(process.cwd(), headSha, baseSha);
             files = files.filter((file) => {
                 return (!coverageExcludes.some((exclude) => {
                     return minimatch(file.path.replace(/^\//, ""), exclude);
@@ -39009,7 +39033,10 @@ class DiffCoverageCommand {
                     }));
             });
             let coverage = await this.getCoverageReport("coverage/lcov.info");
-            let diffCoverage = await this.calculateDiffCoverage(files, coverage);
+            let diffCoverage = await this.calculateDiffCoverage(files, coverage, {
+                headSha,
+                baseSha,
+            });
             for (let reporter of getCoverageReportersFromArgs(args)) {
                 reporter.report(diffCoverage);
             }
@@ -39018,8 +39045,10 @@ class DiffCoverageCommand {
             console.error(error);
         }
     }
-    async calculateDiffCoverage(files, coverage) {
+    async calculateDiffCoverage(files, coverage, { headSha, baseSha }) {
         const diffCoverageResult = {
+            headSha,
+            baseSha,
             lines: {
                 total: 0,
                 covered: 0,