@roots/bud-build 6.16.1 → 6.18.0

package/README.md

@@ -109,12 +109,12 @@ However, the amount of effort needed to maintain and develop new features and pr
 <a href="https://wordpress.com/">
 <img src="https://cdn.roots.io/app/uploads/wordpress.svg" alt="WordPress.com" width="200" height="150"/>
 </a>
-<a href="https://pantheon.io/">
-<img src="https://cdn.roots.io/app/uploads/pantheon.svg" alt="Pantheon" width="200" height="150"/>
-</a>
 <a href="https://worksitesafety.ca/careers/">
 <img src="https://cdn.roots.io/app/uploads/worksite-safety.svg" alt="Worksite Safety" width="200" height="150"/>
 </a>
 <a href="https://www.copiadigital.com/">
 <img src="https://cdn.roots.io/app/uploads/copia-digital.svg" alt="Copia Digital" width="200" height="150"/>
 </a>
+<a href="https://www.freave.com/">
+<img src="https://cdn.roots.io/app/uploads/freave.svg" alt="Freave" width="200" height="150"/>
+</a>

package/lib/config/dependencies.js

@@ -1,4 +1,25 @@
+import { ConfigError } from '@roots/bud-support/errors';
 import isUndefined from '@roots/bud-support/lodash/isUndefined';
-export const dependencies = async ({ hooks, root, }) => hooks
-    .filter(`build.dependencies`, [])
-    .filter(label => !isUndefined(root.children[label]));
+export const dependencies = async ({ hooks, label, root, }) => {
+    const dependencies = hooks
+        .filter(`build.dependencies`, [])
+        ?.filter(dependency => {
+        const defined = !isUndefined(root.children?.[dependency]);
+        if (!defined) {
+            throw ConfigError.normalize(`${dependency} is not a registered instance of bud.js.`, {
+                details: root.children
+                    ? `Available instances are: ${Object.values(root.children)
+                        .map(child => child.label)
+                        .join(`, `)}`
+                    : `We would tell you what the available instances are, but there are none registered.`,
+                docs: new URL(`https://bud.js.org/learn/general-use/multi-instance`),
+                instance: label,
+                thrownBy: `@roots/bud-build/config/dependencies`,
+            });
+        }
+        return true;
+    });
+    if (!dependencies || dependencies?.length < 1)
+        return undefined;
+    return dependencies;
+};

package/lib/config/entry.js

@@ -1 +1,9 @@
-export const entry = async ({ hooks }) => hooks.filter(`build.entry`, { main: { import: [`index`] } });
+export const entry = async ({ hooks }) => {
+    const entrypoints = hooks.filter(`build.entry`, {
+        main: { import: [`index`] },
+    });
+    return Object.entries(entrypoints).reduce((acc, [key, value]) => {
+        value.import = [...new Set(value.import)];
+        return { ...acc, [key]: value };
+    }, {});
+};

package/lib/config/infrastructureLogging.js

