@front10/danger-plugins 2.0.0 → 3.0.0-alpha.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export * as netlify from "./plugin-netlify";
-export { bundleSize, BundleSizeOptions, bundleSizeResults } from "./plugin-bundle-size";
-export { lighthouse } from "./plugin-lighthouse";
+export * as netlify from "./plugin-netlify.js";
+export { bundleSize, BundleSizeOptions, bundleSizeResults, } from "./plugin-bundle-size.js";
+export { lighthouse } from "./plugin-lighthouse.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -1,8 +1,3 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./danger-plugins.cjs.production.min.js')
-} else {
-  module.exports = require('./danger-plugins.cjs.development.js')
-}
+export * as netlify from "./plugin-netlify.js";
+export { bundleSize, bundleSizeResults, } from "./plugin-bundle-size.js";
+export { lighthouse } from "./plugin-lighthouse.js";

package/dist/plugin-bundle-size.d.ts

@@ -1,25 +1,23 @@
-declare type CompressionFormats = "gzip" | "brotli";
-declare type Preset = "widgets";
-export interface BundleSizeOptions {
-    title?: string;
-    formats?: CompressionFormats[];
-    bundlesDir: string;
-    getBundlesFn?: (bundleDir: string) => string[];
-    renameFn?: (filename: string) => string;
-    bundlePrefix?: string;
-    reportPath?: string;
-    baseBundleJob?: string;
-    preset?: Preset;
-}
-interface BundleInfo {
-    filename: string;
-    sizes: number[];
-}
-interface BundleSizeResult {
-    gzip: boolean;
-    brotli: boolean;
-    bundles: BundleInfo[];
-}
-export declare function bundleSizeResults({ formats, bundlesDir, renameFn, getBundlesFn, bundlePrefix, reportPath, preset, }: BundleSizeOptions): BundleSizeResult;
-export declare function bundleSize(options: BundleSizeOptions): Promise<void>;
-export {};
+type CompressionFormats = "gzip" | "brotli";
+export interface BundleSizeOptions {
+    title?: string;
+    formats?: CompressionFormats[];
+    bundlesDir: string;
+    getBundlesFn?: (bundleDir: string) => string[];
+    renameFn?: (filename: string) => string;
+    reportPath?: string;
+    baseBundleJob?: string;
+}
+interface BundleInfo {
+    filename: string;
+    sizes: number[];
+}
+interface BundleSizeResult {
+    gzip: boolean;
+    brotli: boolean;
+    bundles: BundleInfo[];
+}
+export declare function bundleSizeResults({ formats, bundlesDir, renameFn, getBundlesFn, reportPath, }: BundleSizeOptions): BundleSizeResult;
+export declare function bundleSize(options: BundleSizeOptions): Promise<void>;
+export {};
+//# sourceMappingURL=plugin-bundle-size.d.ts.map

package/dist/plugin-bundle-size.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-bundle-size.d.ts","sourceRoot":"","sources":["../src/plugin-bundle-size.ts"],"names":[],"mappings":"AAOA,KAAK,kBAAkB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAiB5C,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;IAC/C,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAyBD,UAAU,UAAU;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,wBAAgB,iBAAiB,CAAC,EAChC,OAAkB,EAClB,UAAU,EACV,QAA0B,EAC1B,YAAkC,EAClC,UAAU,GACX,EAAE,iBAAiB,GAAG,gBAAgB,CA8BtC;AAiBD,wBAAsB,UAAU,CAAC,OAAO,EAAE,iBAAiB,iBA+E1D"}

package/dist/plugin-bundle-size.js

