@roots/bud-compiler 2023.7.1-57 → 2023.7.5-148

package/lib/service.d.ts

@@ -1,55 +1,49 @@
-import type { Bud } from '@roots/bud-framework';
 import type { Compiler as BudCompiler } from '@roots/bud-framework';
-import type { Configuration, MultiCompiler, MultiStats, Stats, StatsCompilation, StatsError } from '@roots/bud-framework/config';
+import type { Bud } from '@roots/bud-framework';
+import type { MultiCompiler, MultiStats, Stats, StatsError, Webpack } from '@roots/bud-framework/config';
 import type { ErrorWithSourceFile } from '@roots/bud-support/open';
 import { Service } from '@roots/bud-framework/service';
 import { type BudHandler } from '@roots/bud-support/errors';
 import webpack from '@roots/bud-support/webpack';
 /**
- * Wepback compilation controller class
+ * {@link BudCompiler} implementation
  */
 export declare class Compiler extends Service implements BudCompiler {
     /**
-     * Compilation stats
+     * {@link BudCompiler.compilationStats}
      */
-    compilationStats: StatsCompilation;
+    compilationStats: BudCompiler[`compilationStats`];
     /**
-     * Configuration
+     * {@link BudCompiler.config}
      */
-    config: Array<Configuration> & {
-        parallelism?: number;
-    };
+    config: BudCompiler[`config`];
     /**
-     * Compiler implementation
+     * {@link BudCompiler.implementation}
      */
-    implementation: typeof webpack;
+    implementation: BudCompiler[`implementation`] & typeof Webpack;
     /**
-     * Compiler instance
+     * {@link BudCompiler.instance}
      */
     instance: BudCompiler[`instance`];
-    label: string;
     /**
-     * Raw stats
+     * {@link BudCompiler.stats}
      */
     stats: BudCompiler[`stats`];
     /**
-     * Initiates compilation
+     * {@link BudCompiler.compile}
      */
     compile(bud: Bud): Promise<MultiCompiler>;
     /**
-     * Compiler error event
+     * {@link BudCompiler.onError}
      */
-    onError(error: BudHandler | webpack.WebpackError): Promise<void>;
+    onError(error: BudHandler | webpack.WebpackError): void;
     /**
-     * Stats handler
+     * {@link BudCompiler.onStats}
      */
-    onStats(stats: Stats & MultiStats): Promise<void>;
+    onStats(stats: Stats & MultiStats): void;
     /**
      * {@link Service.register}
      */
-    register(bud: Bud): Promise<any>;
-    /**
-     * Parse errors from webpack stats
-     */
-    sourceErrors(errors: Array<StatsError>): Array<ErrorWithSourceFile | StatsError>;
+    register?(bud: Bud): Promise<any>;
+    sourceErrors?(errors: Array<StatsError>): Array<ErrorWithSourceFile | StatsError>;
 }

package/lib/service.js

@@ -1,6 +1,9 @@
 import { __decorate, __metadata } from "tslib";
 import { jsx as _jsx } from "react/jsx-runtime";
-import { Error } from '@roots/bud-dashboard/app';
+import { cpus } from 'node:os';
+import process from 'node:process';
+import { pathToFileURL } from 'node:url';
+import { Error } from '@roots/bud-dashboard/components/error';
 import { Service } from '@roots/bud-framework/service';
 import { bind } from '@roots/bud-support/decorators/bind';
 import { BudError } from '@roots/bud-support/errors';
@@ -8,73 +11,66 @@ import { duration } from '@roots/bud-support/human-readable';
 import { render } from '@roots/bud-support/ink';
 import stripAnsi from '@roots/bud-support/strip-ansi';
 import webpack from '@roots/bud-support/webpack';