@@ -3,16 +3,16 @@ export const infrastructureLogging = async (bud) => bud.hooks.filter(`build.infr
     console: bud.hooks.filter(`build.infrastructureLogging.console`, {
         ...console,
         error: (...args) => {
-            logger.scope(bud.label, `webpack`).error(...args);
+            logger.unscope().error(...args);
         },
         info: (...args) => {
-            logger.scope(bud.label, `webpack`).info(...args);
+            logger.unscope().info(...args);
         },
         log: (...args) => {
-            logger.scope(bud.label, `webpack`).log(...args);
+            logger.unscope().log(...args);
         },
         warn: (...args) => {
-            logger.scope(bud.label, `webpack`).info(...args);
+            logger.unscope().info(...args);
         },
     }),
     level: bud.hooks.filter(`build.infrastructureLogging.level`, `log`),

package/lib/config/output/index.js

@@ -21,7 +21,12 @@ export const output = async ({ hooks: { filter }, isProduction, path, relPath, }
      * @see {@link https://medium.com/@kenneth_chau/speeding-up-webpack-typescript-incremental-builds-by-7x-3912ba4c1d15}
      */
     pathinfo: filter(`build.output.pathinfo`, false),
-    publicPath: filter(`build.output.publicPath`, `auto`),
+    publicPath: (() => {
+        const value = filter(`build.output.publicPath`, `auto`);
+        if ([``, `auto`].includes(value))
+            return value;
+        return value.endsWith(`/`) ? value : `${value}/`;
+    })(),
     scriptType: filter(`build.output.scriptType`, undefined),
     uniqueName: filter(`build.output.uniqueName`, `@roots/bud`),
 });

package/lib/item/index.js

@@ -4,6 +4,7 @@ import Registrable from '@roots/bud-build/helpers/registrable';
 import Loader from '@roots/bud-build/loader';
 import { bind } from '@roots/bud-support/decorators/bind';
 import isString from '@roots/bud-support/lodash/isString';
+import logger from '@roots/bud-support/logger';
 /**
  * Item class
  */
@@ -98,7 +99,7 @@ class Item extends Registrable {
             output.ident = this.getIdent();
         }
         if (!output.loader) {
-            this.app.error(`error in ${this.ident}`, `no loader registered`);
+            logger.error(`error in ${this.ident}`, `no loader registered`);
         }
         return Object.entries(output).reduce((output, [key, value]) => ({
             ...(output ?? {}),

package/lib/registry/index.js

@@ -16,7 +16,9 @@ async function register(bud) {
     bud.build.items.precss = bud.isProduction
         ? bud.build.items.minicss
         : bud.build.items.style;
-    Object.entries(rules).map(makeRegister(bud, bud.build.setRule));
+    await Promise.all(Object.entries(rules).map(makeRegister(bud, bud.build.setRule))).catch(e => {
+        throw e;
+    });
 }
 /**
  * Registry factory

package/lib/rule/index.js

@@ -3,6 +3,7 @@ import Registrable from '@roots/bud-build/helpers/registrable';
 import { bind } from '@roots/bud-support/decorators/bind';
 import isFunction from '@roots/bud-support/lodash/isFunction';
 import isString from '@roots/bud-support/lodash/isString';
+import logger from '@roots/bud-support/logger';
 /**
  * RuleSetRule
  */
@@ -206,7 +207,7 @@ class Rule extends Registrable {
                 return a;
             return { ...a, [k]: v };
         }, {});
-        this.app.info(`built rule`, output);
+        logger.info(`built rule`, output);
         return output;
     }
 }

package/lib/rules/svg.inline.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
 import type { Factory } from '@roots/bud-build/registry';
 declare const inlineSvg: Factory;
-declare const dataUrl: (data: Buffer) => string;
+declare const dataUrl: (data: Uint8Array) => string;
 export { dataUrl, inlineSvg as default };

package/lib/service/index.js

@@ -55,22 +55,32 @@ class Build extends Service {
     async make() {
         this.logger.log(`bud.build.make called`);
         await this.app.hooks.fire(`build.before`, this.app);
-        await import(`@roots/bud-build/config`).then(async (records) => await Promise.all(Object.entries(records).map(async ([prop, factory]) => {
-            try {
-                const value = await factory(this.app);
-                if (isUndefined(value))
-                    return;
-                this.config[prop] = value;
-                this.logger.success(`built`, prop);
+        await import(`@roots/bud-build/config`)
+            .then(async (records) => await Promise.all(Object.entries(records).map(async ([prop, factory]) => {
+            const value = await factory(this.app).catch(this.catch);
+            if (isUndefined(value)) {
+                this.logger.success(`omitting:`, prop, `(undefined)`);
+                return;
             }
-            catch (error) {
-                throw error;
-            }
-        })));
-        this.logger.success(`configuration successfully built`);
+            Object.defineProperty(this.config, prop, {
+                configurable: true,
+                enumerable: true,
+                value,
+                writable: true,
+            });
+            this.logger
+                .success(`defined:`, prop, `(${typeof this.config[prop]})`)
+                .info(prop, `info:`, this.config[prop]);
+        })))
+            .catch(this.catch);
+        this.logger.success(`configuration built`);
         this.logger.info(this.config);
-        await this.app.hooks.fire(`build.after`, this.app);
-        return this.config;
+        await this.app.hooks.fire(`build.after`, this.app).catch(this.catch);
+        return Object.entries(this.config).reduce((a, [k, v]) => {
+            if (isUndefined(v))
+                return a;
+            return { ...a, [k]: v };
+        }, {});
     }
     /**
      * {@link BudBuild.makeItem}
@@ -94,6 +104,7 @@ class Build extends Service {
      * {@link BudBuild.setItem}
      */
     setItem(ident, definition) {
+        this.logger.log(`build.setItem`, ident);
         const maybeOptionsCallback = isUndefined(definition)
             ? { ident, loader: ident }
             : definition;
@@ -101,36 +112,41 @@ class Build extends Service {
             ? maybeOptionsCallback(this.makeItem())
             : this.makeItem(maybeOptionsCallback);
         this.items[ident] = item;
-        this.logger.info(`set item`, item);
+        this.logger.info(item);
         return this;
     }
     /**
      * {@link BudBuild.setLoader}
      */
     setLoader(name, definition) {
+        this.logger.log(`build.setLoader`, name);
         const loader = isUndefined(definition)
             ? this.makeLoader(name)
             : definition instanceof Loader
                 ? definition
                 : this.makeLoader(definition);
         this.loaders[name] = loader;
-        this.logger.info(`set loader`, loader);
+        this.logger.info(loader);
         return this;
     }
     /**
      * {@link BudBuild.setRule}
      */
     setRule(name, definition) {
+        this.logger.log(`build.setRule`, name);
         const rule = definition instanceof Rule
             ? definition
             : isFunction(definition)
                 ? definition(this.makeRule())
                 : this.makeRule(definition);
         this.rules[name] = rule;
-        this.logger.info(`set rule`, rule);
+        this.logger.info(rule);
         return this;
     }
 }
+__decorate([
+    bind
+], Build.prototype, "bootstrap", null);
 __decorate([
     bind
 ], Build.prototype, "getItem", null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-build",
-  "version": "6.16.1",
+  "version": "6.18.0",
   "description": "bud.js core module",
   "engines": {
     "node": ">=16"
@@ -169,14 +169,14 @@
   "types": "./lib/index.d.ts",
   "module": "./lib/index.js",
   "devDependencies": {
-    "@roots/bud-api": "6.16.1",
-    "@roots/bud-hooks": "6.16.1",
+    "@roots/bud-api": "6.18.0",
+    "@roots/bud-hooks": "6.18.0",
     "@skypack/package-check": "0.2.2",
-    "@types/node": "18.17.9"
+    "@types/node": "20.9.0"
   },
   "dependencies": {
-    "@roots/bud-framework": "6.16.1",
-    "@roots/bud-support": "6.16.1",
+    "@roots/bud-framework": "6.18.0",
+    "@roots/bud-support": "6.18.0",
     "tslib": "2.6.2"
   },
   "volta": {

package/src/config/dependencies.ts

@@ -1,11 +1,40 @@
 import type {Factory} from '@roots/bud-build/config'
 
+import {ConfigError} from '@roots/bud-support/errors'
 import isUndefined from '@roots/bud-support/lodash/isUndefined'
 
 export const dependencies: Factory<`dependencies`> = async ({
   hooks,
+  label,
   root,
-}) =>
-  hooks
+}) => {
+  const dependencies = hooks
     .filter(`build.dependencies`, [])
-    .filter(label => !isUndefined(root.children[label]))
+    ?.filter(dependency => {
+      const defined = !isUndefined(root.children?.[dependency])
+
+      if (!defined) {
+        throw ConfigError.normalize(
+          `${dependency} is not a registered instance of bud.js.`,
+          {
+            details: root.children
+              ? `Available instances are: ${Object.values(root.children)
+                  .map(child => child.label)
+                  .join(`, `)}`
+              : `We would tell you what the available instances are, but there are none registered.`,
+            docs: new URL(
+              `https://bud.js.org/learn/general-use/multi-instance`,
+            ),
+            instance: label,
+            thrownBy: `@roots/bud-build/config/dependencies`,
+          },
+        )
+      }
+
+      return true
+    })
+
+  if (!dependencies || dependencies?.length < 1) return undefined
+
+  return dependencies
+}