@@ -0,0 +1,143 @@
+import fs, { existsSync, lstatSync, readdirSync, readFileSync } from "node:fs";
+import path from "node:path";
+import zlib from "node:zlib";
+/**
+ * Generates a Markdown table
+ * @param {string[]} headers
+ * @param {string[][]} body
+ */
+function generateMDTable(headers, body) {
+    const tableHeaders = [
+        headers.join(" | "),
+        headers.map(() => " --- ").join(" | "),
+    ];
+    const tableBody = body.map((r) => r.join(" | "));
+    return `${tableHeaders.join("\n")}\n${tableBody.join("\n")}`;
+}
+function getWidgetsGetBundlesFn(bundlePrefix) {
+    return function defaultGetBundlesFn(bundlesDir) {
+        return readdirSync(bundlesDir)
+            .map((name) => path.join(bundlesDir, name))
+            .filter((dirName) => lstatSync(dirName).isDirectory())
+            .map((dirName) => path.join(dirName, path.basename(dirName).replace(bundlePrefix, "") + ".bundle.js"));
+    };
+}
+function defaultGetBundlesFn(bundlesDir) {
+    return readdirSync(bundlesDir)
+        .filter((file) => file.endsWith(".js"))
+        .map((file) => path.join(bundlesDir, file));
+}
+function defaultRenameFn(filePath) {
+    return path.basename(filePath).replace(".min.js", "").replace(".js", "");
+}
+export function bundleSizeResults({ formats = ["gzip"], bundlesDir, renameFn = defaultRenameFn, getBundlesFn = defaultGetBundlesFn, reportPath, }) {
+    const files = getBundlesFn(bundlesDir).filter(existsSync);
+    const formatFilter = new Set(formats);
+    const gzip = formatFilter.has("gzip");
+    const brotli = formatFilter.has("brotli");
+    const results = {
+        gzip,
+        brotli,
+        bundles: files.map((filePath) => {
+            const jsFile = readFileSync(filePath);
+            const fileSizes = [
+                jsFile,
+                ...(gzip ? [zlib.gzipSync(jsFile)] : []),
+                ...(brotli ? [zlib.brotliCompressSync(jsFile)] : []),
+            ];
+            return {
+                filename: renameFn(filePath),
+                sizes: fileSizes.map((file) => file.length),
+            };
+        }),
+    };
+    if (reportPath) {
+        fs.writeFileSync(reportPath, JSON.stringify(results, null, 2));
+    }
+    return results;
+}
+function formatDiff(value) {
+    let sizeString = (value / 1000).toFixed(1);
+    if (sizeString === "-0.0") {
+        sizeString = "0.0";
+    }
+    const size = Number(sizeString);
+    let icon = "";
+    if (size > 0) {
+        icon = "🔺+";
+    }
+    else if (size < 0) {
+        icon = "🔻";
+    }
+    return `${icon}${sizeString}k`;
+}
+export async function bundleSize(options) {
+    const results = bundleSizeResults(options);
+    const { reportPath, baseBundleJob = "publish" } = options;
+    let baseResults;
+    if (reportPath) {
+        const projectId = process.env.CI_MERGE_REQUEST_PROJECT_ID;
+        const authToken = process.env.DANGER_GITLAB_API_TOKEN;
+        const targetBranch = process.env.CI_MERGE_REQUEST_TARGET_BRANCH_NAME || "main";
+        const baseBundlesUrl = `https://gitlab.com/api/v4/projects/${projectId}/jobs/artifacts/${targetBranch}/raw/${reportPath}?job=${baseBundleJob}`;
+        const headers = new Headers();
+        if (authToken) {
+            headers.set("PRIVATE-TOKEN", authToken);
+        }
+        const baseBundlesResponse = await fetch(baseBundlesUrl, {
+            headers,
+        });
+        if (baseBundlesResponse.ok) {
+            baseResults = (await baseBundlesResponse.json());
+        }
+    }
+    let baseBundles = new Map();
+    let diffHeaders = [];
+    if (baseResults) {
+        const { bundles, brotli, gzip } = baseResults;
+        if (bundles) {
+            bundles.forEach((bundle) => {
+                baseBundles.set(bundle.filename, bundle.sizes);
+            });
+        }
+        diffHeaders = [
+            "Filesize diff",
+            ...(gzip ? ["Gzip diff"] : []),
+            ...(brotli ? ["Brotli diff"] : []),
+        ];
+    }
+    const headers = [
+        "Module",
+        "Filesize",
+        ...(results.gzip ? ["Gzip size"] : []),
+        ...(results.brotli ? ["Brotli size"] : []),
+        ...diffHeaders,
+    ];
+    const body = results.bundles.map((bundle) => {
+        let diff = [];
+        if (baseResults) {
+            const { brotli, gzip } = baseResults;
+            const baseBrotliIndex = brotli && !gzip ? 1 : 2;
+            const brotliIndex = results.brotli && !results.gzip ? 1 : 2;
+            if (baseBundles.has(bundle.filename)) {
+                const baseBundle = baseBundles.get(bundle.filename);
+                diff = [
+                    bundle.sizes[0] - baseBundle[0],
+                    ...(gzip && results.gzip ? [bundle.sizes[1] - baseBundle[1]] : []),
+                    ...(brotli && results.brotli
+                        ? [bundle.sizes[brotliIndex] - baseBundle[baseBrotliIndex]]
+                        : []),
+                ];
+            }
+        }
+        return [
+            bundle.filename,
+            ...bundle.sizes.map((size) => `${(size / 1000).toFixed(1)}k`),
+            ...diff.map((size) => formatDiff(size)),
+        ];
+    });
+    markdown([
+        "## " + (options.title ?? "Bundle size"),
+        generateMDTable(headers, body),
+    ].join("\n\n"));
+}

