@roots/bud-compiler 6.12.3 → 6.13.1

package/lib/compiler.service.d.ts

@@ -1,12 +1,16 @@
-import { Service } from '@roots/bud-framework/service';
+import type { MultiCompiler, MultiStats, StatsError } from '@roots/bud-framework/config';
 import type { Compiler as Contract } from '@roots/bud-framework/services';
 import type { ErrorWithSourceFile } from '@roots/bud-support/open';
-import type webpack from '@roots/bud-support/webpack';
-import type { MultiCompiler, MultiStats, StatsError } from '@roots/bud-support/webpack';
+import { Service } from '@roots/bud-framework/service';
+import webpack from 'webpack';
 /**
  * Wepback compilation controller class
  */
 export declare class Compiler extends Service implements Contract.Service {
+    /**
+     * Configuration
+     */
+    config: Contract.Service[`config`];
     /**
      * Compiler implementation
      */
@@ -19,22 +23,18 @@ export declare class Compiler extends Service implements Contract.Service {
      * Compilation stats
      */
     stats: Contract.Service[`stats`];
-    /**
-     * Configuration
-     */
-    config: Contract.Service[`config`];
     /**
      * Initiates compilation
      */
     compile(): Promise<MultiCompiler>;
-    /**
-     * Stats handler
-     */
-    onStats(stats: MultiStats): Promise<void>;
     /**
      * Compiler error event
      */
     onError(error: Error): Promise<void>;
+    /**
+     * Stats handler
+     */
+    onStats(stats: MultiStats): Promise<void>;
     /**
      * Parse errors from webpack stats
      */

package/lib/compiler.service.js

@@ -1,24 +1,34 @@
 import { __decorate, __metadata } from "tslib";
 import { jsx as _jsx } from "react/jsx-runtime";
-import { pathToFileURL } from 'node:url';
 import * as App from '@roots/bud-dashboard/app';
 import { Service } from '@roots/bud-framework/service';
 import { bind } from '@roots/bud-support/decorators/bind';
 import { BudError, CompilerError } from '@roots/bud-support/errors';
 import { duration } from '@roots/bud-support/human-readable';
+import * as Ink from '@roots/bud-support/ink';
 import stripAnsi from '@roots/bud-support/strip-ansi';
-import * as Ink from 'ink';
+import { pathToFileURL } from 'node:url';
+import webpack from 'webpack';
 /**
  * Wepback compilation controller class
  */
 export class Compiler extends Service {
-    constructor() {
-        super(...arguments);
-        /**
-         * Configuration
-         */
-        this.config = [];
-    }
+    /**
+     * Configuration
+     */
+    config = [];
+    /**
+     * Compiler implementation
+     */
+    implementation;
+    /**
+     * Compiler instance
+     */
+    instance;
+    /**
+     * Compilation stats
+     */
+    stats;
     /**
      * Initiates compilation
      */
@@ -37,11 +47,6 @@ export class Compiler extends Service {
                 }
             }));
         await this.app.hooks.fire(`compiler.before`, this.app);
-        if (this.app.isCLI() && this.app.context.args.dry) {
-            this.logger.timeEnd(`initialize`);
-            this.logger.log(`running in dry mode. exiting early.`);
-            return;
-        }
         this.logger.timeEnd(`initialize`);
         this.logger.await(`compilation`);
         this.instance = this.implementation(this.config);
@@ -52,6 +57,39 @@ export class Compiler extends Service {
         await this.app.hooks.fire(`compiler.after`, this.app);
         return this.instance;
     }
+    /**
+     * Compiler error event
+     */
+    async onError(error) {
+        process.exitCode = 1;
+        await this.app.hooks.fire(`compiler.error`, error);
+        this.app.isDevelopment &&
+            this.app.server.appliedMiddleware?.hot?.publish({ error });
+        try {
+            this.app.notifier.notify({
+                group: this.app.label,
+                message: error.message,
+                subtitle: error.name,
+            });
+        }
+        catch (error) {
+            this.logger.error(error);
+        }
+        try {
+            Ink.render(_jsx(App.Error, { error: new CompilerError(error.message, {
+                    props: {
+                        details: `This error was thrown by the webpack compiler itself. It is not the same as a syntax error. It is likely a missing or unresolvable build dependency.`,
+                        docs: new URL(`https://bud.js.org/`),
+                        issues: new URL(`https://github.com/roots/bud/search?q=is:issue+"compiler" in:title`),
+                        stack: error.stack,
+                        thrownBy: `webpack`,
+                    },
+                }) }));
+        }
+        catch (error) {
+            throw BudError.normalize(error);
+        }
+    }
     /**
      * Stats handler
      */
