@roots/bud-build 5.0.0 → 5.3.1

package/lib/cjs/Build/index.js

@@ -1,13 +1,41 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Build = void 0;
-const tslib_1 = require("tslib");
 const bud_framework_1 = require("@roots/bud-framework");
 const bud_support_1 = require("@roots/bud-support");
+const Rule_1 = require("../Rule");
 const config_1 = require("./config");
-const items_1 = (0, tslib_1.__importDefault)(require("./items"));
-const loaders_1 = (0, tslib_1.__importDefault)(require("./loaders"));
-const rules = (0, tslib_1.__importStar)(require("./rules"));
+const items_1 = __importDefault(require("./items"));
+const loaders_1 = __importDefault(require("./loaders"));
+const rules = __importStar(require("./rules"));
 const { isNull, isUndefined } = bud_support_1.lodash;
 const { ensureFile, writeFile } = bud_support_1.fs;
 /**
@@ -22,10 +50,8 @@ class Build extends bud_framework_1.Service {
      * @public
      * @decorator `@bind`
      */
-    registered() {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
-            this.app.hooks.on('event.build.make.after', this.writeFinalConfig);
-        });
+    async registered() {
+        this.app.hooks.on('event.build.make.after', this.writeFinalConfig);
     }
     /**
      * Make webpack configuration
@@ -33,31 +59,28 @@ class Build extends bud_framework_1.Service {
      * @public
      * @decorator `@bind`
      */
-    make() {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
-            yield this.app.hooks.filterAsync('event.build.make.before', this.app);
-            const build = yield this.app.hooks.filterAsync('build');
-            if (!build) {
-                throw new Error('Configuration could not be processed');
+    async make() {
+        await this.app.hooks.filterAsync('event.build.make.before', this.app);
+        const build = await this.app.hooks.filterAsync('build');
+        if (!build) {
+            throw new Error('Configuration could not be processed');
+        }
+        this.config = await this.app.hooks.filterAsync('event.build.override', Object.entries(build).reduce((all, [key, value]) => {
+            if (isUndefined(value) || isNull(value)) {
+                this.log(`warn`, {
+                    message: `build.make: excluding ${key}`,
+                    suffix: `value is undefined`,
+                });
+                return all;
             }
-            this.config =
-                yield this.app.hooks.filterAsync('event.build.override', Object.entries(build).reduce((all, [key, value]) => {
-                    if (isUndefined(value) || isNull(value)) {
-                        this.log(`warn`, {
-                            message: `build.make: excluding ${key}`,
-                            suffix: `value is undefined`,
-                        });
-                        return all;
-                    }
-                    this.app.dump(value, {
-                        prefix: `${bud_support_1.chalk.bgBlue(this.app.name)} config.${key}`,
-                        maxDepth: 2,
-                    });
-                    return Object.assign(Object.assign({}, all), { [key]: value });
-                }, {}));
-            yield this.app.hooks.filterAsync('event.build.make.after', () => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () { return null; }));
-            return this.config;
-        });
+            this.app.dump(value, {
+                prefix: `${bud_support_1.chalk.bgBlue(this.app.name)} config.${key}`,
+                maxDepth: 2,
+            });
+            return { ...all, [key]: value };
+        }, {}));
+        await this.app.hooks.filterAsync('event.build.make.after', async () => null);
+        return this.config;
     }
     /**
      * Service register event
@@ -65,73 +88,93 @@ class Build extends bud_framework_1.Service {
      * @public
      * @decorator `@bind`
      */
