inspectpack/lib/interfaces/webpack-stats.js

An inspection tool for Webpack frontend JavaScript bundles.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RWebpackStats = exports.RWebpackStatsModuleModules = exports.RWebpackStatsModuleSynthetic = exports.RWebpackStatsModuleOrphan = exports.RWebpackStatsModuleSource = void 0;
/*tslint:disable variable-name*/
const t = require("io-ts");
/**
 * Webpack module object interfaces.
 *
 * We use two "types" of interfaces here:
 * - `I<name>`: A standard TypeScript type/interface. Compiled away.
 * - `R<name>`: A outputted to `lib` `io-ts` data structure for runtime type
 *   checking.
 *
 * The webpack stats module objects have two "flavors":
 * - An object containing `source` with stringified source code.
 * - An object containing a modules array at the `modules` field.
 *
 * We bridge both with these compile + runtime types.
 */
// Common
const RWebpackStatsChunk = t.union([t.string, t.number, t.null]);
// ----------------------------------------------------------------------------
// Assets
// ----------------------------------------------------------------------------
const RWebpackStatsAsset = t.type({
    // Chunk identifiers.
    chunks: t.array(RWebpackStatsChunk),
    // Output file name.
    name: t.string,
    // Estimated byte size of module.
    size: t.number,
});
// ----------------------------------------------------------------------------
// Array of assets.
// ----------------------------------------------------------------------------
const RWebpackStatsAssets = t.array(RWebpackStatsAsset);
// ----------------------------------------------------------------------------
// Module: Base types
// ----------------------------------------------------------------------------
const RWebpackStatsModuleBase = t.type({
    // Chunk identifiers.
    chunks: t.array(RWebpackStatsChunk),
    // Full path to file on disk (with extra hash stuff if `modules` module and
    // loader prefixes, etc.).
    identifier: t.string,
    // Estimated byte size of module.
    size: t.number,
});
// Added fields for some modules that we _don't_ want in the base fields.
const RWebpackStatsModuleWithName = t.type({
    // An absolute (webpack v1-3) or relative (webpack v4) name of the module.
    //
    // Forms:
    // - v1, v2: "/PATH/TO/ROOT/~/pkg/index.js"
    // - v3: "/PATH/TO/ROOT/node_modules/pkg/index.js"
    // - v4: "./node_modules/pkg/index.js"
    name: t.string,
});
// ----------------------------------------------------------------------------
// Module: Single code **source**
// ----------------------------------------------------------------------------
exports.RWebpackStatsModuleSource = t.intersection([
    RWebpackStatsModuleBase,
    RWebpackStatsModuleWithName,
    t.type({
        // Raw source, stringified
        source: t.string,
    }),
]);
// ----------------------------------------------------------------------------
// Module: Orphaned code **source**
//
// Introduced in webpack5 as a stat field, ignore these as not in any chunk.
// See: https://webpack.js.org/configuration/stats/#statsorphanmodules
// ----------------------------------------------------------------------------
exports.RWebpackStatsModuleOrphan = t.intersection([
    exports.RWebpackStatsModuleSource,
    t.type({
        orphan: t.boolean,
    }),
]);
// ----------------------------------------------------------------------------
// Module: Single "synthetic" module
//
// This is a module created from webpack-specific programming / macros. E.g.
//
// ```js
// {
//   "identifier": "/PATH/TO/PROJECT/node_modules/moment/locale /es/",
//   "name": "../moment/locale es",
//   "size": 235,
// }
// ```
//
// with no `source` or `modules`. This translates to bundle code of:
//
// ```js
// /***/ (function(module, exports, __webpack_require__) {
//
//   var map = {
//     "./es": 4,
//     "./es-do": 5,
//     "./es-do.js": 5,
//     "./es-us": 6,
//     "./es-us.js": 6,
//     "./es.js": 4
//   };
//   // ... webpack boilerplate stuff to load the files ...
// ```
// ----------------------------------------------------------------------------
// Just alias base.
exports.RWebpackStatsModuleSynthetic = t.intersection([
    RWebpackStatsModuleBase,
    RWebpackStatsModuleWithName,
]);
exports.RWebpackStatsModuleModules = t.recursion("RWebpackStatsModuleModules", (self) => t.intersection([
    RWebpackStatsModuleBase,
    t.type({
        // More levels of modules.
        // https://webpack.js.org/api/stats/#module-objects
        modules: t.array(t.union([
            exports.RWebpackStatsModuleSource,
            self,
        ])),
    }),
]));
// ----------------------------------------------------------------------------
// Module: Either `source` or `modules` types.
// ----------------------------------------------------------------------------
const RWebpackStatsModule = t.union([
    exports.RWebpackStatsModuleSource,
    exports.RWebpackStatsModuleSynthetic,
    exports.RWebpackStatsModuleModules,
]);
// ----------------------------------------------------------------------------
// Array of modules.
// ----------------------------------------------------------------------------
const RWebpackStatsModules = t.array(RWebpackStatsModule);
// ----------------------------------------------------------------------------
// The full webpack stats object.
// ----------------------------------------------------------------------------
// tslint:disable-next-line variable-name
exports.RWebpackStats = t.interface({
    assets: RWebpackStatsAssets,
    modules: RWebpackStatsModules,
});