@roots/bud-compiler 2023.7.20-622 → 2023.7.23-80

package/lib/service.d.ts

@@ -3,7 +3,7 @@ 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 BudErrorClass } from '@roots/bud-support/errors';
+import { BudError } from '@roots/bud-support/errors';
 import webpack from '@roots/bud-support/webpack';
 /**
  * {@link BudCompiler} implementation
@@ -36,7 +36,7 @@ export declare class Compiler extends Service implements BudCompiler {
     /**
      * {@link BudCompiler.onError}
      */
-    onError(error: BudErrorClass | webpack.WebpackError): void;
+    onError(error: BudError | webpack.WebpackError): void;
     /**
      * {@link BudCompiler.onStats}
      */

package/lib/service.js

@@ -9,6 +9,8 @@ import { bind } from '@roots/bud-support/decorators/bind';
 import { BudError } from '@roots/bud-support/errors';
 import { duration } from '@roots/bud-support/human-readable';
 import { render } from '@roots/bud-support/ink';
+import isNull from '@roots/bud-support/lodash/isNull';
+import isString from '@roots/bud-support/lodash/isString';
 import stripAnsi from '@roots/bud-support/strip-ansi';
 import webpack from '@roots/bud-support/webpack';
 /**
@@ -41,13 +43,10 @@ export class Compiler extends Service {
     async compile(bud) {
         this.config = !bud.hasChildren
             ? [await bud.build.make()]
-            : await Promise.all(Object.values(bud.children).map(async (child) => await child.build.make().catch(error => {
+            : await Promise.all(Object.values(bud.children).map(async (child) => child.build.make().catch(error => {
                 throw error;
             })));
-        const cores = Math.max(cpus().length, 1);
-        const compilations = Math.max(Object.keys(bud.children ?? []).length, 1);
-        const parallelism = Math.max(Math.floor(cores / compilations), 1);
-        this.config.parallelism = parallelism;
+        this.config.parallelism = Math.max(cpus().length - 1, 1);
         this.logger.info(`parallel compilations: ${this.config.parallelism}`);
         await bud.hooks.fire(`compiler.before`, bud).catch(error => {
             throw error;
@@ -58,7 +57,7 @@ export class Compiler extends Service {
             this.instance = this.implementation(this.config);
         }
         catch (error) {
-            throw BudError.normalize(error);
+            this.onError(error);
         }
         this.instance.hooks.done.tap(bud.label, (stats) => {
             this.onStats(stats);
@@ -73,6 +72,8 @@ export class Compiler extends Service {
      */
     onError(error) {
         process.exitCode = 1;
+        if (!error)
+            return;
         this.app.server?.appliedMiddleware?.hot?.publish({ error });
         this.app.notifier?.notify({
             group: this.app.label,
@@ -157,27 +158,38 @@ export class Compiler extends Service {
         if (!errors || !errors.length)
             return [];
         try {
-            const parseError = (error) => {
+            return errors
+                ?.map((error) => {
                 let file;
-                const moduleIdent = error.moduleId ?? error.moduleName;
+                let module;
+                const ident = error.moduleId ?? error.moduleName;
                 /**
                  * In a perfect world webpack plugins would use the
                  * `nameForCondition` property to identify the module.
                  */
-                let module = this.compilationStats.children
-                    .flatMap(child => child?.modules)
-                    .find(module => module?.id === moduleIdent || module?.name === moduleIdent);
+                if (ident) {
+                    module = this.compilationStats.children
+                        .flatMap(child => child?.modules)
+                        .find(module => [module?.id, module?.name].includes(ident));
+                }
                 /**
                  * If the module is not found, we try to parse the error message
                  */
-                if (!moduleIdent) {
-                    const stylelintExtracted = error.message.match(/file:\/\/(.*)\x07(.*)\x1B]8;;/);
-                    if (stylelintExtracted?.[1]) {
-                        module = {
-                            name: stylelintExtracted[2] ?? stylelintExtracted[1],
-                            nameForCondition: stylelintExtracted[1],
-                        };
-                    }
+                if (!ident && error.message?.includes(`[stylelint]`)) {
+                    // try to get the origin of the stylelint error,
+                    // which is contained in the second line of the error message
+                    const unparsedOrigin = error.message?.split(`\n`)?.[1];
+                    // if the origin is not a string or too long, we return the error as-is
+                    if (!isString(unparsedOrigin) || unparsedOrigin.length > 100)
+                        return error;
+                    // extract absolute path and context relative name of module
+                    const styleError = unparsedOrigin.match(/file:\/\/(.*)\x07(.*)\x1B]8;;/);
+                    if (isNull(styleError))
+                        return error;
+                    // get parts of matched error
+                    const [, file, name] = styleError;
+                    // return enriched error
+                    return { ...error, file, name, nameForCondition: file };
                 }
                 /**
                  * If the module is still not found, we return the error as-is
@@ -194,14 +206,13 @@ export class Compiler extends Service {
                 else if (module.name) {
                     file = this.app.path(`@src`, module.name);
                 }
-                return !file
-                    ? { ...error, name: module.name ?? error.name }
-                    : { ...error, file, name: module.name ?? error.name };
-            };
-            return errors?.map(parseError).filter(Boolean);
+                const name = module.name ?? error.name ?? `error`;
+                return { ...error, file, name };
+            })
+                .filter(Boolean);
         }
         catch (error) {
-            this.logger.warn(`error parsing errors`, error);
+            this.logger.warn(`Problem parsing errors. This probably won't break anything but please report it: https://github.com/roots/bud/issues/new`, error);
             return errors;
         }
     }
@@ -245,16 +256,12 @@ const statsOptions = {
         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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-compiler",
-  "version": "2023.7.20-622",
+  "version": "2023.7.23-80",
   "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.20-622",
+    "@roots/bud-api": "2023.7.23-80",
     "@skypack/package-check": "0.2.2",
     "@types/node": "18.16.19",
     "@types/react": "18.2.15"
   },
   "dependencies": {
-    "@roots/bud-dashboard": "2023.7.20-622",
-    "@roots/bud-framework": "2023.7.20-622",
-    "@roots/bud-support": "2023.7.20-622",
+    "@roots/bud-dashboard": "2023.7.23-80",
+    "@roots/bud-framework": "2023.7.23-80",
+    "@roots/bud-support": "2023.7.23-80",
     "react": "18.2.0",
     "tslib": "2.6.0"
   },

package/src/service.tsx

@@ -20,9 +20,11 @@ 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 BudErrorClass} from '@roots/bud-support/errors'
+import {BudError} from '@roots/bud-support/errors'
 import {duration} from '@roots/bud-support/human-readable'
 import {render} from '@roots/bud-support/ink'
+import isNull from '@roots/bud-support/lodash/isNull'
+import isString from '@roots/bud-support/lodash/isString'
 import stripAnsi from '@roots/bud-support/strip-ansi'
 import webpack from '@roots/bud-support/webpack'
 
@@ -63,22 +65,14 @@ export class Compiler extends Service implements BudCompiler {
     this.config = !bud.hasChildren
       ? [await bud.build.make()]
       : await Promise.all(
-          Object.values(bud.children).map(
-            async (child: Bud) =>
-              await child.build.make().catch(error => {
-                throw error
-              }),
+          Object.values(bud.children).map(async (child: Bud) =>
+            child.build.make().catch(error => {
+              throw error
+            }),
           ),
         )
 
-    const cores = Math.max(cpus().length, 1)
-    const compilations = Math.max(
-      Object.keys(bud.children ?? []).length,
-      1,
-    )
-    const parallelism = Math.max(Math.floor(cores / compilations), 1)
-
-    this.config.parallelism = parallelism
+    this.config.parallelism = Math.max(cpus().length - 1, 1)
     this.logger.info(`parallel compilations: ${this.config.parallelism}`)
 
     await bud.hooks.fire(`compiler.before`, bud).catch(error => {
@@ -91,12 +85,11 @@ export class Compiler extends Service implements BudCompiler {
     try {
       this.instance = this.implementation(this.config)
     } catch (error) {
-      throw BudError.normalize(error)
+      this.onError(error)
     }
 
     this.instance.hooks.done.tap(bud.label, (stats: any) => {
       this.onStats(stats)
-
       bud.hooks.fire(`compiler.done`, bud, this.stats).catch(error => {
         throw error
       })
@@ -109,8 +102,9 @@ export class Compiler extends Service implements BudCompiler {
    * {@link BudCompiler.onError}
    */
   @bind
-  public onError(error: BudErrorClass | webpack.WebpackError) {
+  public onError(error: BudError | webpack.WebpackError) {
     process.exitCode = 1
+    if (!error) return
 
     this.app.server?.appliedMiddleware?.hot?.publish({error})
 
@@ -217,63 +211,71 @@ export class Compiler extends Service implements BudCompiler {
     if (!errors || !errors.length) return []
 
     try {
-      const parseError = (
-        error: StatsError,
-      ): ErrorWithSourceFile | StatsError => {
-        let file: SourceFile[`file`] | undefined
-
-        const moduleIdent = error.moduleId ?? error.moduleName
-
-        /**
-         * In a perfect world webpack plugins would use the
-         * `nameForCondition` property to identify the module.
-         */
-        let module = this.compilationStats.children
-          .flatMap(child => child?.modules)
-          .find(
-            module =>
-              module?.id === moduleIdent || module?.name === moduleIdent,
-          )
-
-        /**
-         * If the module is not found, we try to parse the error message
-         */
-        if (!moduleIdent) {
-          const stylelintExtracted = error.message.match(
-            /file:\/\/(.*)\x07(.*)\x1B]8;;/,
-          )
-
-          if (stylelintExtracted?.[1]) {
-            module = {
-              name: stylelintExtracted[2] ?? stylelintExtracted[1],
-              nameForCondition: stylelintExtracted[1],
-            }
+      return errors
+        ?.map((error: StatsError): ErrorWithSourceFile | StatsError => {
+          let file: SourceFile[`file`] | undefined
+          let module: undefined | Webpack.StatsModule
+
+          const ident = error.moduleId ?? error.moduleName
+
+          /**
+           * In a perfect world webpack plugins would use the
+           * `nameForCondition` property to identify the module.
+           */
+          if (ident) {
+            module = this.compilationStats.children
+              .flatMap(child => child?.modules)
+              .find(module => [module?.id, module?.name].includes(ident))
           }
-        }
 
-        /**
-         * If the module is still not found, we return the error as-is
-         */
-        if (!module) return error
-
-        /**
-         * We'll prefer the `nameForCondition` property if it exists,
-         * otherwise we'll use the `name` property.
-         */
-        if (module.nameForCondition) {
-          file = module.nameForCondition
-        } else if (module.name) {
-          file = this.app.path(`@src`, module.name)
-        }
+          /**
+           * If the module is not found, we try to parse the error message
+           */
+          if (!ident && error.message?.includes(`[stylelint]`)) {
+            // try to get the origin of the stylelint error,
+            // which is contained in the second line of the error message
+            const unparsedOrigin = error.message?.split(`\n`)?.[1]
+
+            // if the origin is not a string or too long, we return the error as-is
+            if (!isString(unparsedOrigin) || unparsedOrigin.length > 100)
+              return error
+
+            // extract absolute path and context relative name of module
+            const styleError = unparsedOrigin.match(
+              /file:\/\/(.*)\x07(.*)\x1B]8;;/,
+            )
+            if (isNull(styleError)) return error
+
+            // get parts of matched error
+            const [, file, name] = styleError
+            // return enriched error
+            return {...error, file, name, nameForCondition: file}
+          }
 
-        return !file
-          ? {...error, name: module.name ?? error.name}
-          : {...error, file, name: module.name ?? error.name}
-      }
+          /**
+           * If the module is still not found, we return the error as-is
+           */
+          if (!module) return error
+
+          /**
+           * We'll prefer the `nameForCondition` property if it exists,
+           * otherwise we'll use the `name` property.
+           */
+          if (module.nameForCondition) {
+            file = module.nameForCondition
+          } else if (module.name) {
+            file = this.app.path(`@src`, module.name)
+          }
 
-      return errors?.map(parseError).filter(Boolean)
+          const name = module.name ?? error.name ?? `error`
+          return {...error, file, name}
+        })
+        .filter(Boolean)
     } catch (error) {
-      this.logger.warn(`error parsing errors`, error)
+      this.logger.warn(
+        `Problem parsing errors. This probably won't break anything but please report it: https://github.com/roots/bud/issues/new`,
+        error,
+      )
       return errors
     }
   }
@@ -288,16 +290,12 @@ const statsOptions = {
     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,