-    register() {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
-            const reducer = (a, [k, v]) => (Object.assign(Object.assign({}, a), { [k]: v() }));
-            Object.assign(this, {
-                loaders: this.app
-                    .container(loaders_1.default)
-                    .getEntries()
-                    .reduce(reducer, this.loaders),
-                rules: this.app
-                    .container(rules)
-                    .getEntries()
-                    .reduce(reducer, this.rules),
-                items: this.app
-                    .container(items_1.default)
-                    .getEntries()
-                    .reduce(reducer, this.items),
-            });
-            yield (0, config_1.config)(this.app);
+    async register() {
+        const reducer = (a, [k, v]) => ({
+            ...a,
+            [k]: v(this.app),
+        });
+        Object.assign(this, {
+            loaders: this.app
+                .container(loaders_1.default)
+                .getEntries()
+                .reduce(reducer, this.loaders),
+            rules: this.app
+                .container(rules)
+                .getEntries()
+                .reduce(reducer, this.rules),
+            items: this.app
+                .container(items_1.default)
+                .getEntries()
+                .reduce(reducer, this.items),
         });
+        await (0, config_1.config)(this.app);
     }
     /**
-     * Write final configuration to storage directory
+     * Set a rule
+     *
+     * @param name - rule key
+     * @param constructorProperties - rule constructor properties
+     * @returns the rule
      *
      * @public
      * @decorator `@bind`
      */
-    writeFinalConfig() {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
-            try {
-                const filePath = this.app.path('storage', this.config.name, 'webpack.config.js');
-                this.log('log', {
-                    message: `writing webpack dump to disk`,
-                    suffix: filePath,
-                });
-                yield ensureFile(filePath);
-                yield writeFile(filePath, `module.exports = (${(0, bud_support_1.prettyFormat)(this.config)})`);
-            }
-            catch (error) {
-                this.log('error', `failed to write webpack.config.json`);
-                this.log(`error`, error);
-            }
+    setRule(name, constructorProperties) {
+        Object.assign(this.rules, {
+            [name]: this.makeRule(constructorProperties),
         });
+        return this.rules[name];
     }
     /**
-     * Initialize the build rules, loaders, items
+     * Make a rule
+     *
+     * @param constructorProperties - rule constructor properties
+     * @returns the rule
      *
      * @public
      * @decorator `@bind`
      */
-    init() {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () { });
+    makeRule(constructorProperties) {
+        return new Rule_1.Rule(this.app, constructorProperties);
+    }
+    /**
+     * Write final configuration to storage directory
+     *
+     * @public
+     * @decorator `@bind`
+     */
+    async writeFinalConfig() {
+        try {
+            const filePath = this.app.path('storage', this.config.name, 'webpack.config.js');
+            this.log('log', {
+                message: `writing webpack dump to disk`,
+                suffix: filePath,
+            });
+            await ensureFile(filePath);
+            await writeFile(filePath, `module.exports = (${(0, bud_support_1.prettyFormat)(this.config)})`);
+        }
+        catch (error) {
+            this.log('error', `failed to write webpack.config.json`);
+            this.log(`error`, error);
+        }
     }
 }
-(0, tslib_1.__decorate)([
+__decorate([
     bud_support_1.bind
 ], Build.prototype, "registered", null);
-(0, tslib_1.__decorate)([
+__decorate([
     bud_support_1.bind
 ], Build.prototype, "make", null);
-(0, tslib_1.__decorate)([
+__decorate([
     bud_support_1.bind
 ], Build.prototype, "register", null);
-(0, tslib_1.__decorate)([
+__decorate([
     bud_support_1.bind
-], Build.prototype, "writeFinalConfig", null);
-(0, tslib_1.__decorate)([
+], Build.prototype, "setRule", null);
+__decorate([
     bud_support_1.bind
-], Build.prototype, "init", null);
+], Build.prototype, "makeRule", null);
+__decorate([
+    bud_support_1.bind
+], Build.prototype, "writeFinalConfig", null);
 exports.Build = Build;
-//# sourceMappingURL=index.js.map

package/lib/cjs/Build/items.js

@@ -8,16 +8,15 @@ const Item_1 = require("../Item");
  */
 exports.default = {
     /**
-     * asset handler factory
+     * .css handler factory
      *
      * @public
      */
-    asset: () => new Item_1.Item({
-        loader: ({ build }) => build.loaders.file,
-        options: app => ({
-            name: `assets/${app.store.is('features.hash', true) && app.isProduction
-                ? app.store.get('hashFormat')
-                : app.store.get('fileFormat')}.[ext]`,
+    css: () => new Item_1.Item({
+        loader: ({ build }) => build.loaders.css,
+        options: ({ hooks }) => ({
+            importLoaders: 1,
+            sourceMap: hooks.filter('build.devtool') ? true : false,
         }),
     }),
     /**
@@ -25,11 +24,13 @@ exports.default = {
      *
      * @public
      */
-    css: () => new Item_1.Item({
+    cssModule: () => new Item_1.Item({
         loader: ({ build }) => build.loaders.css,
         options: ({ hooks }) => ({
-            sourceMap: hooks.filter('build.devtool') ? true : false,
             importLoaders: 1,
+            localIdentName: '[name]__[local]___[hash:base64:5]',
+            modules: true,
+            sourceMap: hooks.filter('build.devtool') ? true : false,
         }),
     }),
     /**
@@ -71,7 +72,6 @@ exports.default = {
      */
     minicss: () => new Item_1.Item({
         loader: ({ build }) => build.loaders.minicss,
-        options: ({ store }) => ({}),
     }),
     /**
      * Factory {@link Item} for raw
@@ -89,9 +89,9 @@ exports.default = {
     file: () => new Item_1.Item({
         loader: ({ build }) => build.loaders.file,
         options: app => ({
-            name: `${app.store.is('features.hash', true) && app.isProduction
-                ? app.store.get('hashFormat')
-                : app.store.get('fileFormat')}.[ext]`,
+            name: app.store.is('features.hash', true)
+                ? app.store.get('hashFormat').concat('.[ext]')
+                : app.store.get('fileFormat').concat('.[ext]'),
         }),
     }),
     /**
@@ -101,13 +101,10 @@ exports.default = {
      */
     [`resolve-url`]: () => new Item_1.Item({
         loader: ({ build }) => build.loaders['resolve-url'],
-        options: ({ path, hooks }) => {
-            var _a;
-            return ({
-                root: path('src'),
-                sourceMap: (_a = hooks.filter('build.devtool')) !== null && _a !== void 0 ? _a : false,
-            });
-        },
+        options: ({ path, hooks }) => ({
+            root: path('src'),
+            sourceMap: hooks.filter('build.devtool') ?? false,
+        }),
     }),
     /**
      * Factory {@link Item} for xml
@@ -118,4 +115,3 @@ exports.default = {
         loader: ({ build }) => build.loaders.xml,
     }),
 };
-//# sourceMappingURL=items.js.map

package/lib/cjs/Build/loaders.js

@@ -1,7 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const mini_css_extract_plugin_1 = (0, tslib_1.__importDefault)(require("mini-css-extract-plugin"));
+const mini_css_extract_plugin_1 = __importDefault(require("mini-css-extract-plugin"));
 const Loader_1 = require("../Loader");
 exports.default = {
     /**
@@ -38,7 +40,7 @@ exports.default = {
      * Returns {@link Loader} for `resolve-url-loader`
      * @public
      */
-    [`resolve-url`]: () => new Loader_1.Loader(require.resolve('resolve-url-loader')),
+    ['resolve-url']: () => new Loader_1.Loader(require.resolve('resolve-url-loader')),
     /**
      * Returns {@link Loader} for `style-loader`
      * @public
@@ -55,4 +57,3 @@ exports.default = {
      */
     xml: () => new Loader_1.Loader(require.resolve('xml-loader')),
 };
-//# sourceMappingURL=loaders.js.map

package/lib/cjs/Build/rules.js

@@ -1,143 +1,181 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.js = exports.css = exports.json5 = exports.yml = exports.toml = exports.xml = exports.csv = exports.html = exports.svg = exports.font = exports.image = void 0;
+exports.toml = exports.xml = exports.csv = exports.html = exports.yml = exports.json = exports.font = exports.svg = exports.webp = exports.image = exports.cssModule = exports.css = exports.js = void 0;
 const bud_support_1 = require("@roots/bud-support");
-const Rule_1 = require("../Rule");
 /**
- * Returns {@link Rule} for `asset/resource`
+ * .js rule
  *
  * @public
  */
-const image = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.image'),
-    exclude: ({ store }) => store.get('patterns.modules'),
-    type: 'asset/resource',
-    generator: app => ({
-        filename: `assets/${app.store.is('features.hash', true) && app.isProduction
-            ? app.store.get('hashFormat')
-            : app.store.get('fileFormat')}[ext]`,
-    }),
-});
-exports.image = image;
+const js = (app) => app.build
+    .makeRule()
+    .setTest(({ store }) => store.get('patterns.js'))
+    .setInclude(({ path }) => path('src'))
+    .setUse([]);
+exports.js = js;
 /**
- * Returns {@link Rule} for `.woff`/`.otf` handling
+ * .css rule
  *
  * @public
  */
-const font = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.font'),
-    exclude: ({ store }) => store.get('patterns.modules'),
-    use: ({ build }) => [build.items['resolve-url']],
-});
-exports.font = font;
+const css = (app) => app.build
+    .makeRule()
+    .setTest(({ store }) => store.get('patterns.css'))
+    .setInclude(({ path }) => path('src'))
+    .setUse(({ isProduction, build }) => [
+    isProduction ? build.items.minicss : build.items.style,
+    build.items.css,
+]);
+exports.css = css;
 /**
- * Returns {@link Rule} for `.svg` handling
+ * .module.css rule
  *
  * @public
  */
-const svg = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.svg'),
-    exclude: ({ store }) => store.get('patterns.modules'),
-    type: 'asset/resource',
-    generator: app => ({
-        filename: `assets/${app.store.is('features.hash', true) && app.isProduction
-            ? app.store.get('hashFormat')
-            : app.store.get('fileFormat')}[ext]`,
-    }),
-});
-exports.svg = svg;
+const cssModule = (app) => app.build
+    .makeRule()
+    .setTest(({ store }) => store.get('patterns.cssModule'))
+    .setInclude(({ path }) => path('src'))
+    .setUse(({ isProduction, build }) => [
+    isProduction ? build.items.minicss : build.items.style,
+    build.items.cssModule,
+]);
+exports.cssModule = cssModule;
 /**
- * Returns {@link Rule} for `.html` handling
+ * .jpg, .jpeg, .png, .gif rule
  *
  * @public
  */
-const html = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.html'),
-    use: ({ build }) => [build.items.html],
-});
-exports.html = html;
+const image = (app) => app.build
+    .makeRule()
+    .setTest(({ store }) => store.get('patterns.image'))
+    .setExclude(({ store }) => store.get('patterns.modules'))
+    .setType('asset/resource')
+    .setGenerator(app => ({
+    filename: app.store.is('features.hash', true)
+        ? 'images/'.concat(app.store.get('hashFormat')).concat('[ext]')
+        : 'images/'.concat(app.store.get('fileFormat')).concat('[ext]'),
+}));
+exports.image = image;
 /**
- * Returns {@link Rule} for `.csv` handling
+ * .webp assets factorry
+ *
+ * @remarks
+ * Returns {@link Rule} for `asset/resource`
  *
  * @public
  */
-const csv = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.csv'),
-    use: ({ build }) => [build.items.csv],
-});
-exports.csv = csv;
+const webp = (app) => app.build
+    .makeRule()
+    .setTest(({ store }) => store.get('patterns.webp'))
+    .setExclude(({ store }) => store.get('patterns.modules'))
+    .setType('asset/resource')
+    .setGenerator(app => ({
+    filename: app.store.is('features.hash', true)
+        ? 'images/'.concat(app.store.get('hashFormat')).concat('[ext]')
+        : 'images/'.concat(app.store.get('fileFormat')).concat('[ext]'),
+}));
+exports.webp = webp;
 /**
- * Returns {@link Rule} for `.xml` handling
+ * Returns {@link Rule} for `.woff`/`.otf` handling
+ * .svg rule
  *
  * @public
  */
-const xml = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.xml'),
-    use: ({ build }) => [build.items.xml],
-});
-exports.xml = xml;
+const svg = (app) => app.build
+    .makeRule()
+    .setTest(({ store }) => store.get('patterns.svg'))
+    .setExclude(({ store }) => store.get('patterns.modules'))
+    .setType('asset/resource')
+    .setGenerator(app => ({
+    filename: app.store.is('features.hash', true)
+        ? 'svg/'.concat(app.store.get('hashFormat')).concat('[ext]')
+        : 'svg/'.concat(app.store.get('fileFormat')).concat('[ext]'),
+}));
+exports.svg = svg;
 /**
- * Returns {@link Rule} for `.toml` handling
+ * .woff, .woff2, .otf rule
  *
  * @public
  */
-const toml = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.toml'),
-    type: () => 'json',
-    parser: () => ({
-        parse: bud_support_1.toml.parse,
-    }),
-});
-exports.toml = toml;
+const font = (app) => app.build
+    .makeRule()
+    .setType('asset')
+    .setTest(({ store }) => store.get('patterns.font'))
+    .setExclude(({ store }) => store.get('patterns.modules'))
+    .setInclude(({ path }) => path('src'))
+    .setGenerator(app => ({
+    filename: app.store.is('features.hash', true)
+        ? 'fonts/'.concat(app.store.get('hashFormat')).concat('[ext]')
+        : 'fonts/'.concat(app.store.get('fileFormat')).concat('[ext]'),
+}));
+exports.font = font;
+/**
+ * Returns {@link Rule} for `.jsonc` handling
+ *
+ * @public
+ */
+const json = (app) => app.build
+    .makeRule()
+    .setType('json')
+    .setInclude(({ path }) => path('src'))
+    .setTest(({ store }) => store.get('patterns.json'))
+    .setParser({ parse: bud_support_1.json5.parse });
+exports.json = json;
 /**
  * Returns {@link Rule} for `.yml` / `.yaml` handling
  *
  * @public
  */
