@relative-ci/webpack-plugin 5.0.0-alpha.2

package/lib/cjs/index.js

@@ -0,0 +1,76 @@
+'use strict';
+
+var webpack = require('webpack');
+var _ = require('lodash');
+var core = require('@relative-ci/core');
+var ingest = require('@relative-ci/core/ingest');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var webpack__default = /*#__PURE__*/_interopDefault(webpack);
+var ___default = /*#__PURE__*/_interopDefault(_);
+var ingest__default = /*#__PURE__*/_interopDefault(ingest);
+
+const PLUGIN_NAME = 'RelativeCiAgent';
+const DEFAULT_OPTIONS = {
+    includeCommitMessage: true,
+    payloadFilepath: null,
+    stats: {
+        assets: true,
+        chunks: true,
+        modules: true,
+    },
+};
+const isWebpack5 = parseInt(webpack__default.default.version, 10) === 5;
+async function sendStats(compilation, options) {
+    const { stats: statsOptions, failOnError, ...config } = options;
+    const data = compilation.getStats().toJson(statsOptions);
+    const logger = compilation.compiler?.getInfrastructureLogger
+        ? compilation.compiler.getInfrastructureLogger(PLUGIN_NAME)
+        : console;
+    try {
+        core.validateWebpackStats(data);
+        const params = core.normalizeParams({}, config);
+        const artifactsData = core.filterArtifacts([{ key: core.SOURCE_WEBPACK_STATS, data }]);
+        const response = await ingest__default.default(artifactsData, params, config, logger);
+        core.logResponse(response);
+    }
+    catch (error) {
+        if (failOnError) {
+            compilation.errors.push(error);
+        }
+        else {
+            logger.warn(error); // catch error to prevent failure on error
+        }
+    }
+}
+class RelativeCiAgentWebpackPlugin {
+    constructor(options) {
+        this.options = options;
+    }
+    apply(compiler) {
+        const { isCi } = core.getEnvVars();
+        const options = ___default.default.merge({}, DEFAULT_OPTIONS, {
+            enabled: isCi,
+        }, this.options);
+        core.debug(options);
+        // Skip if not enabled
+        if (!options.enabled) {
+            core.debug(`${PLUGIN_NAME} is disabled, skip sending data`);
+            return;
+        }
+        if (isWebpack5) {
+            compiler.hooks.make.tap(PLUGIN_NAME, (compilation) => {
+                compilation.hooks.processAssets.tap({ name: PLUGIN_NAME, stage: webpack__default.default.Compilation.PROCESS_ASSETS_STAGE_REPORT }, () => sendStats(compilation, options));
+            });
+            return;
+        }
+        compiler.hooks.emit.tapAsync(PLUGIN_NAME, async (compilation, callback) => {
+            await sendStats(compilation, options);
+            callback();
+        });
+    }
+}
+
+exports.RelativeCiAgentWebpackPlugin = RelativeCiAgentWebpackPlugin;
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/index.ts"],"sourcesContent":[null],"names":["webpack","validateWebpackStats","normalizeParams","filterArtifacts","SOURCE_WEBPACK_STATS","ingest","logResponse","getEnvVars","_","debug"],"mappings":";;;;;;;;;;;;;AA4CA,MAAM,WAAW,GAAG,iBAAiB;AAErC,MAAM,eAAe,GAAG;AACtB,IAAA,oBAAoB,EAAE,IAAI;AAC1B,IAAA,eAAe,EAAE,IAAI;AACrB,IAAA,KAAK,EAAE;AACL,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,OAAO,EAAE,IAAI;AACd,KAAA;CACF;AAED,MAAM,UAAU,GAAG,QAAQ,CAACA,wBAAO,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC;AAEtD,eAAe,SAAS,CACtB,WAAwB,EACxB,OAA4C,EAAA;AAE5C,IAAA,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC;AAExD,IAAA,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,EAAE;UACjC,WAAW,CAAC,QAAQ,CAAC,uBAAuB,CAAC,WAAW;UACxD,OAAO;AAEX,IAAA,IAAI;QACFC,yBAAoB,CAAC,IAAI,CAAC;QAE1B,MAAM,MAAM,GAAGC,oBAAe,CAAC,EAAE,EAAE,MAAM,CAAC;AAC1C,QAAA,MAAM,aAAa,GAAGC,oBAAe,CAAC,CAAC,EAAE,GAAG,EAAEC,yBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAA,MAAM,QAAQ,GAAG,MAAMC,uBAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;QAEpEC,gBAAW,CAAC,QAAQ,CAAC;;IACrB,OAAO,KAAU,EAAE;QACnB,IAAI,WAAW,EAAE;AACf,YAAA,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;;aACzB;AACL,YAAA,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;AAGzB;MAEa,4BAA4B,CAAA;AAGvC,IAAA,WAAA,CAAY,OAA4C,EAAA;AACtD,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;;AAGxB,IAAA,KAAK,CAAC,QAAkB,EAAA;AACtB,QAAA,MAAM,EAAE,IAAI,EAAE,GAAGC,eAAU,EAAE;QAE7B,MAAM,OAAO,GAAwCC,kBAAC,CAAC,KAAK,CAC1D,EAAE,EACF,eAAe,EACf;AACE,YAAA,OAAO,EAAE,IAAI;AACd,SAAA,EACD,IAAI,CAAC,OAAO,CACb;QAEDC,UAAK,CAAC,OAAO,CAAC;;AAGd,QAAA,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;AACpB,YAAAA,UAAK,CAAC,CAAA,EAAG,WAAW,CAAA,+BAAA,CAAiC,CAAC;YACtD;;QAGF,IAAI,UAAU,EAAE;AACd,YAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,WAAW,KAAI;AACnD,gBAAA,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CACjC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAET,wBAAO,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAC7E,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CACtC;AACH,aAAC,CAAC;YAEF;;AAGF,QAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAC1B,WAAW,EACX,OAAO,WAAW,EAAE,QAAQ,KAAI;AAC9B,YAAA,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;AACrC,YAAA,QAAQ,EAAE;AACZ,SAAC,CACF;;AAEJ;;;;"}