package/dist/plugin-lighthouse.d.ts

@@ -1 +1,2 @@
-export declare function lighthouse(): Promise<void>;
+export declare function lighthouse(): Promise<void>;
+//# sourceMappingURL=plugin-lighthouse.d.ts.map

package/dist/plugin-lighthouse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-lighthouse.d.ts","sourceRoot":"","sources":["../src/plugin-lighthouse.ts"],"names":[],"mappings":"AAMA,wBAAsB,UAAU,kBAwB/B"}

package/dist/plugin-lighthouse.js

@@ -0,0 +1,20 @@
+import * as fs from "node:fs";
+import { promisify } from "node:util";
+const readFile = promisify(fs.readFile);
+export async function lighthouse() {
+    const content = await readFile(".lighthouseci/links.json");
+    const links = JSON.parse(content.toString());
+    const urlsToCheck = Object.entries(links);
+    if (urlsToCheck.length === 0) {
+        return;
+    }
+    markdown([
+        "## Lighthouse report",
+        urlsToCheck
+            .map(([pageUrl, reportUrl]) => {
+            const pageDisplay = pageUrl.replace(/http:\/\/localhost:[0-9]*\//, "");
+            return `- [${pageDisplay}](${reportUrl})`;
+        })
+            .join("\n"),
+    ].join("\n\n"));
+}

package/dist/plugin-netlify.d.ts

@@ -1,9 +1,10 @@
-declare type Options = {
-    label?: string;
-    site_name: string;
-    deploy_id: string;
-    deploy_url: string;
-    logs: string;
-};
-export declare function deployment(configs: Options[]): Promise<void>;
-export {};
+type Options = {
+    label?: string;
+    site_name: string;
+    deploy_id: string;
+    deploy_url: string;
+    logs: string;
+};
+export declare function deployment(configs: Options[]): Promise<void>;
+export {};
+//# sourceMappingURL=plugin-netlify.d.ts.map

package/dist/plugin-netlify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-netlify.d.ts","sourceRoot":"","sources":["../src/plugin-netlify.ts"],"names":[],"mappings":"AAMA,KAAK,OAAO,GAAG;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,wBAAsB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,iBAuBlD"}

package/dist/plugin-netlify.js

@@ -0,0 +1,21 @@
+export async function deployment(configs) {
+    const authToken = process.env.NETLIFY_AUTH_TOKEN;
+    if (!authToken) {
+        fail(`Couldn't get deploy information. You need to set up an authentication 
+      token in your environment variables. 
+      See: https://gitlab.com/help/ci/variables/README#variables`);
+    }
+    try {
+        const lastCommit = danger.git.commits[0];
+        markdown([
+            "## Deploy preview",
+            "The deploy preview is ready!",
+            `Built with commit ${lastCommit.sha}`,
+            ...configs.map((result) => `${result.label}: ${result.deploy_url}`),
+        ].join(`\n\n`));
+    }
+    catch (e) {
+        console.error(e);
+        fail(`Couldn't get deploy information.`);
+    }
+}

package/package.json

@@ -1,6 +1,7 @@
 {
-  "version": "2.0.0",
+  "version": "3.0.0-alpha.0",
   "license": "MIT",
+  "type": "module",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
@@ -8,28 +9,24 @@
     "src"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=22.22.0"
   },
   "volta": {
-    "node": "16.14.2"
+    "node": "22.22.0"
   },
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "tsdx test --passWithNoTests",
-    "lint": "tsdx lint",
-    "prepublishOnly": "tsdx build"
+    "build": "tsc",
+    "test": "node --test",
+    "prepublishOnly": "npm run build"
   },
   "name": "@front10/danger-plugins",
   "author": "Rainer Martínez Fraga",
   "module": "dist/danger-plugins.esm.js",
   "devDependencies": {
-    "danger": "^10.5.4",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.3.1",
-    "typescript": "^4.1.3"
-  },
-  "dependencies": {
-    "undici": "^4.16.0"
+    "@tsconfig/node22": "^22.0.5",
+    "@types/node": "^22.19.11",
+    "danger": "^13.0.5",
+    "tslib": "^2.8.1",
+    "typescript": "^6.0.2"
   }
 }