package/src/config/entry.ts

@@ -1,4 +1,12 @@
 import type {Factory} from '@roots/bud-build/config'
 
-export const entry: Factory<`entry`> = async ({hooks}) =>
-  hooks.filter(`build.entry`, {main: {import: [`index`]}})
+export const entry: Factory<`entry`> = async ({hooks}) => {
+  const entrypoints = hooks.filter(`build.entry`, {
+    main: {import: [`index`]},
+  })
+
+  return Object.entries(entrypoints).reduce((acc, [key, value]) => {
+    value.import = [...new Set(value.import)]
+    return {...acc, [key]: value}
+  }, {})
+}

package/src/config/infrastructureLogging.ts

@@ -9,16 +9,16 @@ export const infrastructureLogging: Factory<
     console: bud.hooks.filter(`build.infrastructureLogging.console`, {
       ...console,
       error: (...args: any[]) => {
-        logger.scope(bud.label, `webpack`).error(...args)
+        logger.unscope().error(...args)
       },
       info: (...args: any[]) => {
-        logger.scope(bud.label, `webpack`).info(...args)
+        logger.unscope().info(...args)
       },
       log: (...args: any[]) => {
-        logger.scope(bud.label, `webpack`).log(...args)
+        logger.unscope().log(...args)
       },
       warn: (...args: any[]) => {
-        logger.scope(bud.label, `webpack`).info(...args)
+        logger.unscope().info(...args)
       },
     }),
     level: bud.hooks.filter(`build.infrastructureLogging.level`, `log`),

