@roots/bud-compiler 5.0.0-next.9 → 5.3.0

package/README.md

@@ -1,41 +1,25 @@
 <p align="center">
-  <img alt="Bud" src="https://cdn.roots.io/app/uploads/logo-bud.svg" height="100" />
+  <img src="https://cdn.roots.io/app/uploads/logo-bud.svg" height="100" alt="Bud" />
 </p>
 
 <p align="center">
-  <img
-    alt="MIT License"
-    src="https://img.shields.io/github/license/roots/bud?color=%23525ddc&style=flat-square"
-  />
-  <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Froots%2Fbud?ref=badge_small" alt="FOSSA Status">
-    <img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Froots%2Fbud.svg?type=small"/>
-  </a>
-  <a href="https://www.npmjs.com/package/@roots/bud">
-    <img src="https://img.shields.io/npm/v/@roots/bud.svg?color=%23525ddc&style=flat-square" />
-  </a>
-  <a href="https://codecov.io/gh/roots/bud">
-    <img src="https://codecov.io/gh/roots/bud/branch/next/graph/badge.svg?token=DRJ28OD8XD"/>
-  </a>
-  <a href="https://twitter.com/rootswp">
-    <img
-      alt="Follow Roots"
-      src="https://img.shields.io/twitter/follow/rootswp.svg?color=%23525ddc&style=flat-square"
-    />
-  </a>
+  <img alt="MIT License" src="https://img.shields.io/github/license/roots/bud?color=%23525ddc&style=flat-square" /> <img alt="npm" src="https://img.shields.io/npm/v/@roots/bud.svg?color=%23525ddc&style=flat-square" /> <img alt="Follow Roots" src="https://img.shields.io/twitter/follow/rootswp.svg?color=%23525ddc&style=flat-square" />
 </p>
 
-
 <h1 align="center">
   <strong>@roots/bud-compiler</strong>
 </h1>
 
-> Compilation handler
+<p align="center">
+  Compilation handler
+</p>
+
 ## Installation
 
 Install **@roots/bud-compiler** to your project.
 
 ```shell
-yarn add @roots/bud-compiler
+yarn add @roots/bud-compiler --dev
 ```
 
 ## Documentation