package/src/index.ts

@@ -1,3 +1,7 @@
-export * as netlify from "./plugin-netlify";
-export { bundleSize, BundleSizeOptions, bundleSizeResults } from "./plugin-bundle-size";
-export { lighthouse } from "./plugin-lighthouse";
+export * as netlify from "./plugin-netlify.js";
+export {
+  bundleSize,
+  BundleSizeOptions,
+  bundleSizeResults,
+} from "./plugin-bundle-size.js";
+export { lighthouse } from "./plugin-lighthouse.js";

package/src/plugin-bundle-size.ts

@@ -1,8 +1,7 @@
 import { MarkdownString } from "danger";
-import fs, { existsSync, lstatSync, readdirSync, readFileSync } from "fs";
-import { fetch, Headers } from "undici";
-import path from "path";
-import zlib from "zlib";
+import fs, { existsSync, lstatSync, readdirSync, readFileSync } from "node:fs";
+import path from "node:path";
+import zlib from "node:zlib";
 
 declare function markdown(message: MarkdownString): void;
 
@@ -23,18 +22,14 @@ function generateMDTable(headers: string[], body: string[][]): string {
   return `${tableHeaders.join("\n")}\n${tableBody.join("\n")}`;
 }
 
-type Preset = "widgets";
-
 export interface BundleSizeOptions {
   title?: string;
   formats?: CompressionFormats[];
   bundlesDir: string;
   getBundlesFn?: (bundleDir: string) => string[];
   renameFn?: (filename: string) => string;
-  bundlePrefix?: string;
   reportPath?: string;
   baseBundleJob?: string;
-  preset?: Preset;
 }
 
 function getWidgetsGetBundlesFn(bundlePrefix: string) {
@@ -57,18 +52,8 @@ function defaultGetBundlesFn(bundlesDir: string) {
     .map((file) => path.join(bundlesDir, file));
 }
 
-function widgetsRenameFn(filename: string) {
-  return filename
-    .split(".bundle.js")[0]
-    .replace(/--/g, "-")
-    .split("-")
-    .map((e) => e[0].toUpperCase() + e.slice(1))
-    .join(" ")
-    .replace("Mobile", "(mobile)");
-}
-
-function defaultRenameFn(filename: string) {
-  return filename.replace(".min.js", "").replace(".js", "");
+function defaultRenameFn(filePath: string) {
+  return path.basename(filePath).replace(".min.js", "").replace(".js", "");
 }
 interface BundleInfo {
   filename: string;
@@ -86,17 +71,9 @@ export function bundleSizeResults({
   bundlesDir,
   renameFn = defaultRenameFn,
   getBundlesFn = defaultGetBundlesFn,
-  bundlePrefix = "cmp-mc-",
   reportPath,
-  preset,
 }: BundleSizeOptions): BundleSizeResult {
-  let getBundles = getBundlesFn;
-  let rename = renameFn;
-  if (preset === "widgets") {
-    getBundles = getWidgetsGetBundlesFn(bundlePrefix);
-    rename = widgetsRenameFn;
-  }
-  const files = getBundles(bundlesDir).filter(existsSync);
+  const files = getBundlesFn(bundlesDir).filter(existsSync);
 
   const formatFilter = new Set(formats);
   const gzip = formatFilter.has("gzip");
@@ -114,7 +91,7 @@ export function bundleSizeResults({
       ];
 
       return {
-        filename: rename(path.basename(filePath)),
+        filename: renameFn(filePath),
         sizes: fileSizes.map((file) => file.length),
       };
     }),
@@ -217,7 +194,7 @@ export async function bundleSize(options: BundleSizeOptions) {
 
   markdown(
     [
-      "## " + options.title ?? "Bundle size",
+      "## " + (options.title ?? "Bundle size"),
       generateMDTable(headers, body),
     ].join("\n\n")
   );

package/src/plugin-lighthouse.ts

@@ -1,6 +1,6 @@
 declare function markdown(message?: string): void;
-import * as fs from "fs";
-import { promisify } from "util";
+import * as fs from "node:fs";
+import { promisify } from "node:util";
 
 const readFile = promisify(fs.readFile);