package/lib/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/lib/esm/index.js

@@ -0,0 +1,68 @@
+import webpack from 'webpack';
+import _ from 'lodash';
+import { getEnvVars, debug, validateWebpackStats, normalizeParams, filterArtifacts, SOURCE_WEBPACK_STATS, logResponse } from '@relative-ci/core';
+import ingest from '@relative-ci/core/ingest';
+
+const PLUGIN_NAME = 'RelativeCiAgent';
+const DEFAULT_OPTIONS = {
+    includeCommitMessage: true,
+    payloadFilepath: null,
+    stats: {
+        assets: true,
+        chunks: true,
+        modules: true,
+    },
+};
+const isWebpack5 = parseInt(webpack.version, 10) === 5;
+async function sendStats(compilation, options) {
+    const { stats: statsOptions, failOnError, ...config } = options;
+    const data = compilation.getStats().toJson(statsOptions);
+    const logger = compilation.compiler?.getInfrastructureLogger
+        ? compilation.compiler.getInfrastructureLogger(PLUGIN_NAME)
+        : console;
+    try {
+        validateWebpackStats(data);
+        const params = normalizeParams({}, config);
+        const artifactsData = filterArtifacts([{ key: SOURCE_WEBPACK_STATS, data }]);
+        const response = await ingest(artifactsData, params, config, logger);
+        logResponse(response);
+    }
+    catch (error) {
+        if (failOnError) {
+            compilation.errors.push(error);
+        }
+        else {
+            logger.warn(error); // catch error to prevent failure on error
+        }
+    }
+}
+class RelativeCiAgentWebpackPlugin {
+    constructor(options) {
+        this.options = options;
+    }
+    apply(compiler) {
+        const { isCi } = getEnvVars();
+        const options = _.merge({}, DEFAULT_OPTIONS, {
+            enabled: isCi,
+        }, this.options);
+        debug(options);
+        // Skip if not enabled
+        if (!options.enabled) {
+            debug(`${PLUGIN_NAME} is disabled, skip sending data`);
+            return;
+        }
+        if (isWebpack5) {
+            compiler.hooks.make.tap(PLUGIN_NAME, (compilation) => {
+                compilation.hooks.processAssets.tap({ name: PLUGIN_NAME, stage: webpack.Compilation.PROCESS_ASSETS_STAGE_REPORT }, () => sendStats(compilation, options));
+            });
+            return;
+        }
+        compiler.hooks.emit.tapAsync(PLUGIN_NAME, async (compilation, callback) => {
+            await sendStats(compilation, options);
+            callback();
+        });
+    }
+}
+
+export { RelativeCiAgentWebpackPlugin };
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AA4CA,MAAM,WAAW,GAAG,iBAAiB;AAErC,MAAM,eAAe,GAAG;AACtB,IAAA,oBAAoB,EAAE,IAAI;AAC1B,IAAA,eAAe,EAAE,IAAI;AACrB,IAAA,KAAK,EAAE;AACL,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,OAAO,EAAE,IAAI;AACd,KAAA;CACF;AAED,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC;AAEtD,eAAe,SAAS,CACtB,WAAwB,EACxB,OAA4C,EAAA;AAE5C,IAAA,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC;AAExD,IAAA,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,EAAE;UACjC,WAAW,CAAC,QAAQ,CAAC,uBAAuB,CAAC,WAAW;UACxD,OAAO;AAEX,IAAA,IAAI;QACF,oBAAoB,CAAC,IAAI,CAAC;QAE1B,MAAM,MAAM,GAAG,eAAe,CAAC,EAAE,EAAE,MAAM,CAAC;AAC1C,QAAA,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAA,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;QAEpE,WAAW,CAAC,QAAQ,CAAC;;IACrB,OAAO,KAAU,EAAE;QACnB,IAAI,WAAW,EAAE;AACf,YAAA,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;;aACzB;AACL,YAAA,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;AAGzB;MAEa,4BAA4B,CAAA;AAGvC,IAAA,WAAA,CAAY,OAA4C,EAAA;AACtD,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;;AAGxB,IAAA,KAAK,CAAC,QAAkB,EAAA;AACtB,QAAA,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,EAAE;QAE7B,MAAM,OAAO,GAAwC,CAAC,CAAC,KAAK,CAC1D,EAAE,EACF,eAAe,EACf;AACE,YAAA,OAAO,EAAE,IAAI;AACd,SAAA,EACD,IAAI,CAAC,OAAO,CACb;QAED,KAAK,CAAC,OAAO,CAAC;;AAGd,QAAA,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;AACpB,YAAA,KAAK,CAAC,CAAA,EAAG,WAAW,CAAA,+BAAA,CAAiC,CAAC;YACtD;;QAGF,IAAI,UAAU,EAAE;AACd,YAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,WAAW,KAAI;AACnD,gBAAA,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CACjC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAC7E,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CACtC;AACH,aAAC,CAAC;YAEF;;AAGF,QAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAC1B,WAAW,EACX,OAAO,WAAW,EAAE,QAAQ,KAAI;AAC9B,YAAA,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;AACrC,YAAA,QAAQ,EAAE;AACZ,SAAC,CACF;;AAEJ;;;;"}