package/src/config/output/index.ts

@@ -30,7 +30,11 @@ export const output: Factory<`output`> = async ({
      * @see {@link https://medium.com/@kenneth_chau/speeding-up-webpack-typescript-incremental-builds-by-7x-3912ba4c1d15}
      */
     pathinfo: filter(`build.output.pathinfo`, false),
-    publicPath: filter(`build.output.publicPath`, `auto`),
+    publicPath: (() => {
+      const value = filter(`build.output.publicPath`, `auto`)
+      if ([``, `auto`].includes(value)) return value
+      return value.endsWith(`/`) ? value : `${value}/`
+    })(),
     scriptType: filter(`build.output.scriptType`, undefined),
     uniqueName: filter(`build.output.uniqueName`, `@roots/bud`),
   })

package/src/item/index.ts

@@ -7,6 +7,7 @@ import Registrable from '@roots/bud-build/helpers/registrable'
 import Loader from '@roots/bud-build/loader'
 import {bind} from '@roots/bud-support/decorators/bind'
 import isString from '@roots/bud-support/lodash/isString'
+import logger from '@roots/bud-support/logger'
 
 export type ConstructorOptions = Build.Item.ConstructorOptions
 
@@ -139,7 +140,7 @@ class Item extends Registrable implements Build.Item {
     }
 
     if (!output.loader) {
-      this.app.error(`error in ${this.ident}`, `no loader registered`)
+      logger.error(`error in ${this.ident}`, `no loader registered`)
     }
 
     return Object.entries(output).reduce(

package/src/registry/index.ts

@@ -36,7 +36,11 @@ async function register(bud: Bud) {
     ? bud.build.items.minicss
     : bud.build.items.style
 
-  Object.entries(rules).map(makeRegister(bud, bud.build.setRule))
+  await Promise.all(
+    Object.entries(rules).map(makeRegister(bud, bud.build.setRule)),
+  ).catch(e => {
+    throw e
+  })
 }
 
 /**

package/src/rule/index.ts

@@ -11,6 +11,7 @@ import Registrable from '@roots/bud-build/helpers/registrable'
 import {bind} from '@roots/bud-support/decorators/bind'
 import isFunction from '@roots/bud-support/lodash/isFunction'
 import isString from '@roots/bud-support/lodash/isString'
+import logger from '@roots/bud-support/logger'
 
 /**
  * RuleSetRule
@@ -273,7 +274,7 @@ class Rule extends Registrable implements Interface {
       return {...a, [k]: v}
     }, {})
 
-    this.app.info(`built rule`, output)
+    logger.info(`built rule`, output)
 
     return output
   }

package/src/rules/svg.inline.ts

@@ -10,6 +10,6 @@ const inlineSvg: Factory = async ({filter, makeRule, path}) =>
     .setGenerator({dataUrl})
     .setType(`asset/inline`)
 
-const dataUrl = (data: Buffer) => dataUri(data.toString())
+const dataUrl = (data: Uint8Array) => dataUri(data.toString())
 
 export {dataUrl, inlineSvg as default}

package/src/service/index.ts

@@ -1,4 +1,3 @@
-import type {Records} from '@roots/bud-build/config'
 import type {Bud, Build as BudBuild} from '@roots/bud-framework'
 import type {Items, Loaders, Rules} from '@roots/bud-framework'
 import type {Configuration} from '@roots/bud-framework/config'
@@ -44,6 +43,7 @@ class Build extends Service implements BudBuild {
   /**
    * {@link Service.register}
    */
+  @bind
   public override async bootstrap?(app: Bud) {
     this.items = {} as Items
     this.loaders = {} as Loaders
@@ -92,28 +92,41 @@ class Build extends Service implements BudBuild {
     this.logger.log(`bud.build.make called`)
     await this.app.hooks.fire(`build.before`, this.app)
 
-    await import(`@roots/bud-build/config`).then(
-      async (records: Records) =>
-        await Promise.all(
-          Object.entries(records).map(async ([prop, factory]) => {
-            try {
-              const value = await factory(this.app)
-              if (isUndefined(value)) return
-
-              this.config[prop] = value
-              this.logger.success(`built`, prop)
-            } catch (error) {
-              throw error
-            }
-          }),
-        ),
-    )
-
-    this.logger.success(`configuration successfully built`)
+    await import(`@roots/bud-build/config`)
+      .then(
+        async records =>
+          await Promise.all(
+            Object.entries(records).map(async ([prop, factory]) => {
+              const value = await factory(this.app).catch(this.catch)
+              if (isUndefined(value)) {
+                this.logger.success(`omitting:`, prop, `(undefined)`)
+                return
+              }
+
+              Object.defineProperty(this.config, prop, {
+                configurable: true,
+                enumerable: true,
+                value,
+                writable: true,
+              })
+
+              this.logger
+                .success(`defined:`, prop, `(${typeof this.config[prop]})`)
+                .info(prop, `info:`, this.config[prop])
+            }),
+          ),
+      )
+      .catch(this.catch)
+
+    this.logger.success(`configuration built`)
     this.logger.info(this.config)
-    await this.app.hooks.fire(`build.after`, this.app)
 
-    return this.config
+    await this.app.hooks.fire(`build.after`, this.app).catch(this.catch)
+
+    return Object.entries(this.config).reduce((a, [k, v]) => {
+      if (isUndefined(v)) return a
+      return {...a, [k]: v}
+    }, {})
   }
 
   /**
@@ -148,6 +161,7 @@ class Build extends Service implements BudBuild {
     ident: K,
     definition?: ((item: Items[K]) => Items[K]) | Items[K],
   ): this {
+    this.logger.log(`build.setItem`, ident)
     const maybeOptionsCallback = isUndefined(definition)
       ? {ident, loader: ident}
       : definition
@@ -157,7 +171,7 @@ class Build extends Service implements BudBuild {
       : this.makeItem(maybeOptionsCallback)
 
     this.items[ident] = item
-    this.logger.info(`set item`, item)
+    this.logger.info(item)
 
     return this
   }
@@ -170,14 +184,15 @@ class Build extends Service implements BudBuild {
     name: K,
     definition?: any,
   ): this {
+    this.logger.log(`build.setLoader`, name)
     const loader = isUndefined(definition)
       ? this.makeLoader(name)
       : definition instanceof Loader
-      ? definition
-      : this.makeLoader(definition)
+        ? definition
+        : this.makeLoader(definition)
 
     this.loaders[name] = loader
-    this.logger.info(`set loader`, loader)
+    this.logger.info(loader)
 
     return this
   }
@@ -190,15 +205,16 @@ class Build extends Service implements BudBuild {
     name: K,
     definition?: Rule | RuleOptions,
   ): this {
+    this.logger.log(`build.setRule`, name)
     const rule =
       definition instanceof Rule
         ? definition
         : isFunction(definition)
-        ? definition(this.makeRule())
-        : this.makeRule(definition as any)
+          ? definition(this.makeRule())
+          : this.makeRule(definition as any)
 
     this.rules[name] = rule
-    this.logger.info(`set rule`, rule)
+    this.logger.info(rule)
 
     return this
   }