@@ -76,11 +114,11 @@ export class Compiler extends Service {
                     if (!error)
                         return;
                     this.app.notifier.notify({
-                        title: makeNoticeTitle(child),
-                        subtitle: error.file ? `Error in ${error.name}` : error.name,
+                        group: `${this.app.label}-${child.name}`,
                         message: stripAnsi(error.message),
                         open: error.file ? pathToFileURL(error.file) : ``,
-                        group: `${this.app.label}-${child.name}`,
+                        subtitle: error.file ? `Error in ${error.name}` : error.name,
+                        title: makeNoticeTitle(child),
                     });
                     this.app.notifier.openEditor(error.file);
                 }
@@ -94,13 +132,13 @@ export class Compiler extends Service {
             .forEach(child => {
             try {
                 this.app.notifier.notify({
-                    title: makeNoticeTitle(child),
-                    subtitle: `Build successful`,
+                    group: `${this.app.label}-${child.name}`,
                     message: child.modules
                         ? `${child.modules.length} modules compiled in ${duration(child.time)}`
                         : `Compiled in ${duration(child.time)}`,
-                    group: `${this.app.label}-${child.name}`,
                     open: this.app.server?.publicUrl.href,
+                    subtitle: `Build successful`,
+                    title: makeNoticeTitle(child),
                 });
                 this.app.notifier.openBrowser(this.app.server?.publicUrl.href);
             }
@@ -110,39 +148,6 @@ export class Compiler extends Service {
         });
         await statsUpdate;
     }
-    /**
-     * Compiler error event
-     */
-    async onError(error) {
-        process.exitCode = 1;
-        await this.app.hooks.fire(`compiler.error`, error);
-        this.app.isDevelopment &&
-            this.app.server.appliedMiddleware?.hot?.publish({ error });
-        try {
-            this.app.notifier.notify({
-                subtitle: error.name,
-                message: error.message,
-                group: this.app.label,
-            });
-        }
-        catch (error) {
-            this.logger.error(error);
-        }
-        try {
-            Ink.render(_jsx(App.Error, { error: new CompilerError(error.message, {
-                    props: {
-                        details: `This error was thrown by the webpack compiler itself. It is not the same as a syntax error. It is likely a missing or unresolvable build dependency.`,
-                        stack: error.stack,
-                        thrownBy: `webpack`,
-                        docs: new URL(`https://bud.js.org/`),
-                        issues: new URL(`https://github.com/roots/bud/search?q=is:issue+"compiler" in:title`),
-                    },
-                }) }));
-        }
-        catch (error) {
-            throw BudError.normalize(error);
-        }
-    }
     /**
      * Parse errors from webpack stats
      */
@@ -167,7 +172,7 @@ export class Compiler extends Service {
                 if (!file) {
                     return error;
                 }
-                return { ...error, name: module.name ?? error.name, file };
+                return { ...error, file, name: module.name ?? error.name };
             };
             return errors?.map(parseError).filter(Boolean);
         }
@@ -186,15 +191,15 @@ __decorate([
 __decorate([
     bind,
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Function]),
+    __metadata("design:paramtypes", [Error]),
     __metadata("design:returntype", Promise)
-], Compiler.prototype, "onStats", null);
+], Compiler.prototype, "onError", null);
 __decorate([
     bind,
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Error]),
+    __metadata("design:paramtypes", [Function]),
     __metadata("design:returntype", Promise)