@@ -67,8 +51,4 @@ Help support our open-source development efforts by [becoming a patron](https://
 <a href="https://carrot.com/"><img src="https://cdn.roots.io/app/uploads/carrot.svg" alt="Carrot" width="200" height="150"/></a>
 <a href="https://www.c21redwood.com/"><img src="https://cdn.roots.io/app/uploads/c21redwood.svg" alt="C21 Redwood Realty" width="200" height="150"/></a>
 <a href="https://wordpress.com/"><img src="https://cdn.roots.io/app/uploads/wordpress.svg" alt="WordPress.com" width="200" height="150"/></a>
-<a href="https://icons8.com/"><img src="https://cdn.roots.io/app/uploads/icons8.svg" alt="Icons8" width="200" height="150"/></a>
-<a href="https://www.harnessup.com/"><img src="https://cdn.roots.io/app/uploads/harness-software.svg" alt="Harness Software" width="200" height="150"/></a>
-<a href="https://www.codersclan.com/"><img src="https://cdn.roots.io/app/uploads/coders-clan.svg" alt="Coders Clan" width="200" height="150"/></a>
-<a href="https://generodigital.com/"><img src="https://cdn.roots.io/app/uploads/genero.svg" alt="Genero" width="200" height="150"/></a>
-<a href="https://motto.ca/roots"><img src="https://cdn.roots.io/app/uploads/motto.svg" alt="Motto" width="200" height="150"/></a>
+<a href="https://pantheon.io/"><img src="https://cdn.roots.io/app/uploads/pantheon.svg" alt="Pantheon" width="200" height="150"/></a>

package/lib/cjs/Compiler/compiler.service.js

@@ -0,0 +1,180 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Compiler = void 0;
+const bud_framework_1 = require("@roots/bud-framework");
+const bud_support_1 = require("@roots/bud-support");
+const webpack_1 = require("webpack");
+const budProcess = __importStar(require("./process"));
+const { isFunction } = bud_support_1.lodash;
+/**
+ * Wepback compilation controller class
+ *
+ * @public
+ */
+class Compiler extends bud_framework_1.Service {
+    constructor() {
+        super(...arguments);
+        /**
+         * Compilation stats
+         *
+         * @public
+         */
+        this.stats = {
+            assets: [],
+            errors: [],
+            warnings: [],
+        };
+        /**
+         * Compiler errors
+         */
+        this.errors = [];
+        /**
+         * True if compiler is already instantiated
+         *
+         * @public
+         */
+        this.isCompiled = false;
+        /**
+         * @public
+         */
+        this.config = [];
+    }
+    /**
+     * Initiates compilation
+     *
+     * @returns the compiler instance
+     *
+     * @public
+     * @decorator `@bind`
+     */
+    async compile() {
+        const config = await this.before();
+        const compiler = await this.invoke(config);
+        this.app.timeEnd('bud');
+        return compiler;
+    }
+    /**
+     * @public
+     * @decorator `@bind`
+     */
+    async invoke(config) {
+        config = await this.app.hooks.filterAsync('event.compiler.before', config);
+        this.instance = (0, webpack_1.webpack)(this.app.hooks.filter('config.override', config));
+        this.instance.hooks.done.tap(config.shift().name, async (stats) => {
+            if (this.app.isDevelopment)
+                await this.handleStats(stats);
+        });
+        new webpack_1.ProgressPlugin((...args) => {
+            args[1] = args[1].replace('[0] ', '');
+            const shouldLog = !this.progress ||
+                !this.progress[1] ||
+                (args[1] !== this.progress[1] && args[1] !== '');
+            this.progress = [args[0] * 100, args[1]];
+            this.progress[0] < 100 && shouldLog
+                ? budProcess.logger.await(`[${Math.ceil(this.progress[0])}] `, this.progress[1])
+                : budProcess.logger.success(`[${Math.ceil(this.progress[0])}] `, `🎉 ${this.progress[1]}`);
+        }).apply(this.instance);
+        this.app.hooks.filter('event.compiler.after', this.app);
+        return this.instance;
+    }
+    /**
+     * Returns final webpack configuration
+     *
+     * @public
+     * @decorator `@bind`
+     */
+    async before() {
+        const config = [];
+        this.isCompiled = true;
+        await this.app.build.make();
+        /**
+         * Attempt to use the parent instance in the compilation if there are entries
+         * registered to it or if it has no child instances registered.
+         */
+        if (!this.app.hasChildren) {
+            this.app.info(`using config from parent compiler`);
+            config.push(this.app.build.config);
+            return config;
+        }
+        this.app.warn(`root compiler will not be tapped (child compilers in use)`);
+        /**
+         * If there are {@link Framework.children} instances, iterate through
+         * them and add to `config`
+         */
+        await Promise.all(this.app.children?.getValues().map(async (instance) => {
+            if (!instance.name)
+                return;
+            await instance.build.make();
+            config.push(instance.build.config);
+        }));
+        return config;
+    }
+    async callback(error, stats) {
+        await this.handleErrors(error);
+        await this.handleStats(stats);
+        this.instance.close(err => {
+            err && this.app.error(err);
+            this.app.close();
+        });
+    }
+    async handleStats(stats) {
+        if (!stats?.toJson || !isFunction(stats?.toJson))
+            return;
+        this.stats = stats.toJson(this.app.store.get('build.stats'));
+        budProcess.stats.write(this.stats, this.app.store.get('theme.colors'));
+        await this.app.hooks.filter('event.compiler.stats', async () => this.stats);
+    }
+    async handleErrors(error) {
+        if (!error)
+            return;
+        this.app.isDevelopment &&
+            this.app.server.middleware?.hot?.publish({ error });
+        this.app.error(error);
+    }
+}
+__decorate([
+    bud_support_1.bind,
+    bud_support_1.once
+], Compiler.prototype, "compile", null);
+__decorate([
+    bud_support_1.bind
+], Compiler.prototype, "invoke", null);
+__decorate([
+    bud_support_1.bind,
+    bud_support_1.once
+], Compiler.prototype, "before", null);
+__decorate([
+    bud_support_1.bind
+], Compiler.prototype, "callback", null);
+__decorate([
+    bud_support_1.bind
+], Compiler.prototype, "handleStats", null);
+__decorate([
+    bud_support_1.bind
+], Compiler.prototype, "handleErrors", null);
+exports.Compiler = Compiler;

package/lib/cjs/Compiler/process/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.stats = void 0;
+const stats = __importStar(require("./stats"));
+exports.stats = stats;
+var logger_1 = require("./logger");
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });

package/lib/cjs/Compiler/process/logger.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const bud_support_1 = require("@roots/bud-support");
+exports.logger = new bud_support_1.Signale({
+    interactive: true,
+}).scope('bud compilation');

package/lib/cjs/Compiler/process/stats.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.write = void 0;
+const bud_support_1 = require("@roots/bud-support");
+function makeTable(data) {
+    return bud_support_1.table.table(data, {
+        border: bud_support_1.table.getBorderCharacters('void'),
+        columnDefault: {
+            alignment: 'left',
+            paddingLeft: 2,
+            paddingRight: 2,
+        },
+        columns: [
+            { alignment: 'left' },
+            { alignment: 'center' },
+            { alignment: 'center' },
+            { alignment: 'right' },
+        ],
+    });
+}
+function write(stats, colors) {
+    const compilers = stats.children?.map(compilation => {
+        if (!compilation?.entrypoints)
+            return compilation;
+        const errors = compilation.errors?.map(error => {
+            return (0, bud_support_1.boxen)(`\n${error.message}`, {
+                title: `${error.title ?? 'error'}`,
+                margin: {
+                    top: 0,
+                    bottom: 1,
+                    left: 0,
+                    right: 0,
+                },
+                padding: {
+                    top: 0,
+                    bottom: 0,
+                    right: 0,
+                    left: 0,
+                },
+                borderColor: colors.error,
+            });
+        });
+        const warnings = compilation.warnings?.map(warning => {
+            return (0, bud_support_1.boxen)(`\n${warning.message}`, {
+                title: `${warning.title ?? 'warning'}`,
+                margin: {
+                    top: 0,
+                    bottom: 1,
+                    left: 0,
+                    right: 0,
+                },
+                padding: {
+                    top: 0,
+                    bottom: 0,
+                    right: 0,
+                    left: 0,
+                },
+                borderColor: colors.warning,
+            });
+        });
+        const assets = (0, bud_support_1.boxen)(makeTable([
+            [' name', 'cached', 'hot', 'size'].map(i => bud_support_1.chalk.bold.hex(colors.flavor)(i)),
+            ...compilation.assets
+                ?.filter(({ emitted }) => emitted)
+                .map(asset => [
+                bud_support_1.chalk.hex(asset.info.error
+                    ? colors.error
+                    : asset.info.warn
+                        ? colors.warning
+                        : '#FFFFFF')(` ${asset.name}`),
+                asset.cached
+                    ? bud_support_1.chalk.hex(colors.success)('✔')
+                    : bud_support_1.chalk.hex(colors.faded)('✘'),
+                asset.info.hotModuleReplacement
+                    ? bud_support_1.chalk.hex(colors.success)('✔')
+                    : bud_support_1.chalk.hex(colors.faded)('✘'),
+                bud_support_1.humanReadable.sizeFormatter()(asset.info.size),
+            ]),
+        ]), {
+            title: `assets`,
+            margin: {
+                top: 1,
+                bottom: 1,
+                left: 0,
+                right: 0,
+            },
+            padding: {
+                left: 0,
+                top: 1,
+                right: 0,
+                bottom: 0,
+            },
+            borderColor: colors.accent,
+        });
+        return {
+            ...compilation,
+            boxes: [
+                compilation.errorsCount ? errors.join('\n') : null,
+                compilation.warningsCount ? warnings.join('\n') : null,
+                compilation.assets.filter(({ emitted }) => emitted).length
+                    ? assets
+                    : null,
+            ].filter(Boolean),
+        };
+    });
+    const out = compilers?.map(compiler => compiler.boxes.join(''));
+    // eslint-disable-next-line no-console
+    console.log(out.join(''));
+}
+exports.write = write;

package/lib/cjs/index.js

@@ -10,8 +10,7 @@ exports.Compiler = void 0;
  * @see https://roots.io/bud
  * @see https://github.com/roots/bud
  *
- * @core @packageDocumentation @betaDocumentation
+ *  @packageDocumentation
  */
-var Compiler_1 = require("./Compiler");
-Object.defineProperty(exports, "Compiler", { enumerable: true, get: function () { return Compiler_1.Compiler; } });
-//# sourceMappingURL=index.js.map
+var compiler_service_1 = require("./Compiler/compiler.service");
+Object.defineProperty(exports, "Compiler", { enumerable: true, get: function () { return compiler_service_1.Compiler; } });