npm - @roots/bud-compiler - Versions diffs - 6.14.3 → 6.15.1 - Mend

@roots/bud-compiler 6.14.3 → 6.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/lib/index.d.ts +1 -1
package/lib/index.js +1 -1
package/lib/{service.d.ts → service/index.d.ts} +5 -6
package/lib/{service.js → service/index.js} +78 -67
package/package.json +13 -9
package/src/index.ts +1 -1
package/src/{service.tsx → service/index.tsx} +108 -65

package/lib/index.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  * @see https://bud.js.org
  * @see https://github.com/roots/bud
  */
-import { Compiler } from './service.js';
+import { default as Compiler } from '@roots/bud-compiler/service';
 declare module '@roots/bud-framework' {
     interface Services {
         compiler: Compiler;

package/lib/index.js CHANGED Viewed

@@ -6,5 +6,5 @@
  * @see https://bud.js.org
  * @see https://github.com/roots/bud
  */
-import { Compiler } from './service.js';
+import { default as Compiler } from '@roots/bud-compiler/service';
 export { Compiler as default };

package/lib/{service.d.ts → service/index.d.ts} RENAMED Viewed

@@ -1,14 +1,12 @@
-import type { Compiler as BudCompiler } from '@roots/bud-framework';
 import type { Bud } from '@roots/bud-framework';
+import type { Compiler as BudCompiler } 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';
 /**
  * {@link BudCompiler} implementation
  */
-export declare class Compiler extends Service implements BudCompiler {
+declare class Compiler extends Service implements BudCompiler {
     /**
      * {@link BudCompiler.compilationStats}
      */
@@ -36,7 +34,7 @@ export declare class Compiler extends Service implements BudCompiler {
     /**
      * {@link BudCompiler.onError}
      */
-    onError(error: BudHandler | webpack.WebpackError): void;
+    onError(error: Error): void;
     /**
      * {@link BudCompiler.onStats}
      */
@@ -45,5 +43,6 @@ export declare class Compiler extends Service implements BudCompiler {
      * {@link Service.register}
      */
     register?(bud: Bud): Promise<any>;
-    sourceErrors?(errors: Array<StatsError>): Array<ErrorWithSourceFile | StatsError>;
+    sourceErrors?(errors: Array<StatsError> | undefined): Array<ErrorWithSourceFile | StatsError>;
 }
+export { Compiler as default };

package/lib/{service.js → service/index.js} RENAMED Viewed

@@ -1,24 +1,21 @@
-import { __decorate, __metadata } from "tslib";
+import { __decorate } from "tslib";
 import { jsx as _jsx } from "react/jsx-runtime";
 import { cpus } from 'node:os';
 import process from 'node:process';
 import { pathToFileURL } from 'node:url';
-import { Error } from '@roots/bud-dashboard/components/error';
+import { Error as DisplayError } 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';
-import { duration } from '@roots/bud-support/human-readable';
 import { render } from '@roots/bud-support/ink';
+import isNull from '@roots/bud-support/lodash/isNull';
+import isNumber from '@roots/bud-support/lodash/isNumber';
+import isString from '@roots/bud-support/lodash/isString';
 import stripAnsi from '@roots/bud-support/strip-ansi';
-import webpack from '@roots/bud-support/webpack';
 /**
  * {@link BudCompiler} implementation
  */
-export class Compiler extends Service {
-    /**
-     * {@link BudCompiler.compilationStats}
-     */
-    compilationStats;
+class Compiler extends Service {
     /**
      * {@link BudCompiler.config}
      */
@@ -27,24 +24,18 @@ export class Compiler extends Service {
      * {@link BudCompiler.implementation}
      */
     implementation;
-    /**
-     * {@link BudCompiler.instance}
-     */
-    instance;
-    /**
-     * {@link BudCompiler.stats}
-     */
-    stats;
     /**
      * {@link BudCompiler.compile}
      */
     async compile(bud) {
-        this.config = !bud.hasChildren
+        const 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;
             })));
-        this.config.parallelism = Math.min(cpus().length - 1, 1);
+        this.config = config?.filter(Boolean);
+        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;
         });
@@ -54,13 +45,12 @@ export class Compiler extends Service {
             this.instance = this.implementation(this.config);
         }
         catch (error) {
-            throw BudError.normalize(error);
+            const normalError = error instanceof Error ? error : BudError.normalize(error);
+            this.onError(normalError);
         }
         this.instance.hooks.done.tap(bud.label, (stats) => {
             this.onStats(stats);
-            bud.hooks.fire(`compiler.done`, bud, this.stats).catch(error => {
-                throw error;
-            });
+            bud.hooks.fire(`compiler.done`, bud, this.stats).catch(this.onError);
         });
         return this.instance;
     }
@@ -69,6 +59,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,
@@ -76,10 +68,10 @@ export class Compiler extends Service {
             subtitle: error.name,
         });
         if (`isBudError` in error) {
-            render(_jsx(Error, { error: error }));
+            render(_jsx(DisplayError, { error: error }));
         }
         else {
-            render(_jsx(Error, { error: BudError.normalize(error) }));
+            render(_jsx(DisplayError, { error: BudError.normalize(error) }));
         }
     }
     /**
@@ -96,10 +88,12 @@ export class Compiler extends Service {
             process.exitCode = 1;
             this.compilationStats.children = this.compilationStats.children?.map(child => ({
                 ...child,
-                errors: this.sourceErrors(child.errors),
+                errors: child.errors && this.sourceErrors
+                    ? this.sourceErrors(child.errors)
+                    : child.errors ?? [],
             }));
             this.compilationStats.children
-                ?.filter(child => child.errorsCount > 0)
+                ?.filter(child => isNumber(child.errorsCount) && child.errorsCount > 0)
                 .forEach(child => {
                 try {
                     const error = child.errors?.shift();
@@ -112,7 +106,7 @@ export class Compiler extends Service {
                         subtitle: error.file ? `Error in ${error.name}` : error.name,
                         title: makeNoticeTitle(child),
                     });
-                    this.app.notifier.openEditor(error.file);
+                    error.file && this.app.notifier.openEditor(error.file);
                 }
                 catch (error) {
                     this.logger.error(error);
@@ -126,13 +120,14 @@ export class Compiler extends Service {
                 this.app.notifier.notify({
                     group: `${this.app.label}-${child.name}`,
                     message: child.modules
-                        ? `${child.modules.length} modules compiled in ${duration(child.time)}`
-                        : `Compiled in ${duration(child.time)}`,
+                        ? `${child.modules.length} modules compiled`
+                        : `Modules compiled successfully`,
                     open: this.app.server?.publicUrl.href,
                     subtitle: `Build successful`,
                     title: makeNoticeTitle(child),
                 });
-                this.app.notifier.openBrowser(this.app.server?.publicUrl.href);
+                this.app.server?.publicUrl.href &&
+                    this.app.notifier.openBrowser(this.app.server?.publicUrl.href);
             }
             catch (error) {
                 this.logger.error(error);
@@ -153,61 +148,79 @@ 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;
-                const module = this.compilationStats.children
-                    .flatMap(child => child?.modules)
-                    .find(module => module?.id === moduleIdent || module?.name === moduleIdent);
+                let module;
+                const ident = error.moduleId ?? error.moduleName;
+                /**
+                 * In a perfect world webpack plugins would use the
+                 * `nameForCondition` property to identify the module.
+                 */
+                if (ident && this.compilationStats?.children) {
+                    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 (!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
+                 */
                 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 !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.app.warn(`error parsing errors`, error);
-            return [];
+            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;
         }
     }
 }
 __decorate([
-    bind,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Function]),
-    __metadata("design:returntype", Promise)
+    bind
 ], Compiler.prototype, "compile", null);
 __decorate([
-    bind,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Object]),
-    __metadata("design:returntype", void 0)
+    bind
 ], Compiler.prototype, "onError", null);
 __decorate([
-    bind,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Function]),
-    __metadata("design:returntype", void 0)
+    bind
 ], Compiler.prototype, "onStats", null);
 __decorate([
-    bind,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Function]),
-    __metadata("design:returntype", Promise)
+    bind
 ], Compiler.prototype, "register", null);
 __decorate([
-    bind,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Array]),
-    __metadata("design:returntype", Array)
+    bind
 ], Compiler.prototype, "sourceErrors", null);
 const statsOptions = {
     all: false,
@@ -221,16 +234,14 @@ const statsOptions = {
         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,
 };
+export { Compiler as default };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-compiler",
-  "version": "6.14.3",
+  "version": "6.15.1",
   "description": "Compilation handler",
   "engines": {
     "node": ">=16"
@@ -49,29 +49,33 @@
   ],
   "type": "module",
   "exports": {
-    ".": "./lib/index.js"
+    ".": "./lib/index.js",
+    "./service": "./lib/service/index.js"
   },
   "typesVersions": {
     "*": {
       ".": [
         "./lib/index.d.ts"
+      ],
+      "service": [
+        "./lib/service/index.d.ts"
       ]
     }
   },
   "types": "./lib/index.d.ts",
   "module": "./lib/index.js",
   "devDependencies": {
-    "@roots/bud-api": "6.14.3",
+    "@roots/bud-api": "6.15.1",
     "@skypack/package-check": "0.2.2",
-    "@types/node": "18.16.18",
-    "@types/react": "18.2.14"
+    "@types/node": "18.17.5",
+    "@types/react": "18.2.20"
   },
   "dependencies": {
-    "@roots/bud-dashboard": "6.14.3",
-    "@roots/bud-framework": "6.14.3",
-    "@roots/bud-support": "6.14.3",
+    "@roots/bud-dashboard": "6.15.1",
+    "@roots/bud-framework": "6.15.1",
+    "@roots/bud-support": "6.15.1",
     "react": "18.2.0",
-    "tslib": "2.6.0"
+    "tslib": "2.6.1"
   },
   "volta": {
     "extends": "../../../package.json"

package/src/index.ts CHANGED Viewed

@@ -8,7 +8,7 @@
  * @see https://github.com/roots/bud
  */
-import {Compiler} from './service.js'
+import {default as Compiler} from '@roots/bud-compiler/service'
 declare module '@roots/bud-framework' {
   interface Services {

package/src/{service.tsx → service/index.tsx} RENAMED Viewed

@@ -1,5 +1,5 @@
-import type {Compiler as BudCompiler} from '@roots/bud-framework'
 import type {Bud} from '@roots/bud-framework'
+import type {Compiler as BudCompiler} from '@roots/bud-framework'
 import type {
   MultiCompiler,
   MultiStats,
@@ -17,23 +17,24 @@ import {cpus} from 'node:os'
 import process from 'node:process'
 import {pathToFileURL} from 'node:url'
-import {Error} from '@roots/bud-dashboard/components/error'
+import {Error as DisplayError} 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'
-import {duration} from '@roots/bud-support/human-readable'
+import {BudError} from '@roots/bud-support/errors'
 import {render} from '@roots/bud-support/ink'
+import isNull from '@roots/bud-support/lodash/isNull'
+import isNumber from '@roots/bud-support/lodash/isNumber'
+import isString from '@roots/bud-support/lodash/isString'
 import stripAnsi from '@roots/bud-support/strip-ansi'
-import webpack from '@roots/bud-support/webpack'
 /**
  * {@link BudCompiler} implementation
  */
-export class Compiler extends Service implements BudCompiler {
+class Compiler extends Service implements BudCompiler {
   /**
    * {@link BudCompiler.compilationStats}
    */
-  public compilationStats: BudCompiler[`compilationStats`]
+  public declare compilationStats: BudCompiler[`compilationStats`]
   /**
    * {@link BudCompiler.config}
@@ -48,29 +49,32 @@ export class Compiler extends Service implements BudCompiler {
   /**
    * {@link BudCompiler.instance}
    */
-  public instance: BudCompiler[`instance`]
+  public declare instance: BudCompiler[`instance`]
   /**
    * {@link BudCompiler.stats}
    */
-  public stats: BudCompiler[`stats`]
+  public declare stats: BudCompiler[`stats`]
   /**
    * {@link BudCompiler.compile}
    */
   @bind
   public async compile(bud: Bud): Promise<MultiCompiler> {
-    this.config = !bud.hasChildren
+    const 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
+            }),
           ),
         )
-    this.config.parallelism = Math.min(cpus().length - 1, 1)
+    this.config = config?.filter(Boolean)
+    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
@@ -81,16 +85,15 @@ export class Compiler extends Service implements BudCompiler {
     try {
       this.instance = this.implementation(this.config)
-    } catch (error) {
-      throw BudError.normalize(error)
+    } catch (error: unknown) {
+      const normalError =
+        error instanceof Error ? error : BudError.normalize(error)
+      this.onError(normalError)
     }
     this.instance.hooks.done.tap(bud.label, (stats: any) => {
       this.onStats(stats)
-      bud.hooks.fire(`compiler.done`, bud, this.stats).catch(error => {
-        throw error
-      })
+      bud.hooks.fire(`compiler.done`, bud, this.stats).catch(this.onError)
     })
     return this.instance
@@ -100,8 +103,9 @@ export class Compiler extends Service implements BudCompiler {
    * {@link BudCompiler.onError}
    */
   @bind
-  public onError(error: BudHandler | webpack.WebpackError) {
+  public onError(error: Error) {
     process.exitCode = 1
+    if (!error) return
     this.app.server?.appliedMiddleware?.hot?.publish({error})
@@ -112,9 +116,9 @@ export class Compiler extends Service implements BudCompiler {
     })
     if (`isBudError` in error) {
-      render(<Error error={error} />)
+      render(<DisplayError error={error} />)
     } else {
-      render(<Error error={BudError.normalize(error)} />)
+      render(<DisplayError error={BudError.normalize(error)} />)
     }
   }
@@ -140,12 +144,17 @@ export class Compiler extends Service implements BudCompiler {
       this.compilationStats.children = this.compilationStats.children?.map(
         child => ({
           ...child,
-          errors: this.sourceErrors(child.errors),
+          errors:
+            child.errors && this.sourceErrors
+              ? this.sourceErrors(child.errors)
+              : child.errors ?? [],
         }),
       )
       this.compilationStats.children
-        ?.filter(child => child.errorsCount > 0)
+        ?.filter(
+          child => isNumber(child.errorsCount) && child.errorsCount > 0,
+        )
         .forEach(child => {
           try {
             const error = child.errors?.shift()
@@ -158,7 +167,8 @@ export class Compiler extends Service implements BudCompiler {
               subtitle: error.file ? `Error in ${error.name}` : error.name,
               title: makeNoticeTitle(child),
             })
-            this.app.notifier.openEditor(error.file)
+            error.file && this.app.notifier.openEditor(error.file)
           } catch (error) {
             this.logger.error(error)
           }
@@ -172,16 +182,15 @@ export class Compiler extends Service implements BudCompiler {
           this.app.notifier.notify({
             group: `${this.app.label}-${child.name}`,
             message: child.modules
-              ? `${child.modules.length} modules compiled in ${duration(
-                  child.time,
-                )}`
-              : `Compiled in ${duration(child.time)}`,
+              ? `${child.modules.length} modules compiled`
+              : `Modules compiled successfully`,
             open: this.app.server?.publicUrl.href,
             subtitle: `Build successful`,
             title: makeNoticeTitle(child),
           })
-          this.app.notifier.openBrowser(this.app.server?.publicUrl.href)
+          this.app.server?.publicUrl.href &&
+            this.app.notifier.openBrowser(this.app.server?.publicUrl.href)
         } catch (error) {
           this.logger.error(error)
         }
@@ -202,42 +211,77 @@ export class Compiler extends Service implements BudCompiler {
   @bind
   public sourceErrors?(
-    errors: Array<StatsError>,
+    errors: Array<StatsError> | undefined,
   ): Array<ErrorWithSourceFile | StatsError> {
     if (!errors || !errors.length) return []
     try {
-      const parseError = (
-        error: StatsError,
-      ): ErrorWithSourceFile | StatsError => {
-        let file: SourceFile[`file`] | undefined
-        const moduleIdent = error.moduleId ?? error.moduleName
-        const module = this.compilationStats.children
-          .flatMap(child => child?.modules)
-          .find(
-            module =>
-              module?.id === moduleIdent || module?.name === moduleIdent,
-          )
-        if (!module) return error
-        if (module.nameForCondition) {
-          file = module.nameForCondition
-        } else if (module.name) {
-          file = this.app.path(`@src`, module.name)
-        }
+      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 && this.compilationStats?.children) {
+            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 (!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.app.warn(`error parsing errors`, error)
-      return []
+      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
     }
   }
 }
@@ -254,16 +298,15 @@ const statsOptions = {
     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,
 }
+export {Compiler as default}