-import { cpus } from 'node:os';
-import process from 'node:process';
-import { pathToFileURL } from 'node:url';
 /**
- * Wepback compilation controller class
+ * {@link BudCompiler} implementation
  */
 export class Compiler extends Service {
     /**
-     * Compilation stats
+     * {@link BudCompiler.compilationStats}
      */
     compilationStats;
     /**
-     * Configuration
+     * {@link BudCompiler.config}
      */
     config = [];
     /**
-     * Compiler implementation
+     * {@link BudCompiler.implementation}
      */
     implementation;
     /**
-     * Compiler instance
+     * {@link BudCompiler.instance}
      */
     instance;
-    label = `compiler`;
     /**
-     * Raw stats
+     * {@link BudCompiler.stats}
      */
     stats;
     /**
-     * Initiates compilation
+     * {@link BudCompiler.compile}
      */
     async compile(bud) {
-        this.config = !this.app.hasChildren
-            ? [await this.app.build.make()]
-            : await Promise.all(Object.values(this.app.children).map(async (child) => await child.build.make().catch(error => {
+        this.config = !bud.hasChildren
+            ? [await bud.build.make()]
+            : await Promise.all(Object.values(bud.children).map(async (child) => await child.build.make().catch(error => {
                 throw error;
             })));
         this.config.parallelism = Math.min(cpus().length - 1, 1);
-        await this.app.hooks.fire(`compiler.before`, this.app);
+        await bud.hooks.fire(`compiler.before`, bud).catch(error => {
+            throw error;
+        });
         this.logger.timeEnd(`initialize`);
+        this.app.dashboard.updateStatus(`compiling`);
         try {
             this.instance = this.implementation(this.config);
         }
         catch (error) {
             throw BudError.normalize(error);
         }
-        this.instance.hooks.done.tap(this.app.label, async (stats) => {
-            await this.onStats(stats);
-            await this.app.hooks
-                .fire(`compiler.done`, this.app, this.stats)
-                .catch(error => {
+        this.instance.hooks.done.tap(bud.label, (stats) => {
+            this.onStats(stats);
+            bud.hooks.fire(`compiler.done`, bud, this.stats).catch(error => {
                 throw error;
             });
         });
         return this.instance;
     }
     /**
-     * Compiler error event
+     * {@link BudCompiler.onError}
      */
-    async onError(error) {
+    onError(error) {
         process.exitCode = 1;
-        this.app.isDevelopment &&
-            this.app.server.appliedMiddleware?.hot?.publish({ error });
-        await this.app.hooks
-            .fire(`compiler.error`, error)
-            .catch(this.app.error);
-        this.app.notifier.notify({
+        this.app.server?.appliedMiddleware?.hot?.publish({ error });
+        this.app.notifier?.notify({
             group: this.app.label,
             message: error.message,
             subtitle: error.name,
@@ -87,39 +83,15 @@ export class Compiler extends Service {
         }
     }
     /**
-     * Stats handler
+     * {@link BudCompiler.onStats}
      */
-    async onStats(stats) {
+    onStats(stats) {
         const makeNoticeTitle = (child) => this.app.label !== child.name
             ? `${this.app.label} (${child.name})`
             : child.name;
         this.stats = stats;
-        this.compilationStats = stats.toJson({
-            all: false,
-            children: {
-                all: false,
-                assets: true,
-                cached: true,
-                cachedAssets: true,
-                cachedModules: true,
-                entrypoints: true,
-                errorDetails: false,
-                errors: true,
-                errorsCount: true,
-                errorStack: false,
-                hash: true,
-                modules: true,
-                name: true,
-                outputPath: true,
-                reasons: this.app.context.debug ? true : false,
-                runtime: true,
-                timings: true,
-                warnings: true,
-                warningsCount: true,
-            },
-            name: true,
-        });
-        this.app.dashboard.update(this.compilationStats);
+        this.compilationStats = stats.toJson(statsOptions);
+        this.app.dashboard.updateStats(this.compilationStats);
         if (stats.hasErrors()) {
             process.exitCode = 1;
             this.compilationStats.children = this.compilationStats.children?.map(child => ({
@@ -171,15 +143,12 @@ export class Compiler extends Service {
      * {@link Service.register}
      */
     async register(bud) {
-        this.implementation = await this.app.module
-            .import(`webpack`, import.meta.url)
+        this.implementation = await bud.module
+            .import(`@roots/bud-support/webpack`, import.meta.url)
             .catch(error => {
             throw BudError.normalize(error);
         });
     }
-    /**
-     * Parse errors from webpack stats
-     */
     sourceErrors(errors) {
         if (!errors || !errors.length)
             return [];
@@ -220,13 +189,13 @@ __decorate([
     bind,
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
-    __metadata("design:returntype", Promise)
+    __metadata("design:returntype", void 0)
 ], Compiler.prototype, "onError", null);
 __decorate([
     bind,
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Function]),
-    __metadata("design:returntype", Promise)
+    __metadata("design:returntype", void 0)
 ], Compiler.prototype, "onStats", null);
 __decorate([
     bind,
@@ -240,3 +209,28 @@ __decorate([
     __metadata("design:paramtypes", [Array]),
     __metadata("design:returntype", Array)
 ], Compiler.prototype, "sourceErrors", null);
+const statsOptions = {
+    all: false,
+    children: {
+        all: false,
+        assets: true,
+        cached: true,
+        cachedAssets: true,
+        cachedModules: true,
+        entrypoints: true,
+        errorDetails: false,
+        errors: true,
+        errorsCount: true,
+        errorStack: false,
+        hash: true,
+        modules: true,
+        name: true,
+        outputPath: true,
+        reasons: false,
+        runtime: true,
+        timings: true,
+        warnings: true,
+        warningsCount: true,
+    },
+    name: true,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-compiler",
-  "version": "2023.7.1-57",
+  "version": "2023.7.5-148",
   "description": "Compilation handler",
   "engines": {
     "node": ">=16"
@@ -61,15 +61,15 @@
   "types": "./lib/index.d.ts",
   "module": "./lib/index.js",
   "devDependencies": {
-    "@roots/bud-api": "2023.7.1-57",
+    "@roots/bud-api": "2023.7.5-148",
     "@skypack/package-check": "0.2.2",
     "@types/node": "18.16.18",
     "@types/react": "18.2.14"
   },
   "dependencies": {
-    "@roots/bud-dashboard": "2023.7.1-57",
-    "@roots/bud-framework": "2023.7.1-57",
-    "@roots/bud-support": "2023.7.1-57",
+    "@roots/bud-dashboard": "2023.7.5-148",
+    "@roots/bud-framework": "2023.7.5-148",
+    "@roots/bud-support": "2023.7.5-148",
     "react": "18.2.0",
     "tslib": "2.6.0"
   },

package/src/service.tsx

@@ -1,19 +1,23 @@
-import type {Bud} from '@roots/bud-framework'
 import type {Compiler as BudCompiler} from '@roots/bud-framework'
+import type {Bud} from '@roots/bud-framework'
 import type {
-  Configuration,
   MultiCompiler,
   MultiStats,
   Stats,
   StatsCompilation,
   StatsError,
+  Webpack,
 } from '@roots/bud-framework/config'
 import type {
   ErrorWithSourceFile,
   SourceFile,
 } from '@roots/bud-support/open'
 
-import {Error} from '@roots/bud-dashboard/app'
+import {cpus} from 'node:os'
+import process from 'node:process'
+import {pathToFileURL} from 'node:url'
+
+import {Error} from '@roots/bud-dashboard/components/error'
 import {Service} from '@roots/bud-framework/service'
 import {bind} from '@roots/bud-support/decorators/bind'
 import {BudError, type BudHandler} from '@roots/bud-support/errors'
@@ -21,62 +25,59 @@ import {duration} from '@roots/bud-support/human-readable'
 import {render} from '@roots/bud-support/ink'
 import stripAnsi from '@roots/bud-support/strip-ansi'
 import webpack from '@roots/bud-support/webpack'
-import {cpus} from 'node:os'
-import process from 'node:process'
-import {pathToFileURL} from 'node:url'
 
 /**
- * Wepback compilation controller class
+ * {@link BudCompiler} implementation
  */
 export class Compiler extends Service implements BudCompiler {
   /**
-   * Compilation stats
+   * {@link BudCompiler.compilationStats}
    */
-  public compilationStats: StatsCompilation
+  public compilationStats: BudCompiler[`compilationStats`]
 
   /**
-   * Configuration
+   * {@link BudCompiler.config}
    */
-  public config: Array<Configuration> & {parallelism?: number} = []
+  public config: BudCompiler[`config`] = []
 
   /**
-   * Compiler implementation
+   * {@link BudCompiler.implementation}
    */
-  public implementation: typeof webpack
+  public implementation: BudCompiler[`implementation`] & typeof Webpack
 
   /**
-   * Compiler instance
+   * {@link BudCompiler.instance}
    */
   public instance: BudCompiler[`instance`]
 
-  public label = `compiler`
-
   /**
-   * Raw stats
+   * {@link BudCompiler.stats}
    */
   public stats: BudCompiler[`stats`]
 
   /**
-   * Initiates compilation
+   * {@link BudCompiler.compile}
    */
   @bind
   public async compile(bud: Bud): Promise<MultiCompiler> {
-    this.config = !this.app.hasChildren
-      ? [await this.app.build.make()]
+    this.config = !bud.hasChildren
+      ? [await bud.build.make()]
       : await Promise.all(
-          Object.values(this.app.children).map(
+          Object.values(bud.children).map(
             async (child: Bud) =>
               await child.build.make().catch(error => {
                 throw error
               }),
           ),
         )
-
     this.config.parallelism = Math.min(cpus().length - 1, 1)
 
-    await this.app.hooks.fire(`compiler.before`, this.app)
+    await bud.hooks.fire(`compiler.before`, bud).catch(error => {
+      throw error
+    })
 
     this.logger.timeEnd(`initialize`)
+    this.app.dashboard.updateStatus(`compiling`)
 
     try {
       this.instance = this.implementation(this.config)
@@ -84,34 +85,27 @@ export class Compiler extends Service implements BudCompiler {
       throw BudError.normalize(error)
     }
 
-    this.instance.hooks.done.tap(this.app.label, async (stats: any) => {
-      await this.onStats(stats)
+    this.instance.hooks.done.tap(bud.label, (stats: any) => {
+      this.onStats(stats)
 
-      await this.app.hooks
-        .fire(`compiler.done`, this.app, this.stats)
-        .catch(error => {
-          throw error
-        })
+      bud.hooks.fire(`compiler.done`, bud, this.stats).catch(error => {
+        throw error
+      })
     })
 
     return this.instance
   }
 
   /**
-   * Compiler error event
+   * {@link BudCompiler.onError}
    */
   @bind
-  public async onError(error: BudHandler | webpack.WebpackError) {
+  public onError(error: BudHandler | webpack.WebpackError) {
     process.exitCode = 1
 
-    this.app.isDevelopment &&
-      this.app.server.appliedMiddleware?.hot?.publish({error})
-
-    await this.app.hooks
-      .fire(`compiler.error`, error)
-      .catch(this.app.error)
+    this.app.server?.appliedMiddleware?.hot?.publish({error})
 
-    this.app.notifier.notify({
+    this.app.notifier?.notify({
       group: this.app.label,
       message: error.message,
       subtitle: error.name,
@@ -125,10 +119,10 @@ export class Compiler extends Service implements BudCompiler {
   }
 
   /**
-   * Stats handler
+   * {@link BudCompiler.onStats}
    */
   @bind
-  public async onStats(stats: Stats & MultiStats) {
+  public onStats(stats: Stats & MultiStats) {
     const makeNoticeTitle = (child: StatsCompilation) =>
       this.app.label !== child.name
         ? `${this.app.label} (${child.name})`
@@ -136,33 +130,9 @@ export class Compiler extends Service implements BudCompiler {
 
     this.stats = stats
 
-    this.compilationStats = stats.toJson({
-      all: false,
-      children: {
-        all: false,
-        assets: true,
-        cached: true,
-        cachedAssets: true,
-        cachedModules: true,
-        entrypoints: true,
-        errorDetails: false,
-        errors: true,
-        errorsCount: true,
-        errorStack: false,
-        hash: true,
-        modules: true,
-        name: true,
-        outputPath: true,
-        reasons: this.app.context.debug ? true : false,
-        runtime: true,
-        timings: true,
-        warnings: true,
-        warningsCount: true,
-      },
-      name: true,
-    })
+    this.compilationStats = stats.toJson(statsOptions)
 
-    this.app.dashboard.update(this.compilationStats)
+    this.app.dashboard.updateStats(this.compilationStats)
 
     if (stats.hasErrors()) {
       process.exitCode = 1
@@ -222,19 +192,16 @@ export class Compiler extends Service implements BudCompiler {
    * {@link Service.register}
    */
   @bind
-  public override async register(bud: Bud): Promise<any> {
-    this.implementation = await this.app.module
-      .import(`webpack`, import.meta.url)
+  public override async register?(bud: Bud): Promise<any> {
+    this.implementation = await bud.module
+      .import(`@roots/bud-support/webpack`, import.meta.url)
       .catch(error => {
         throw BudError.normalize(error)
       })
   }
 
-  /**
-   * Parse errors from webpack stats
-   */
   @bind
-  public sourceErrors(
+  public sourceErrors?(
     errors: Array<StatsError>,
   ): Array<ErrorWithSourceFile | StatsError> {
     if (!errors || !errors.length) return []
@@ -274,3 +241,29 @@ export class Compiler extends Service implements BudCompiler {
     }
   }
 }
+
+const statsOptions = {
+  all: false,
+  children: {
+    all: false,
+    assets: true,
+    cached: true,
+    cachedAssets: true,
+    cachedModules: true,
+    entrypoints: true,
+    errorDetails: false,
+    errors: true,
+    errorsCount: true,
+    errorStack: false,
+    hash: true,
+    modules: true,
+    name: true,
+    outputPath: true,
+    reasons: false,
+    runtime: true,
+    timings: true,
+    warnings: true,
+    warningsCount: true,
+  },
+  name: true,
+}