@roots/bud-compiler 2023.6.15-2014 → 2023.6.23-427

package/lib/index.d.ts

@@ -1,11 +1,13 @@
 /**
- * The bud compiler interface
+ * @roots/bud-compiler
  *
  * @see https://bud.js.org
  * @see https://github.com/roots/bud
- *
- *  @packageDocumentation
  */
-import { Compiler } from './compiler.service.js';
-import './types.js';
-export default Compiler;
+import { Compiler } from './service.js';
+declare module '@roots/bud-framework' {
+    interface Services {
+        compiler: Compiler;
+    }
+}
+export { Compiler as default };

package/lib/index.js

@@ -1,13 +1,10 @@
 // Copyright © Roots Software Foundation LLC
 // Licensed under the MIT license.
 /**
- * The bud compiler interface
+ * @roots/bud-compiler
  *
  * @see https://bud.js.org
  * @see https://github.com/roots/bud
- *
- *  @packageDocumentation
  */
-import { Compiler } from './compiler.service.js';
-import './types.js';
-export default Compiler;
+import { Compiler } from './service.js';
+export { Compiler as default };

package/lib/service.d.ts

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

package/lib/{compiler.service.js → service.js}

@@ -8,11 +8,17 @@ 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
  */
 export class Compiler extends Service {
+    /**
+     * Compilation stats
+     */
+    compilationStats;
     /**
      * Configuration
      */
@@ -25,32 +31,21 @@ export class Compiler extends Service {
      * Compiler instance
      */
     instance;
+    label = `compiler`;
     /**
-     * Compilation stats
+     * Raw stats
      */
     stats;
     /**
      * Initiates compilation
      */
-    async compile() {
-        const compilerPath = await this.app.module
-            .resolve(`webpack`, import.meta.url)
-            .catch(error => {
-            throw BudError.normalize(error);
-        });
-        this.implementation = await this.app.module
-            .import(compilerPath, import.meta.url)
-            .catch(error => {
-            throw BudError.normalize(error);
-        })
-            .finally(() => {
-            this.logger.info(`imported webpack from ${compilerPath}`);
-        });
+    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 => {
                 throw error;
             })));