-const yml = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.yml'),
-    type: 'json',
-    parser: () => ({
-        parse: bud_support_1.yaml.parse,
-    }),
-});
+const yml = (app) => app.build
+    .makeRule()
+    .setType('json')
+    .setInclude(({ path }) => path('src'))
+    .setTest(({ store }) => store.get('patterns.yml'))
+    .setParser({ parse: bud_support_1.yaml.parse });
 exports.yml = yml;
 /**
- * Returns {@link Rule} for `.jsonc` handling
+ * Returns {@link Rule} for `.html` handling
  *
  * @public
  */
-const json5 = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.json5'),
-    type: 'json',
-    parser: () => ({
-        parse: bud_support_1.json5.parse,
-    }),
-});
-exports.json5 = json5;
+const html = (app) => app.build
+    .makeRule()
+    .setInclude(({ path }) => path('src'))
+    .setTest(({ store }) => store.get('patterns.html'))
+    .setUse(({ build }) => [build.items.html]);
+exports.html = html;
 /**
- * Returns {@link Rule} for `.css` handling
+ * Returns {@link Rule} for `.csv` handling
  *
  * @public
  */
-const css = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.css'),
-    exclude: ({ store }) => store.get('patterns.modules'),
-    use: ({ isProduction, build }) => [
-        isProduction ? build.items.minicss : build.items.style,
-        build.items.css,
-    ],
-});
-exports.css = css;
+const csv = (app) => app.build
+    .makeRule()
+    .setInclude(({ path }) => path('src'))
+    .setTest(({ store }) => store.get('patterns.csv'))
+    .setUse(({ build }) => [build.items.csv]);
+exports.csv = csv;
 /**
- * Returns {@link Rule} for `.js` handling
+ * Returns {@link Rule} for `.xml` handling
  *
  * @public
  */
-const js = () => new Rule_1.Rule({
-    test: ({ store }) => store.get('patterns.js'),
-    exclude: ({ store }) => store.get('patterns.modules'),
-    use: () => [],
-});
-exports.js = js;
-//# sourceMappingURL=rules.js.map
+const xml = (app) => app.build
+    .makeRule()
+    .setInclude(({ path }) => path('src'))
+    .setTest(({ store }) => store.get('patterns.xml'))
+    .setUse(({ build }) => [build.items.xml]);
+exports.xml = xml;
+/**
+ * Returns {@link Rule} for `.toml` handling
+ *
+ * @public
+ */
+const toml = (app) => app.build
+    .makeRule()
+    .setType('json')
+    .setInclude(({ path }) => path('src'))
+    .setTest(({ store }) => store.get('patterns.html'))
+    .setParser({ parse: bud_support_1.toml.parse });
+exports.toml = toml;