package/lib/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/types/index.d.ts

@@ -0,0 +1,34 @@
+import { type Compiler, type Configuration } from 'webpack';
+import { type PluginConfig } from '@relative-ci/core';
+type RelativeCiAgentWebpackPluginOptions = {
+    /**
+     * Plugin is enabled - sends data to RelativeCI
+     * @default env-ci isCi value
+     */
+    enabled?: boolean;
+    /**
+     * Throw error when validation or ingestion fails
+     * @default {false}
+     */
+    failOnError?: boolean;
+    /**
+     * Read commit message from git
+     * @default true
+     */
+    includeCommitMessage?: PluginConfig['includeCommitMessage'];
+    /**
+     * Output payload on a local file for debugging
+     */
+    payloadFilepath?: PluginConfig['payloadFilepath'];
+    /**
+     * Webpack stats options
+     * @default assets, chunks, modules
+     */
+    stats?: Configuration['stats'];
+};
+export declare class RelativeCiAgentWebpackPlugin {
+    options: RelativeCiAgentWebpackPluginOptions;
+    constructor(options: RelativeCiAgentWebpackPluginOptions);
+    apply(compiler: Compiler): void;
+}
+export {};

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@relative-ci/webpack-plugin",
+  "version": "5.0.0-alpha.2",
+  "description": "Webpack plugin that sends bundle stats and CI build information to RelativeCI",
+  "keywords": [
+    "webpack",
+    "vitejs",
+    "rspack",
+    "rollup",
+    "bundle-size",
+    "bundle-analyzer",
+    "bundle-stats",
+    "stats",
+    "bundle",
+    "size",
+    "assets",
+    "chunks",
+    "modules"
+  ],
+  "repository": "https://github.com/relative-ci/agent",
+  "bugs": {
+    "url": "https://github.com/relative-ci/agent/issues"
+  },
+  "homepage": "https://relative-ci.com/documentation/setup",
+  "license": "MIT",
+  "author": {
+    "name": "Viorel Cojocaru",
+    "email": "vio@relative-ci.com",
+    "url": "https://relative-ci.com"
+  },
+  "engines": {
+    "node": ">= 18.0.0"
+  },
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
+  "scripts": {
+    "build": "npm run clean && rollup -c && npm run build-type",
+    "build-type": "echo '{\"type\":\"commonjs\"}' > lib/cjs/package.json && echo '{\"type\":\"module\"}' > lib/esm/package.json",
+    "clean": "rimraf ./lib",
+    "clean-deps": "rimraf ./test/webpack/*/node_modules ./node_modules",
+    "lint": "eslint .",
+    "test": "vitest src --passWithNoTests --run"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "28.0.3",
+    "@rollup/plugin-node-resolve": "16.0.0",
+    "@rollup/plugin-replace": "6.0.2",
+    "@rollup/plugin-typescript": "12.1.2",
+    "@tsconfig/node18": "^18.2.4",
+    "@types/lodash": "4.17.16",
+    "memory-fs": "0.5.0",
+    "rimraf": "6.0.1",
+    "rollup": "4.35.0",
+    "rollup-plugin-node-externals": "8.0.0",
+    "typescript": "5.8.2",
+    "vitest": "3.0.8",
+    "webpack": "5.98.0"
+  },
+  "dependencies": {
+    "@relative-ci/core": "*",
+    "lodash": "4.17.21"
+  },
+  "peerDependencies": {
+    "webpack": "^4.0.0 || ^5.0.0-rc.1"
+  }
+}