+        this.config.parallelism = Math.min(cpus().length - 1, 1);
         await this.app.hooks.fire(`compiler.before`, this.app);
         this.logger.timeEnd(`initialize`);
         try {
@@ -62,14 +57,9 @@ export class Compiler extends Service {
         this.instance.hooks.done.tap(this.app.label, async (stats) => {
             await this.onStats(stats);
             await this.app.hooks
-                .fire(`compiler.after`, this.app)
+                .fire(`compiler.done`, [this.app, this.stats])
                 .catch(error => {
-                this.logger.error(error);
-            });
-            await this.app.hooks
-                .fire(`compiler.close`, this.app)
-                .catch(error => {
-                this.logger.error(error);
+                throw error;
             });
         });
         return this.instance;
@@ -78,21 +68,23 @@ export class Compiler extends Service {
      * Compiler error event
      */
     async onError(error) {
-        global.process.exitCode = 1;
+        process.exitCode = 1;
         this.app.isDevelopment &&
             this.app.server.appliedMiddleware?.hot?.publish({ error });
-        // @eslint-disable-next-line no-console
-        render(_jsx(Error, { ...new BudError(error.message, {
-                props: {
-                    error: BudError.normalize(error),
-                },
-            }) }));
-        await this.app.hooks.fire(`compiler.error`, error);
+        await this.app.hooks
+            .fire(`compiler.error`, error)
+            .catch(this.app.error);
         this.app.notifier.notify({
             group: this.app.label,
             message: error.message,
             subtitle: error.name,
         });
+        if (`isBudError` in error) {
+            render(_jsx(Error, { error: error }));
+        }
+        else {
+            render(_jsx(Error, { error: BudError.normalize(error) }));
+        }
     }
     /**
      * Stats handler
@@ -101,16 +93,40 @@ export class Compiler extends Service {
         const makeNoticeTitle = (child) => this.app.label !== child.name
             ? `${this.app.label} (${child.name})`
             : child.name;
-        this.stats = stats.toJson(this.app.hooks.filter(`build.stats`));
-        await this.app.hooks.fire(`compiler.stats`, stats);
-        const statsUpdate = this.app.dashboard.update(stats);
+        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);
         if (stats.hasErrors()) {
             process.exitCode = 1;
-            this.stats.children = this.stats.children?.map(child => ({
+            this.compilationStats.children = this.compilationStats.children?.map(child => ({
                 ...child,
                 errors: this.sourceErrors(child.errors),
             }));
-            this.stats.children
+            this.compilationStats.children
                 ?.filter(child => child.errorsCount > 0)
                 .forEach(child => {
                 try {
@@ -131,7 +147,7 @@ export class Compiler extends Service {
                 }
             });
         }
-        this.stats.children
+        this.compilationStats.children
             ?.filter(child => child.errorsCount === 0)
             .forEach(child => {
             try {
@@ -150,7 +166,16 @@ export class Compiler extends Service {
                 this.logger.error(error);
             }
         });
-        await statsUpdate;
+    }
+    /**
+     * {@link Service.register}
+     */
+    async register(bud) {
+        this.implementation = await this.app.module
+            .import(`webpack`, import.meta.url)
+            .catch(error => {
+            throw BudError.normalize(error);
+        });
     }
     /**
      * Parse errors from webpack stats
@@ -161,9 +186,10 @@ export class Compiler extends Service {
         try {
             const parseError = (error) => {
                 let file;
-                const modules = this.stats.children.flatMap(child => child.modules);
                 const moduleIdent = error.moduleId ?? error.moduleName;
-                const module = modules.find(module => module?.id === moduleIdent || module?.name === moduleIdent);
+                const module = this.compilationStats.children
+                    .flatMap(child => child?.modules)
+                    .find(module => module?.id === moduleIdent || module?.name === moduleIdent);
                 if (!module)
                     return error;
                 if (module.nameForCondition) {
@@ -172,10 +198,9 @@ export class Compiler extends Service {
                 else if (module.name) {
                     file = this.app.path(`@src`, module.name);
                 }
-                if (!file) {
-                    return error;
-                }
-                return { ...error, file, name: module.name ?? error.name };
+                return !file
+                    ? { ...error, name: module.name ?? error.name }
+                    : { ...error, file, name: module.name ?? error.name };
             };
             return errors?.map(parseError).filter(Boolean);
         }
@@ -188,13 +213,13 @@ export class Compiler extends Service {
 __decorate([
     bind,
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
+    __metadata("design:paramtypes", [Function]),
     __metadata("design:returntype", Promise)
 ], Compiler.prototype, "compile", null);
 __decorate([
     bind,
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [webpack.WebpackError]),
+    __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Promise)
 ], Compiler.prototype, "onError", null);
 __decorate([
@@ -203,6 +228,12 @@ __decorate([
     __metadata("design:paramtypes", [Function]),
     __metadata("design:returntype", Promise)
 ], Compiler.prototype, "onStats", null);
+__decorate([
+    bind,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Function]),
+    __metadata("design:returntype", Promise)
+], Compiler.prototype, "register", null);
 __decorate([
     bind,
     __metadata("design:type", Function),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-compiler",
-  "version": "2023.6.15-2014",
+  "version": "2023.6.23-427",
   "description": "Compilation handler",
   "engines": {
     "node": ">=16"
@@ -49,40 +49,29 @@
   ],
   "type": "module",
   "exports": {
-    ".": {
-      "import": "./lib/index.js",
-      "default": "./lib/index.js"
-    },
-    "./types": {
-      "import": "./lib/types.js",
-      "default": "./lib/types.js"
-    }
+    ".": "./lib/index.js"
   },
   "typesVersions": {
     "*": {
       ".": [
         "./lib/index.d.ts"
-      ],
-      "types": [
-        "./lib/types.d.ts"
       ]
     }
   },
   "types": "./lib/index.d.ts",
   "module": "./lib/index.js",
   "devDependencies": {
-    "@roots/bud-api": "2023.6.15-2014",
+    "@roots/bud-api": "2023.6.23-427",
     "@skypack/package-check": "0.2.2",
     "@types/node": "18.16.16",
     "@types/react": "18.2.9"
   },
   "dependencies": {
-    "@roots/bud-dashboard": "2023.6.15-2014",
-    "@roots/bud-framework": "2023.6.15-2014",
-    "@roots/bud-support": "2023.6.15-2014",
+    "@roots/bud-dashboard": "2023.6.23-427",
+    "@roots/bud-framework": "2023.6.23-427",
+    "@roots/bud-support": "2023.6.23-427",
     "react": "18.2.0",
-    "tslib": "2.5.3",
-    "webpack": "5.86.0"
+    "tslib": "2.5.3"
   },
   "volta": {
     "extends": "../../../package.json"

package/src/index.ts

@@ -2,15 +2,18 @@
 // Licensed under the MIT license.
 
 /**
- * The bud compiler interface
+ * @roots/bud-compiler
  *
  * @see https://bud.js.org
  * @see https://github.com/roots/bud
- *
- *  @packageDocumentation
  */
 
-import {Compiler} from './compiler.service.js'
-import './types.js'
+import {Compiler} from './service.js'
+
+declare module '@roots/bud-framework' {
+  interface Services {
+    compiler: Compiler
+  }
+}
 
-export default Compiler
+export {Compiler as default}

package/src/{compiler.service.tsx → service.tsx}

@@ -1,11 +1,13 @@
 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 {Compiler as Contract} from '@roots/bud-framework/services'
 import type {
   ErrorWithSourceFile,
   SourceFile,
@@ -14,21 +16,28 @@ import type {
 import {Error} from '@roots/bud-dashboard/app'
 import {Service} from '@roots/bud-framework/service'
 import {bind} from '@roots/bud-support/decorators/bind'
-import {BudError} from '@roots/bud-support/errors'
+import {BudError, type BudHandler} from '@roots/bud-support/errors'
 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
  */
-export class Compiler extends Service implements Contract.Service {
+export class Compiler extends Service implements BudCompiler {
+  /**
+   * Compilation stats
+   */
+  public compilationStats: StatsCompilation
+
   /**
    * Configuration
    */
-  public config: Contract.Service[`config`] = []
+  public config: Array<Configuration> & {parallelism?: number} = []
 
   /**
    * Compiler implementation
@@ -38,33 +47,20 @@ export class Compiler extends Service implements Contract.Service {
   /**
    * Compiler instance
    */
-  public instance: Contract.Service[`instance`]
+  public instance: BudCompiler[`instance`]
+
+  public label = `compiler`
 
   /**
-   * Compilation stats
+   * Raw stats
    */
-  public stats: Contract.Service[`stats`]
+  public stats: BudCompiler[`stats`]
 
   /**
    * Initiates compilation
    */
   @bind
-  public async compile(): Promise<MultiCompiler> {
-    const compilerPath = await this.app.module
-      .resolve(`webpack`, import.meta.url)
-      .catch(error => {
-        throw BudError.normalize(error)
-      })
-
-    this.implementation = await this.app.module
-      .import(compilerPath, import.meta.url)
-      .catch(error => {
-        throw BudError.normalize(error)
-      })
-      .finally(() => {
-        this.logger.info(`imported webpack from ${compilerPath}`)
-      })
-
+  public async compile(bud: Bud): Promise<MultiCompiler> {
     this.config = !this.app.hasChildren
       ? [await this.app.build.make()]
       : await Promise.all(
@@ -76,6 +72,8 @@ export class Compiler extends Service implements Contract.Service {
           ),
         )
 
+    this.config.parallelism = Math.min(cpus().length - 1, 1)
+
     await this.app.hooks.fire(`compiler.before`, this.app)
 
     this.logger.timeEnd(`initialize`)
@@ -88,16 +86,11 @@ export class Compiler extends Service implements Contract.Service {
 
     this.instance.hooks.done.tap(this.app.label, async (stats: any) => {
       await this.onStats(stats)
-      await this.app.hooks
-        .fire(`compiler.after`, this.app)
-        .catch(error => {
-          this.logger.error(error)
-        })
 
       await this.app.hooks
-        .fire(`compiler.close`, this.app)
+        .fire(`compiler.done`, [this.app, this.stats])
         .catch(error => {
-          this.logger.error(error)
+          throw error
         })
     })
 
@@ -108,57 +101,80 @@ export class Compiler extends Service implements Contract.Service {
    * Compiler error event
    */
   @bind
-  public async onError(error: webpack.WebpackError) {
-    global.process.exitCode = 1
+  public async onError(error: BudHandler | webpack.WebpackError) {
+    process.exitCode = 1
 
     this.app.isDevelopment &&
       this.app.server.appliedMiddleware?.hot?.publish({error})
 
-    // @eslint-disable-next-line no-console
-    render(
-      <Error
-        {...new BudError(error.message, {
-          props: {
-            error: BudError.normalize(error),
-          },
-        })}
-      />,
-    )
-
-    await this.app.hooks.fire(`compiler.error`, error)
+    await this.app.hooks
+      .fire(`compiler.error`, error)
+      .catch(this.app.error)
 
     this.app.notifier.notify({
       group: this.app.label,
       message: error.message,
       subtitle: error.name,
     })
+
+    if (`isBudError` in error) {
+      render(<Error error={error} />)
+    } else {
+      render(<Error error={BudError.normalize(error)} />)
+    }
   }
 
   /**
    * Stats handler
    */
   @bind
-  public async onStats(stats: MultiStats) {
+  public async onStats(stats: Stats & MultiStats) {
     const makeNoticeTitle = (child: StatsCompilation) =>
       this.app.label !== child.name
         ? `${this.app.label} (${child.name})`
         : child.name
 
-    this.stats = stats.toJson(this.app.hooks.filter(`build.stats`))
-
-    await this.app.hooks.fire(`compiler.stats`, stats)
+    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,
+    })
 
-    const statsUpdate = this.app.dashboard.update(stats)
+    this.app.dashboard.update(this.compilationStats)
 
     if (stats.hasErrors()) {
       process.exitCode = 1
 
-      this.stats.children = this.stats.children?.map(child => ({
-        ...child,
-        errors: this.sourceErrors(child.errors),
-      }))
+      this.compilationStats.children = this.compilationStats.children?.map(
+        child => ({
+          ...child,
+          errors: this.sourceErrors(child.errors),
+        }),
+      )
 
-      this.stats.children
+      this.compilationStats.children
         ?.filter(child => child.errorsCount > 0)
         .forEach(child => {
           try {
@@ -179,7 +195,7 @@ export class Compiler extends Service implements Contract.Service {
         })
     }
 
-    this.stats.children
+    this.compilationStats.children
       ?.filter(child => child.errorsCount === 0)
       .forEach(child => {
         try {
@@ -194,13 +210,24 @@ export class Compiler extends Service implements Contract.Service {
             subtitle: `Build successful`,
             title: makeNoticeTitle(child),
           })
+
           this.app.notifier.openBrowser(this.app.server?.publicUrl.href)
         } catch (error) {
           this.logger.error(error)
         }
       })
+  }
 
-    await statsUpdate
+  /**
+   * {@link Service.register}
+   */
+  @bind
+  public override async register(bud: Bud): Promise<any> {
+    this.implementation = await this.app.module
+      .import(`webpack`, import.meta.url)
+      .catch(error => {
+        throw BudError.normalize(error)
+      })
   }
 
   /**
@@ -218,13 +245,14 @@ export class Compiler extends Service implements Contract.Service {
       ): ErrorWithSourceFile | StatsError => {
         let file: SourceFile[`file`] | undefined
 
-        const modules = this.stats.children.flatMap(child => child.modules)
         const moduleIdent = error.moduleId ?? error.moduleName
 
-        const module = modules.find(
-          module =>
-            module?.id === moduleIdent || module?.name === moduleIdent,
-        )
+        const module = this.compilationStats.children
+          .flatMap(child => child?.modules)
+          .find(
+            module =>
+              module?.id === moduleIdent || module?.name === moduleIdent,
+          )
 
         if (!module) return error
 
@@ -234,11 +262,9 @@ export class Compiler extends Service implements Contract.Service {
           file = this.app.path(`@src`, module.name)
         }
 
-        if (!file) {
-          return error
-        }
-
-        return {...error, file, name: module.name ?? error.name}
+        return !file
+          ? {...error, name: module.name ?? error.name}
+          : {...error, file, name: module.name ?? error.name}
       }
 
       return errors?.map(parseError).filter(Boolean)

package/lib/compiler.service.d.ts

@@ -1,42 +0,0 @@
-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 { Service } from '@roots/bud-framework/service';
-import webpack from '@roots/bud-support/webpack';
-/**
- * Wepback compilation controller class
- */
-export declare class Compiler extends Service implements Contract.Service {
-    /**
-     * Configuration
-     */
-    config: Contract.Service[`config`];
-    /**
-     * Compiler implementation
-     */
-    implementation: typeof webpack;
-    /**
-     * Compiler instance
-     */
-    instance: Contract.Service[`instance`];
-    /**
-     * Compilation stats
-     */
-    stats: Contract.Service[`stats`];
-    /**
-     * Initiates compilation
-     */
-    compile(): Promise<MultiCompiler>;
-    /**
-     * Compiler error event
-     */
-    onError(error: webpack.WebpackError): Promise<void>;
-    /**
-     * Stats handler
-     */
-    onStats(stats: MultiStats): Promise<void>;
-    /**
-     * Parse errors from webpack stats
-     */
-    sourceErrors(errors: Array<StatsError>): Array<ErrorWithSourceFile | StatsError>;
-}

package/lib/types.d.ts

@@ -1,4 +0,0 @@
-export {};
-/**
- * @package @roots/bud-compiler
- */

package/lib/types.js

@@ -1,4 +0,0 @@
-export {};
-/**
- * @package @roots/bud-compiler
- */

package/src/compiler.test.ts

@@ -1,67 +0,0 @@
-import {Bud, factory} from '@repo/test-kit'
-import {beforeEach, describe, expect, it, vi} from 'vitest'
-
-import Compiler from './index.js'
-
-describe(`@roots/bud-compiler`, function () {
-  let bud: Bud
-  let compiler: Compiler
-
-  beforeEach(async () => {
-    vi.clearAllMocks()
-
-    bud = await factory({mode: `development`})
-    compiler = new Compiler(() => bud)
-  })
-
-  it(`has compile fn`, () => {
-    expect(compiler.compile).toBeInstanceOf(Function)
-  })
-
-  it(`should call logger.log`, async () => {
-    const logSpy = vi.spyOn(compiler.logger, `log`)
-    await compiler.compile()
-    expect(logSpy).toHaveBeenCalled()
-  })
-
-  it(`should have config with array length 1`, async () => {
-    await compiler.compile()
-    expect(compiler.config).toHaveLength(1)
-  })
-
-  it(`should have config with array length 2 when hasChildren is true`, async () => {
-    // @ts-ignore
-    await bud.make(`foo`)
-    await bud.make(`bar`)
-
-    compiler.app.children = {
-      foo: compiler.app,
-      bar: compiler.app,
-    }
-
-    await compiler.compile()
-    expect(compiler.config).toHaveLength(2)
-  })
-
-  it(`should set done tap`, async () => {
-    try {
-      await compiler.compile()
-      expect(compiler.instance.hooks.done.tap).toHaveBeenCalledWith(
-        `MOCK-dev-handle`,
-        compiler.onStats,
-      )
-    } catch (e) {}
-  })
-
-  it(`has onStats fn`, () => {
-    expect(compiler.onStats).toBeInstanceOf(Function)
-  })
-
-  it(`has error handler`, () => {
-    expect(compiler.onError).toBeInstanceOf(Function)
-  })
-
-  it(`has close handler`, () => {
-    expect(compiler.onError).toBeInstanceOf(Function)
-  })
-})

package/src/types.ts

@@ -1,3 +0,0 @@
-/**
- * @package @roots/bud-compiler
- */