-], Compiler.prototype, "onError", null);
+], Compiler.prototype, "onStats", null);
 __decorate([
     bind,
     __metadata("design:type", Function),

package/lib/index.d.ts

@@ -6,6 +6,6 @@
  *
  *  @packageDocumentation
  */
-import './types.js';
 import { Compiler } from './compiler.service.js';
+import './types.js';
 export default Compiler;

package/lib/index.js

@@ -8,6 +8,6 @@
  *
  *  @packageDocumentation
  */
-import './types.js';
 import { Compiler } from './compiler.service.js';
+import './types.js';
 export default Compiler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-compiler",
-  "version": "6.12.3",
+  "version": "6.13.1",
   "description": "Compilation handler",
   "engines": {
     "node": ">=16"
@@ -71,19 +71,18 @@
   "types": "./lib/index.d.ts",
   "module": "./lib/index.js",
   "devDependencies": {
-    "@roots/bud-api": "6.12.3",
+    "@roots/bud-api": "6.13.1",
     "@skypack/package-check": "0.2.2",
-    "@types/node": "18.16.6",
-    "@types/react": "18.2.6"
+    "@types/node": "18.16.16",
+    "@types/react": "18.2.9"
   },
   "dependencies": {
-    "@roots/bud-dashboard": "6.12.3",
-    "@roots/bud-framework": "6.12.3",
-    "@roots/bud-support": "6.12.3",
-    "ink": "4.2.0",
+    "@roots/bud-dashboard": "6.13.1",
+    "@roots/bud-framework": "6.13.1",
+    "@roots/bud-support": "6.13.1",
     "react": "18.2.0",
-    "tslib": "2.5.0",
-    "webpack": "5.82.0"
+    "tslib": "2.5.3",
+    "webpack": "5.86.0"
   },
   "volta": {
     "extends": "../../../package.json"

package/src/compiler.service.tsx

@@ -1,30 +1,35 @@
-import {pathToFileURL} from 'node:url'
+import type {Bud} from '@roots/bud-framework'
+import type {
+  MultiCompiler,
+  MultiStats,
+  StatsCompilation,
+  StatsError,
+} from '@roots/bud-framework/config'
+import type {Compiler as Contract} from '@roots/bud-framework/services'
+import type {
+  ErrorWithSourceFile,
+  SourceFile,
+} from '@roots/bud-support/open'
 
 import * as App from '@roots/bud-dashboard/app'
-import type {Bud} from '@roots/bud-framework/bud'
 import {Service} from '@roots/bud-framework/service'
-import type {Compiler as Contract} from '@roots/bud-framework/services'
 import {bind} from '@roots/bud-support/decorators/bind'
 import {BudError, CompilerError} from '@roots/bud-support/errors'
 import {duration} from '@roots/bud-support/human-readable'
-import type {
-  ErrorWithSourceFile,
-  SourceFile,
-} from '@roots/bud-support/open'
+import * as Ink from '@roots/bud-support/ink'
 import stripAnsi from '@roots/bud-support/strip-ansi'
-import type webpack from '@roots/bud-support/webpack'
-import type {
-  MultiCompiler,
-  MultiStats,
-  StatsCompilation,
-  StatsError,
-} from '@roots/bud-support/webpack'
-import * as Ink from 'ink'
+import {pathToFileURL} from 'node:url'
+import webpack from 'webpack'
 
 /**
  * Wepback compilation controller class
  */
 export class Compiler extends Service implements Contract.Service {
+  /**
+   * Configuration
+   */
+  public config: Contract.Service[`config`] = []
+
   /**
    * Compiler implementation
    */
@@ -40,11 +45,6 @@ export class Compiler extends Service implements Contract.Service {
    */
   public stats: Contract.Service[`stats`]
 
-  /**
-   * Configuration
-   */
-  public config: Contract.Service[`config`] = []
-
   /**
    * Initiates compilation
    */
@@ -74,13 +74,8 @@ export class Compiler extends Service implements Contract.Service {
 
     await this.app.hooks.fire(`compiler.before`, this.app)
 
-    if (this.app.isCLI() && this.app.context.args.dry) {
-      this.logger.timeEnd(`initialize`)
-      this.logger.log(`running in dry mode. exiting early.`)
-      return
-    }
-
     this.logger.timeEnd(`initialize`)
+
     this.logger.await(`compilation`)
 
     this.instance = this.implementation(this.config)
@@ -94,6 +89,51 @@ export class Compiler extends Service implements Contract.Service {
     return this.instance
   }
 
+  /**
+   * Compiler error event
+   */
+  @bind
+  public async onError(error: Error) {
+    process.exitCode = 1
+
+    await this.app.hooks.fire(`compiler.error`, error)
+
+    this.app.isDevelopment &&
+      this.app.server.appliedMiddleware?.hot?.publish({error})
+
+    try {
+      this.app.notifier.notify({
+        group: this.app.label,
+        message: error.message,
+        subtitle: error.name,
+      })
+    } catch (error) {
+      this.logger.error(error)
+    }
+
+    try {
+      Ink.render(
+        <App.Error
+          error={
+            new CompilerError(error.message, {
+              props: {
+                details: `This error was thrown by the webpack compiler itself. It is not the same as a syntax error. It is likely a missing or unresolvable build dependency.`,
+                docs: new URL(`https://bud.js.org/`),
+                issues: new URL(
+                  `https://github.com/roots/bud/search?q=is:issue+"compiler" in:title`,
+                ),
+                stack: error.stack,
+                thrownBy: `webpack`,
+              },
+            })
+          }
+        />,
+      )
+    } catch (error) {
+      throw BudError.normalize(error)
+    }
+  }
+
   /**
    * Stats handler
    */
@@ -126,11 +166,11 @@ export class Compiler extends Service implements Contract.Service {
             if (!error) return
 
             this.app.notifier.notify({
-              title: makeNoticeTitle(child),
-              subtitle: error.file ? `Error in ${error.name}` : error.name,
+              group: `${this.app.label}-${child.name}`,
               message: stripAnsi(error.message),
               open: error.file ? pathToFileURL(error.file) : ``,
-              group: `${this.app.label}-${child.name}`,
+              subtitle: error.file ? `Error in ${error.name}` : error.name,
+              title: makeNoticeTitle(child),
             })
             this.app.notifier.openEditor(error.file)
           } catch (error) {
@@ -144,15 +184,15 @@ export class Compiler extends Service implements Contract.Service {
       .forEach(child => {
         try {
           this.app.notifier.notify({
-            title: makeNoticeTitle(child),
-            subtitle: `Build successful`,
+            group: `${this.app.label}-${child.name}`,
             message: child.modules
               ? `${child.modules.length} modules compiled in ${duration(
                   child.time,
                 )}`
               : `Compiled in ${duration(child.time)}`,
-            group: `${this.app.label}-${child.name}`,
             open: this.app.server?.publicUrl.href,
+            subtitle: `Build successful`,
+            title: makeNoticeTitle(child),
           })
           this.app.notifier.openBrowser(this.app.server?.publicUrl.href)
         } catch (error) {
@@ -163,51 +203,6 @@ export class Compiler extends Service implements Contract.Service {
     await statsUpdate
   }
 
-  /**
-   * Compiler error event
-   */
-  @bind
-  public async onError(error: Error) {
-    process.exitCode = 1
-
-    await this.app.hooks.fire(`compiler.error`, error)
-
-    this.app.isDevelopment &&
-      this.app.server.appliedMiddleware?.hot?.publish({error})
-
-    try {
-      this.app.notifier.notify({
-        subtitle: error.name,
-        message: error.message,
-        group: this.app.label,
-      })
-    } catch (error) {
-      this.logger.error(error)
-    }
-
-    try {
-      Ink.render(
-        <App.Error
-          error={
-            new CompilerError(error.message, {
-              props: {
-                details: `This error was thrown by the webpack compiler itself. It is not the same as a syntax error. It is likely a missing or unresolvable build dependency.`,
-                stack: error.stack,
-                thrownBy: `webpack`,
-                docs: new URL(`https://bud.js.org/`),
-                issues: new URL(
-                  `https://github.com/roots/bud/search?q=is:issue+"compiler" in:title`,
-                ),
-              },
-            })
-          }
-        />,
-      )
-    } catch (error) {
-      throw BudError.normalize(error)
-    }
-  }
-
   /**
    * Parse errors from webpack stats
    */
@@ -245,7 +240,7 @@ export class Compiler extends Service implements Contract.Service {
           return error
         }
 
-        return {...error, name: module.name ?? error.name, file}
+        return {...error, file, name: module.name ?? error.name}
       }
 
       return errors?.map(parseError).filter(Boolean)

package/src/compiler.test.ts

@@ -1,4 +1,4 @@
-import {Bud, factory} from '@repo/test-kit/bud'
+import {Bud, factory} from '@repo/test-kit'
 import {beforeEach, describe, expect, it, vi} from 'vitest'
 
 import Compiler from './index.js'
@@ -43,14 +43,6 @@ describe(`@roots/bud-compiler`, function () {
     expect(compiler.config).toHaveLength(2)
   })
 
-  it(`should log early exit (--dry)`, async () => {
-    // @ts-ignore
-    bud.context.args.dry = true
-    const logSpy = vi.spyOn(compiler.logger, `log`)
-    await compiler.compile()
-    expect(logSpy).toHaveBeenCalledTimes(3)
-  })
-
   it(`should set done tap`, async () => {
     try {
       await compiler.compile()

package/src/index.ts

@@ -10,8 +10,7 @@
  *  @packageDocumentation
  */
 
-import './types.js'
-
 import {Compiler} from './compiler.service.js'
+import './types.js'
 
 export default Compiler