@lipemat/js-boilerplate 10.8.0-beta.2 → 10.8.0-beta.4

package/bin/build.ts

@@ -0,0 +1,8 @@
+import {execSync} from 'node:child_process';
+import chalk from 'chalk';
+
+console.log( chalk.blue( '[TS] ' ) + ' Compiling the files using the tsconfig.json in the src directory.' );
+
+execSync( 'tsc -p src', {stdio: 'inherit'} );
+
+console.log( chalk.blueBright( '[TS] ' ) + ' Finished compiling the files.' );

package/bin/watch.ts

@@ -0,0 +1,26 @@
+import chokidar from 'chokidar';
+import {exec} from 'child_process';
+import chalk, {red} from 'chalk';
+
+const toWatch = [
+	'config/*.ts',
+	'helpers/*.ts',
+];
+
+/**
+ * Watch for changes in the config or helpers directory and run the build script when a change is detected.
+ */
+chokidar.watch( toWatch, {ignored: /(^|[\/\\])\../} )
+	.on( 'change', path => {
+		console.log( chalk.yellowBright( '[watch]' ), `${path} changed` );
+		exec( 'yarn run build', ( err, stdout ) => {
+			if ( err ) {
+				console.error( red( stdout ) );
+			} else {
+				console.log( stdout );
+			}
+		} );
+	} )
+	.once( 'ready', () => {
+		console.log( chalk.greenBright( '[watch]' ), 'Watching for changes…' );
+	} )

package/config/babel.config.js

@@ -1,12 +1,6 @@
-'use strict';
-Object.defineProperty( exports, '__esModule', {value: true} );
-/**
- * Generated from the `src` directory to compile TS to JS because JEST
- * does not support using TS files as part of the JEST configuration when
- * located in a `node_modules directory.
- *
- */
-const config_1 = require( '../helpers/config' );
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("../helpers/config");
 /**
  * Use Babel's preset-env to add support for target browsers.
  *
@@ -15,35 +9,35 @@ const config_1 = require( '../helpers/config' );
  * @see https://babeljs.io/docs/en/babel-preset-env
  */
 const presetEnv = {
-	bugfixes: true,
-	corejs: {
-		// Use the core-js version currently installed in the project.
-		version: require( 'core-js/package.json' ).version,
-		proposals: false,
-	},
-	// Enable the `debug` option to debug the included polyfills and plugins.
-	debug: false,
-	// Ignore any external browserslist in favor of `getBrowsersList()`.
-	ignoreBrowserslistConfig: true,
-	shippedProposals: false,
-	targets: {
-		browsers: ( 0, config_1.getBrowsersList )(),
-	},
-	useBuiltIns: 'usage',
+    bugfixes: true,
+    corejs: {
+        // Use the core-js version currently installed in the project.
+        version: require('core-js/package.json').version,
+        proposals: false,
+    },
+    // Enable the `debug` option to debug the included polyfills and plugins.
+    debug: false,
+    // Ignore any external browserslist in favor of `getBrowsersList()`.
+    ignoreBrowserslistConfig: true,
+    shippedProposals: false,
+    targets: {
+        browsers: (0, config_1.getBrowsersList)(),
+    },
+    useBuiltIns: 'usage',
 };
 const babelConfig = {
-	cacheDirectory: true,
-	presets: [
-		[ '@babel/preset-env', presetEnv ],
-		[ '@babel/preset-react', {
-			development: 'production' !== process.env.NODE_ENV,
-			runtime: 'automatic',
-		} ],
-		'@babel/preset-typescript',
-	],
-	plugins: [
-		'@babel/plugin-syntax-dynamic-import',
-	],
+    cacheDirectory: true,
+    presets: [
+        ['@babel/preset-env', presetEnv],
+        ['@babel/preset-react', {
+                development: 'production' !== process.env.NODE_ENV,
+                runtime: 'automatic',
+            }],
+        '@babel/preset-typescript',
+    ],
+    plugins: [
+        '@babel/plugin-syntax-dynamic-import',
+    ],
 };
 exports.default = babelConfig;
 module.exports = babelConfig;

package/config/babel.config.ts

@@ -0,0 +1,61 @@
+import {getBrowsersList} from '../helpers/config';
+import type {TransformOptions} from '@babel/core';
+import type {Options} from '@babel/preset-env';
+
+export type BabelConfig = Pick<BabelFull, 'presets' | 'plugins' | 'cacheDirectory'>;
+export type BabelFull = Partial<TransformOptions> & BabelLoader;
+
+/**
+ * @link https://webpack.js.org/loaders/babel-loader/#options
+ */
+export type BabelLoader = {
+	cacheDirectory?: boolean | string;
+	cacheIdentifier?: string;
+	cacheCompression?: boolean;
+	customize?: string;
+	metadataSubscribers?: string[];
+}
+
+/**
+ * Use Babel's preset-env to add support for target browsers.
+ *
+ * @note Set the `debug` option to `true` to debug the included polyfills and plugins.
+ *
+ * @see https://babeljs.io/docs/en/babel-preset-env
+ */
+const presetEnv: Options = {
+	bugfixes: true,
+	corejs: {
+		// Use the core-js version currently installed in the project.
+		version: require( 'core-js/package.json' ).version,
+		proposals: false,
+	},
+	// Enable the `debug` option to debug the included polyfills and plugins.
+	debug: false,
+	// Ignore any external browserslist in favor of `getBrowsersList()`.
+	ignoreBrowserslistConfig: true,
+	shippedProposals: false,
+	targets: {
+		browsers: getBrowsersList(),
+	},
+	useBuiltIns: 'usage',
+};
+
+
+const babelConfig: BabelConfig = {
+	cacheDirectory: true,
+	presets: [
+		[ '@babel/preset-env', presetEnv ],
+		[ '@babel/preset-react', {
+			development: 'production' !== process.env.NODE_ENV,
+			runtime: 'automatic',
+		} ],
+		'@babel/preset-typescript',
+	],
+	plugins: [
+		'@babel/plugin-syntax-dynamic-import',
+	],
+};
+
+export default babelConfig;
+module.exports = babelConfig;

package/config/entries.config.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Entry points to be loaded by Webpack.
  *
@@ -6,15 +7,17 @@
  *
  * @see getEntries
  */
-module.exports = {
-	master: [
-		'index.js',
-		'index.ts',
-		'index.tsx',
-	],
-	admin: [
-		'admin.js',
-		'admin.ts',
-		'admin.tsx',
-	],
+Object.defineProperty(exports, "__esModule", { value: true });
+const entries = {
+    master: [
+        'index.js',
+        'index.ts',
+        'index.tsx',
+    ],
+    admin: [
+        'admin.js',
+        'admin.ts',
+        'admin.tsx',
+    ],
 };
+module.exports = entries;

package/config/entries.config.ts

@@ -0,0 +1,27 @@
+/**
+ * Entry points to be loaded by Webpack.
+ *
+ * Checks for sources in the order they are defined and creates a
+ * single entry per key if a source file exists.
+ *
+ * @see getEntries
+ */
+
+export type EntriesConfig = {
+	[file: string]: string[];
+};
+
+const entries: EntriesConfig = {
+	master: [
+		'index.js',
+		'index.ts',
+		'index.tsx',
+	],
+	admin: [
+		'admin.js',
+		'admin.ts',
+		'admin.tsx',
+	],
+};
+
+module.exports = entries;

package/config/jest.config.js

@@ -1,46 +1,41 @@
-'use strict';
-Object.defineProperty( exports, '__esModule', {value: true} );
-/**
- * Generated from the `src` directory to compile TS to JS because JEST
- * does not support using TS files as part of the JEST configuration when
- * located in a `node_modules directory.
- *
- */
-const path_1 = require( 'path' );
-const {getPackageConfig} = require( '../helpers/package-config' );
-const fs_1 = require( 'fs' );
-const packageConfig = getPackageConfig();
-const babelConfig = require( '../helpers/config' ).getConfig( 'babel.config' );
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const fs_1 = require("fs");
+const package_config_1 = require("../helpers/package-config");
+const config_1 = require("../helpers/config");
+const { workingDirectory, url } = (0, package_config_1.getPackageConfig)();
+const babelConfig = (0, config_1.getConfig)('babel.config');
 delete babelConfig.cacheDirectory;
 const jestConfig = {
-	globals: {
-		__TEST__: true,
-	},
-	moduleNameMapper: {
-		'\\.(pcss|less|css)$': 'identity-obj-proxy',
-		'is-plain-obj': 'identity-obj-proxy',
-		uuid: 'identity-obj-proxy',
-	},
-	roots: [
-		'./tests',
-	],
-	testEnvironment: 'jsdom',
-	testEnvironmentOptions: {
-		url: packageConfig.url,
-	},
-	transform: {
-		'^.+\\.[tj]sx?$': [ 'babel-jest', babelConfig ],
-	},
-	transformIgnorePatterns: [
-		'node_modules/(?!@lipemat)',
-	],
-	setupFilesAfterEnv: [
-		// @todo Remove old "tests" directory in version 11.
-		( 0, path_1.resolve )( packageConfig.workingDirectory, 'tests/setup.js' ),
-		( 0, path_1.resolve )( packageConfig.workingDirectory, 'tests/setup.ts' ),
-		// New location.
-		( 0, path_1.resolve )( packageConfig.workingDirectory, 'jest/setup.ts' ),
-	].filter( fs_1.existsSync ),
+    globals: {
+        __TEST__: true,
+    },
+    moduleNameMapper: {
+        '\\.(pcss|less|css)$': 'identity-obj-proxy',
+        'is-plain-obj': 'identity-obj-proxy',
+        uuid: 'identity-obj-proxy',
+    },
+    roots: [
+        './tests',
+    ],
+    testEnvironment: 'jsdom',
+    testEnvironmentOptions: {
+        url,
+    },
+    transform: {
+        '^.+\\.[tj]sx?$': ['babel-jest', babelConfig],
+    },
+    transformIgnorePatterns: [
+        'node_modules/(?!@lipemat)',
+    ],
+    setupFilesAfterEnv: [
+        // @todo Remove old "tests" directory in version 11.
+        (0, path_1.resolve)(workingDirectory, 'tests/setup.js'),
+        (0, path_1.resolve)(workingDirectory, 'tests/setup.ts'),
+        // New location.
+        (0, path_1.resolve)(workingDirectory, 'jest/setup.ts'),
+    ].filter(fs_1.existsSync),
 };
 exports.default = jestConfig;
 module.exports = jestConfig;

package/config/jest.config.ts

@@ -0,0 +1,47 @@
+import {resolve} from 'path';
+import type {Config} from 'jest';
+import {existsSync} from 'fs';
+import {getPackageConfig} from '../helpers/package-config';
+import {getConfig} from '../helpers/config';
+
+
+export type JestConfig = Pick<Config, 'globals' | 'moduleNameMapper' | 'roots' | 'testEnvironment' | 'testEnvironmentOptions' | 'transform' | 'transformIgnorePatterns' | 'setupFilesAfterEnv'>;
+
+const {workingDirectory, url} = getPackageConfig();
+const babelConfig = getConfig( 'babel.config' );
+delete babelConfig.cacheDirectory;
+
+
+const jestConfig: Config = {
+	globals: {
+		__TEST__: true,
+	},
+	moduleNameMapper: {
+		'\\.(pcss|less|css)$': 'identity-obj-proxy',
+		'is-plain-obj': 'identity-obj-proxy',
+		uuid: 'identity-obj-proxy',
+	},
+	roots: [
+		'./tests',
+	],
+	testEnvironment: 'jsdom',
+	testEnvironmentOptions: {
+		url,
+	},
+	transform: {
+		'^.+\\.[tj]sx?$': [ 'babel-jest', babelConfig ],
+	},
+	transformIgnorePatterns: [
+		'node_modules/(?!@lipemat)',
+	],
+	setupFilesAfterEnv: [
+		// @todo Remove old "tests" directory in version 11.
+		resolve( workingDirectory, 'tests/setup.js' ),
+		resolve( workingDirectory, 'tests/setup.ts' ),
+		// New location.
+		resolve( workingDirectory, 'jest/setup.ts' ),
+	].filter( existsSync ),
+};
+
+export default jestConfig;
+module.exports = jestConfig;

package/helpers/config.js

@@ -1,14 +1,16 @@
-const packageConfig = require( './package-config' );
-const path = require( 'path' );
-const browserslist = require( 'browserslist' );
-const fs = require( 'fs' );
-const config = require( './package-config' );
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adjustBrowserslist = exports.getDefaultBrowsersList = exports.getBrowsersList = exports.getTsConfigFile = exports.getExtensionsConfig = exports.getConfig = exports.hasLocalOverride = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const package_config_1 = require("./package-config");
+// Must be required to avoid issues with browserslist.
+const browserslist = require('browserslist');
+const { dependencies, devDependencies, workingDirectory, packageDirectory } = (0, package_config_1.getPackageConfig)();
 const extensions = [
-	...Object.keys( packageConfig.dependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
-	...Object.keys( packageConfig.devDependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
+    ...Object.keys(dependencies ?? {}).filter(name => name.includes('js-boilerplate-')),
+    ...Object.keys(devDependencies ?? {}).filter(name => name.includes('js-boilerplate-')),
 ];
-
 /**
  * Check to see if a local config file exists.
  *
@@ -17,22 +19,23 @@ const extensions = [
  *
  * @return {boolean}
  */
-function hasLocalOverride( fileName, inWorkingDirectory = false, ) {
-	let hasLocal = false;
-	try {
-		if ( inWorkingDirectory ) {
-			require( path.resolve( packageConfig.workingDirectory, fileName ) );
-			hasLocal = true;
-		} else {
-			require( path.resolve( packageConfig.packageDirectory + '/config', fileName ) );
-			hasLocal = true;
-		}
-	} catch ( e ) {
-	}
-
-	return hasLocal;
+function hasLocalOverride(fileName, inWorkingDirectory = false) {
+    let hasLocal = false;
+    try {
+        if (inWorkingDirectory) {
+            require((0, path_1.resolve)(workingDirectory, fileName));
+            hasLocal = true;
+        }
+        else {
+            require((0, path_1.resolve)(packageDirectory + '/config', fileName));
+            hasLocal = true;
+        }
+    }
+    catch (e) {
+    }
+    return hasLocal;
 }
-
+exports.hasLocalOverride = hasLocalOverride;
 /**
  * Get a config from our /config directory merged with any
  * matching configuration from the project directory.
@@ -61,21 +64,23 @@ function hasLocalOverride( fileName, inWorkingDirectory = false, ) {
  *
  * @return {Object}
  */
-function getConfig( fileName ) {
-	let mergedConfig = require( '../config/' + fileName );
-	mergedConfig = {...mergedConfig, ...getExtensionsConfig( fileName, mergedConfig )};
-	try {
-		const localConfig = require( path.resolve( packageConfig.packageDirectory + '/config', fileName ) );
-		if ( 'function' === typeof localConfig ) {
-			mergedConfig = {...mergedConfig, ...localConfig( mergedConfig )};
-		} else {
-			mergedConfig = {...mergedConfig, ...localConfig};
-		}
-	} catch ( e ) {
-	}
-	return mergedConfig;
+function getConfig(fileName) {
+    let mergedConfig = require('../config/' + fileName);
+    mergedConfig = { ...mergedConfig, ...getExtensionsConfig(fileName, mergedConfig) };
+    try {
+        const localConfig = require((0, path_1.resolve)(packageDirectory + '/config', fileName));
+        if ('function' === typeof localConfig) {
+            mergedConfig = { ...mergedConfig, ...localConfig(mergedConfig) };
+        }
+        else {
+            mergedConfig = { ...mergedConfig, ...localConfig };
+        }
+    }
+    catch (e) {
+    }
+    return mergedConfig;
 }
-
+exports.getConfig = getConfig;
 /**
  * Get a config from any existing extension's /config directories
  * merged into one.
@@ -88,23 +93,24 @@ function getConfig( fileName ) {
  *
  * @return {Object}
  */
-function getExtensionsConfig( fileName, defaultConfig ) {
-	let mergedConfig = {};
-	extensions.forEach( extension => {
-		try {
-			const extensionConfig = require( extension + '/config/' + fileName );
-			if ( 'function' === typeof extensionConfig ) {
-				mergedConfig = {...mergedConfig, ...extensionConfig( {...defaultConfig, ...mergedConfig} )};
-			} else {
-				mergedConfig = {...mergedConfig, ...extensionConfig};
-			}
-		} catch ( e ) {
-		}
-	} );
-
-	return mergedConfig;
+function getExtensionsConfig(fileName, defaultConfig) {
+    let mergedConfig = {};
+    extensions.forEach(extension => {
+        try {
+            const extensionConfig = require(extension + '/config/' + fileName);
+            if ('function' === typeof extensionConfig) {
+                mergedConfig = { ...mergedConfig, ...extensionConfig({ ...defaultConfig, ...mergedConfig }) };
+            }
+            else {
+                mergedConfig = { ...mergedConfig, ...extensionConfig };
+            }
+        }
+        catch (e) {
+        }
+    });
+    return mergedConfig;
 }
-
+exports.getExtensionsConfig = getExtensionsConfig;
 /**
  * Get the path to the "tsconfig.json" file if it exists.
  *
@@ -117,20 +123,18 @@ function getExtensionsConfig( fileName, defaultConfig ) {
  * @return {string}
  */
 function getTsConfigFile() {
-	const possibles = [
-		// Backward compatible for before @lipemat/eslint-config version 3.
-		path.resolve( config.workingDirectory + '/tsconfig.json' ),
-		path.resolve( config.packageDirectory + '/tsconfig.json' ),
-	];
-	let tsConfig = '';
-	possibles.forEach( filePath => {
-		if ( fs.existsSync( filePath ) ) {
-			tsConfig = filePath;
-		}
-	} );
-	return tsConfig;
+    const possibles = [
+        // Backward compatible for before @lipemat/eslint-config version 3.
+        (0, path_1.resolve)(workingDirectory + '/tsconfig.json'),
+        (0, path_1.resolve)(packageDirectory + '/tsconfig.json'),
+    ].filter(fs_1.existsSync);
+    let tsConfig = '';
+    possibles.forEach(filePath => {
+        tsConfig = filePath;
+    });
+    return tsConfig;
 }
-
+exports.getTsConfigFile = getTsConfigFile;
 /**
  * Get the browserslist from the current project.
  *
@@ -139,14 +143,14 @@ function getTsConfigFile() {
  *  @link https://github.com/browserslist/browserslist#config-file
  */
 function getBrowsersList() {
-	const projectBrowsersList = browserslist();
-	if ( browserslist( browserslist.defaults ) === projectBrowsersList ) {
-		const wp = [ ...require( '@wordpress/browserslist-config' ) ];
-		return adjustBrowserslist( wp );
-	}
-	return projectBrowsersList;
+    const projectBrowsersList = browserslist();
+    if (browserslist(browserslist.defaults) === projectBrowsersList) {
+        const wp = [...require('@wordpress/browserslist-config')];
+        return adjustBrowserslist(wp);
+    }
+    return projectBrowsersList;
 }
-
+exports.getBrowsersList = getBrowsersList;
 /**
  * If browserslist is not specified, we fall back to WordPress defaults.
  *
@@ -157,35 +161,26 @@ function getBrowsersList() {
  * has not specified one.
  *
  * @deprecated Use getBrowsersList instead.
+ *
  * @link https://github.com/browserslist/browserslist#config-file
  *
  * @return {boolean | string[]}
  */
 const getDefaultBrowsersList = () => {
-	if ( browserslist( browserslist.defaults ) === browserslist() ) {
-		const wp = [ ...require( '@wordpress/browserslist-config' ) ];
-		return adjustBrowserslist( wp );
-	}
-	return false;
+    if (browserslist(browserslist.defaults) === browserslist()) {
+        const wp = [...require('@wordpress/browserslist-config')];
+        return adjustBrowserslist(wp);
+    }
+    return false;
 };
-
+exports.getDefaultBrowsersList = getDefaultBrowsersList;
 /**
  * Adjust the browserslist to include our defaults.
  *
  * @todo Remove `not op_mini all` after 3/8/2024 if it does not creep back in to the defaults.
  */
-function adjustBrowserslist( browserRules ) {
-	browserRules.push( 'not op_mini all' );
-	return browserRules;
+function adjustBrowserslist(browserRules) {
+    browserRules.push('not op_mini all');
+    return browserRules;
 }
-
-
-module.exports = {
-	adjustBrowserslist,
-	getBrowsersList,
-	getConfig,
-	getDefaultBrowsersList,
-	getExtensionsConfig,
-	getTsConfigFile,
-	hasLocalOverride,
-};
+exports.adjustBrowserslist = adjustBrowserslist;

package/helpers/config.ts

@@ -0,0 +1,200 @@
+import {existsSync} from 'fs';
+import {resolve} from 'path';
+import type {BabelConfig} from '../config/babel.config';
+import type {JestConfig} from '../config/jest.config';
+import {getPackageConfig} from './package-config';
+import type {EntriesConfig} from '../config/entries.config';
+
+// Must be required to avoid issues with browserslist.
+const browserslist = require( 'browserslist' );
+
+
+type Configs = {
+	'babel.config': BabelConfig;
+	'jest.config': JestConfig;
+	'entries.config': EntriesConfig;
+};
+
+const {dependencies, devDependencies, workingDirectory, packageDirectory} = getPackageConfig();
+
+const extensions = [
+	...Object.keys( dependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
+	...Object.keys( devDependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
+];
+
+
+/**
+ * Check to see if a local config file exists.
+ *
+ * @param {string}  fileName
+ * @param {boolean} inWorkingDirectory - Look in working directory instead of their /config directory
+ *
+ * @return {boolean}
+ */
+export function hasLocalOverride( fileName: string, inWorkingDirectory: boolean = false ): boolean {
+	let hasLocal = false;
+	try {
+		if ( inWorkingDirectory ) {
+			require( resolve( workingDirectory, fileName ) );
+			hasLocal = true;
+		} else {
+			require( resolve( packageDirectory + '/config', fileName ) );
+			hasLocal = true;
+		}
+	} catch ( e ) {
+	}
+
+	return hasLocal;
+}
+
+
+/**
+ * Get a config from our /config directory merged with any
+ * matching configuration from the project directory.
+ *
+ * For instance if we have a file named config/babel.config.js in our project
+ * we will merge the contents with our config/babel.config.js in favor of whatever
+ * is specified with the project's file.
+ *
+ * If the `module.exports` are a function, the existing configuration will be passed
+ * as the only argument. Otherwise, standard `module.exports` are also supported.
+ *
+ * @example ```ts
+ * // standard
+ * module.export = {
+ *     externals: {extra: 'Extra'}
+ * }
+ * // function
+ * module.exports = function( config ) {
+ *     return {
+ *         externals: {...config.externals, extra: 'Extra'}
+ *     }
+ * }
+ * ```
+ *
+ * @param {string} fileName
+ *
+ * @return {Object}
+ */
+export function getConfig<T extends keyof Configs>( fileName: T ): Configs[T] {
+	let mergedConfig = require( '../config/' + fileName ) as Configs[T];
+	mergedConfig = {...mergedConfig, ...getExtensionsConfig<Configs[T]>( fileName, mergedConfig )};
+	try {
+		const localConfig = require( resolve( packageDirectory + '/config', fileName ) );
+		if ( 'function' === typeof localConfig ) {
+			mergedConfig = {...mergedConfig, ...localConfig( mergedConfig )};
+		} else {
+			mergedConfig = {...mergedConfig, ...localConfig};
+		}
+	} catch ( e ) {
+	}
+	return mergedConfig;
+}
+
+
+/**
+ * Get a config from any existing extension's /config directories
+ * merged into one.
+ *
+ * @param {string} fileName
+ * @param {Object} defaultConfig - Default config from this package.
+ *                               Used for passing to an extension callback.
+ *
+ * @see getConfig
+ *
+ * @return {Object}
+ */
+export function getExtensionsConfig<T extends object>( fileName: string, defaultConfig: T ): T {
+	let mergedConfig: T = {} as T;
+	extensions.forEach( extension => {
+		try {
+			const extensionConfig = require( extension + '/config/' + fileName );
+			if ( 'function' === typeof extensionConfig ) {
+				mergedConfig = {...mergedConfig, ...extensionConfig( {...defaultConfig, ...mergedConfig} )};
+			} else {
+				mergedConfig = {...mergedConfig, ...extensionConfig};
+			}
+		} catch ( e ) {
+		}
+	} );
+
+	return mergedConfig;
+}
+
+
+/**
+ * Get the path to the "tsconfig.json" file if it exists.
+ *
+ * 1. The working directory.
+ * 2. The package directory.
+ *
+ * The package directory takes priority over the working directory.
+ *
+ *
+ * @return {string}
+ */
+export function getTsConfigFile(): string {
+	const possibles = [
+		// Backward compatible for before @lipemat/eslint-config version 3.
+		resolve( workingDirectory + '/tsconfig.json' ),
+		resolve( packageDirectory + '/tsconfig.json' ),
+	].filter( existsSync );
+
+	let tsConfig = '';
+	possibles.forEach( filePath => {
+		tsConfig = filePath;
+	} );
+	return tsConfig;
+}
+
+
+/**
+ * Get the browserslist from the current project.
+ *
+ * - If specified using standard browserslist config, we will use that.
+ *
+ *  @link https://github.com/browserslist/browserslist#config-file
+ */
+export function getBrowsersList(): readonly string[] {
+	const projectBrowsersList = browserslist();
+	if ( browserslist( browserslist.defaults ) === projectBrowsersList ) {
+		const wp = [ ...require( '@wordpress/browserslist-config' ) ];
+		return adjustBrowserslist( wp );
+	}
+	return projectBrowsersList;
+}
+
+
+/**
+ * If browserslist is not specified, we fall back to WordPress defaults.
+ *
+ * - Return the default browserslist if the current project does not specify one.
+ * - Return false if a browserslist is specified.
+ *
+ * Used in cases where we can fall back to standard browserslist config if the project
+ * has not specified one.
+ *
+ * @deprecated Use getBrowsersList instead.
+ *
+ * @link https://github.com/browserslist/browserslist#config-file
+ *
+ * @return {boolean | string[]}
+ */
+export const getDefaultBrowsersList = (): false | string[] => {
+	if ( browserslist( browserslist.defaults ) === browserslist() ) {
+		const wp = [ ...require( '@wordpress/browserslist-config' ) ];
+		return adjustBrowserslist( wp );
+	}
+	return false;
+};
+
+
+/**
+ * Adjust the browserslist to include our defaults.
+ *
+ * @todo Remove `not op_mini all` after 3/8/2024 if it does not creep back in to the defaults.
+ */
+export function adjustBrowserslist( browserRules: string[] ): string[] {
+	browserRules.push( 'not op_mini all' );
+	return browserRules;
+}

package/helpers/entries.js

@@ -1,11 +1,11 @@
-const config = require( './package-config' );
-const fs = require( 'fs' );
-const path = require( 'path' );
-const {getConfig} = require( './config' );
-
-const entries = getConfig( 'entries.config' );
-
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntries = void 0;
+const config_1 = require("./config");
+const package_config_1 = require("./package-config");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const entries = (0, config_1.getConfig)('entries.config');
 /**
  * Entry points to be loaded by Webpack.
  *
@@ -15,20 +15,17 @@ const entries = getConfig( 'entries.config' );
  * @see entries.config.js
  */
 function getEntries() {
-	const matches = {};
-	Object.keys( entries ).forEach( name => {
-		entries[ name ].some( possibleFile => {
-			const filePath = config.workingDirectory + '/src/' + possibleFile;
-			if ( fs.existsSync( path.resolve( filePath ) ) ) {
-				matches[ name ] = path.resolve( filePath );
-				return true;
-			}
-			return false;
-		} );
-	} );
-	return matches;
+    const matches = {};
+    Object.keys(entries).forEach(name => {
+        entries[name].some(possibleFile => {
+            const filePath = (0, package_config_1.getPackageConfig)().workingDirectory + '/src/' + possibleFile;
+            if ((0, fs_1.existsSync)((0, path_1.resolve)(filePath))) {
+                matches[name] = (0, path_1.resolve)(filePath);
+                return true;
+            }
+            return false;
+        });
+    });
+    return matches;
 }
-
-module.exports = {
-	getEntries,
-};
+exports.getEntries = getEntries;

package/helpers/entries.ts

@@ -0,0 +1,30 @@
+import {getConfig} from './config';
+import {getPackageConfig} from './package-config';
+import {existsSync} from 'fs';
+import {resolve} from 'path';
+import type {EntriesConfig} from '../config/entries.config';
+
+const entries: EntriesConfig = getConfig( 'entries.config' );
+
+/**
+ * Entry points to be loaded by Webpack.
+ *
+ * Checks for sources in the order they are defined and creates a
+ * single entry per key if a source file exists.
+ *
+ * @see entries.config.js
+ */
+export function getEntries(): { [ name: string ]: string } {
+	const matches: {[name: string]: string} = {};
+	Object.keys( entries ).forEach( name => {
+		entries[ name ].some( possibleFile => {
+			const filePath = getPackageConfig().workingDirectory + '/src/' + possibleFile;
+			if ( existsSync( resolve( filePath ) ) ) {
+				matches[ name ] = resolve( filePath );
+				return true;
+			}
+			return false;
+		} );
+	} );
+	return matches;
+}

package/helpers/modules.js

@@ -1,7 +1,9 @@
-const areYouES5 = require( 'are-you-es5' );
-const regexBuilder = require( 'are-you-es5/dist/babel-loader-regex-builder' );
-const config = require( './package-config' );
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBabelExcludeRegex = void 0;
+const babel_loader_regex_builder_1 = require("are-you-es5/dist/babel-loader-regex-builder");
+const package_config_1 = require("./package-config");
+const are_you_es5_1 = require("are-you-es5");
 /**
  * Using `are-you-es5` generate a list of top level dependencies
  * which are not ES5 safe. Create a regular expression which excludes
@@ -14,14 +16,13 @@ const config = require( './package-config' );
  * @return {RegExp}
  */
 function getBabelExcludeRegex() {
-	const nonES5 = areYouES5.checkModules( {} );
-	// Support specifying additional es5Modules in package.json.
-	const regex = regexBuilder.getBabelLoaderIgnoreRegex( [ ...nonES5.es6Modules, ...config.es6Modules ] );
-
-	// We must strip off the leading and trailing '/'.
-	return new RegExp( regex.replace( /^\/|\/$/g, '' ) );
+    const nonES5 = (0, are_you_es5_1.checkModules)({});
+    // Support specifying additional es5Modules in package.json.
+    const regex = (0, babel_loader_regex_builder_1.getBabelLoaderIgnoreRegex)([
+        ...nonES5.es6Modules,
+        ...(0, package_config_1.getPackageConfig)().es6Modules,
+    ]);
+    // We must strip off the leading and trailing '/'.
+    return new RegExp(regex.replace(/^\/|\/$/g, ''));
 }
-
-module.exports = {
-	getBabelExcludeRegex,
-};
+exports.getBabelExcludeRegex = getBabelExcludeRegex;

package/helpers/modules.ts

@@ -0,0 +1,26 @@
+import {getBabelLoaderIgnoreRegex} from 'are-you-es5/dist/babel-loader-regex-builder';
+import {getPackageConfig} from './package-config';
+import {checkModules} from 'are-you-es5';
+
+/**
+ * Using `are-you-es5` generate a list of top level dependencies
+ * which are not ES5 safe. Create a regular expression which excludes
+ * the `node_modules` directory except for any ES6 modules.
+ *
+ * Allows Babel to transpile any node_modules which are not available in ES5.
+ *
+ * @notice Only checks packages listed in package.json, not sub packages.
+ *
+ * @return {RegExp}
+ */
+export function getBabelExcludeRegex(): RegExp {
+	const nonES5 = checkModules( {} );
+	// Support specifying additional es5Modules in package.json.
+	const regex = getBabelLoaderIgnoreRegex( [
+		...nonES5.es6Modules,
+		...getPackageConfig().es6Modules,
+	] );
+
+	// We must strip off the leading and trailing '/'.
+	return new RegExp( regex.replace( /^\/|\/$/g, '' ) );
+}

package/helpers/package-config.js

@@ -1,25 +1,27 @@
-const path = require( 'path' );
-const fs = require( 'fs' );
-
-const workingDirectory = fs.realpathSync( process.cwd() );
-let packageConfig = require( path.resolve( workingDirectory, 'package.json' ) );
-packageConfig.brotliFiles ||= false;
-packageConfig.es6Modules ||= [];
-packageConfig.jsPath ||= '';
-// Path of the package.json file (root).
-packageConfig.packageDirectory = workingDirectory;
-packageConfig.url ||= 'http://localhost';
-// Path of JS application files.
-packageConfig.workingDirectory = packageConfig.jsPath !== '' ? path.resolve( packageConfig.jsPath ) : workingDirectory;
-packageConfig.shortCssClasses ||= false;
-packageConfig.tsCssModules ||= false;
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPackageConfig = void 0;
+const path_1 = require("path");
+const node_fs_1 = require("node:fs");
+const workingDirectory = (0, node_fs_1.realpathSync)(process.cwd());
+const defaults = {
+    brotliFiles: false,
+    cssTsFiles: false,
+    es6Modules: [],
+    jsPath: '',
+    packageDirectory: workingDirectory,
+    shortCssClasses: false,
+    url: 'http://localhost',
+};
+let packageConfig = require((0, path_1.resolve)(workingDirectory, 'package.json'));
+packageConfig = { ...defaults, ...packageConfig };
+packageConfig.workingDirectory = packageConfig.jsPath !== '' ? (0, path_1.resolve)(packageConfig.jsPath) : workingDirectory;
 try {
-	const localConfig = require( path.resolve( workingDirectory, './local-config.json' ) );
-	packageConfig = {...packageConfig, ...localConfig};
-} catch ( e ) {
+    const localConfig = require((0, path_1.resolve)(workingDirectory, './local-config.json'));
+    packageConfig = { ...packageConfig, ...localConfig };
+}
+catch (e) {
 }
-
 /**
  * Helper function to get the results of `packageConfig`.
  *
@@ -29,8 +31,9 @@ try {
  * @since 10.3.0
  */
 function getPackageConfig() {
-	return packageConfig;
+    return packageConfig;
 }
+exports.getPackageConfig = getPackageConfig;
 packageConfig.getPackageConfig = getPackageConfig;
-
+packageConfig.default = packageConfig;
 module.exports = packageConfig;

package/helpers/package-config.ts

@@ -0,0 +1,85 @@
+import {resolve} from 'path';
+import {realpathSync} from 'node:fs';
+
+export interface PackageConfig {
+	author?: string;
+	brotliFiles: boolean;
+	certificates?: Certificates;
+	combinedJson: boolean;
+	cssTsFiles: boolean;
+	css_folder: string;
+	default: PackageConfig;
+	dependencies: Dependencies;
+	description?: string;
+	devDependencies: Dependencies;
+	es6Modules: string[];
+	getPackageConfig: () => PackageConfig;
+	jsPath: string;
+	license?: string;
+	name?: string;
+	packageDirectory: string;
+	packageManager?: string;
+	resolutions?: Dependencies;
+	scripts: Partial<Scripts>;
+	shortCssClasses: boolean;
+	url: string;
+	version?: string;
+	workingDirectory: string;
+}
+
+export interface Dependencies {
+	[ name: string ]: string;
+}
+
+export interface Certificates {
+	cert: string;
+	key: string;
+}
+
+export interface Scripts {
+	browserslist: string;
+	dist: string;
+	lint: string;
+	postinstall: string;
+	start: string;
+	test: string;
+}
+
+
+const workingDirectory = realpathSync( process.cwd() );
+
+const defaults: Partial<PackageConfig> = {
+	brotliFiles: false,
+	cssTsFiles: false,
+	es6Modules: [],
+	jsPath: '',
+	packageDirectory: workingDirectory,
+	shortCssClasses: false,
+	url: 'http://localhost',
+}
+
+let packageConfig: PackageConfig = require( resolve( workingDirectory, 'package.json' ) );
+packageConfig = {...defaults, ...packageConfig};
+packageConfig.workingDirectory = packageConfig.jsPath !== '' ? resolve( packageConfig.jsPath ) : workingDirectory;
+
+try {
+	const localConfig = require( resolve( workingDirectory, './local-config.json' ) );
+	packageConfig = {...packageConfig, ...localConfig};
+} catch ( e ) {
+}
+
+/**
+ * Helper function to get the results of `packageConfig`.
+ *
+ * - Allows mocking the results of `packageConfig` for testing.
+ * - Allows getting the config through a callback instead of an import.
+ *
+ * @since 10.3.0
+ */
+export function getPackageConfig() {
+	return packageConfig;
+}
+packageConfig.getPackageConfig = getPackageConfig;
+
+packageConfig.default = packageConfig;
+module.exports = packageConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lipemat/js-boilerplate",
-  "version": "10.8.0-beta.2",
+  "version": "10.8.0-beta.4",
   "description": "Dependencies and scripts for a no config JavaScript app",
   "author": "Mat Lipe",
   "license": "MIT",
@@ -34,9 +34,10 @@
   },
   "scripts": {
     "browserslist": "lipemat-js-boilerplate browserslist",
-    "build": "cd src && tsc && cd .. && eslint 'config/*.config.*' --fix --rule 'camelcase: 0'",
+    "build": "ts-node ./bin/build.ts",
     "prepublishOnly": "yarn run build",
-    "test": "lipemat-js-boilerplate test"
+    "test": "lipemat-js-boilerplate test",
+    "watch": "ts-node ./bin/watch.ts"
   },
   "dependencies": {
     "@babel/core": "^7.4.3",
@@ -98,6 +99,7 @@
   "devDependencies": {
     "@types/jest": "^29.5.3",
     "@types/minimist": "^1",
+    "chokidar": "^3.5.3",
     "eslint": "^8",
     "glob": "^10.3.3",
     "memfs": "^3.5.3",

package/scripts/lint.ts

@@ -2,7 +2,7 @@ import {ESLint} from 'eslint';
 import minimist from 'minimist';
 import chalk from 'chalk';
 
-import packageConfig from '../helpers/package-config';
+import {getPackageConfig} from '../helpers/package-config';
 
 // Command line arguments.
 const flags = minimist( process.argv.slice( 2 ) );
@@ -35,7 +35,7 @@ function errorOccurred( results: ESLint.LintResult[] ): boolean {
 
 	// 2. Lint files. This doesn't modify target files.
 	const results: ESLint.LintResult[] = await eslint.lintFiles( [
-		packageConfig.workingDirectory + '/src/**/*.{js,jsx,ts,tsx}',
+		getPackageConfig().workingDirectory + '/src/**/*.{js,jsx,ts,tsx}',
 	] );
 
 	// 3. Modify the files with the fixed code.

package/config/babel.config.d.ts

@@ -1,13 +0,0 @@
-import type {TransformOptions} from '@babel/core';
-/**
- * @link https://webpack.js.org/loaders/babel-loader/#options
- */
-export type BabelLoader = {
-    cacheDirectory?: boolean | string;
-    cacheIdentifier?: string;
-    cacheCompression?: boolean;
-    customize?: string;
-    metadataSubscribers?: string[];
-};
-declare const babelConfig: TransformOptions & BabelLoader;
-export default babelConfig;

package/config/jest.config.d.ts

@@ -1,3 +0,0 @@
-import type {Config} from 'jest';
-declare const jestConfig: Config;
-export default jestConfig;

package/helpers/config.d.ts

@@ -1,7 +0,0 @@
-/**
- * @todo convert the source to TS.
- */
-
-export function getBrowsersList(): readonly string[];
-
-export function getConfig<T extends object>( fileName: string ): T;

package/helpers/package-config.d.ts

@@ -1,46 +0,0 @@
-export interface PackageConfig {
-	author?: string;
-	brotliFiles: boolean;
-	certificates?: Certificates;
-	combinedJson: boolean;
-	css_folder: string;
-	cssTsFiles: boolean;
-	dependencies: Dependencies;
-	description?: string;
-	devDependencies: Dependencies;
-	es6Modules?: string[];
-	jsPath: string;
-	license?: string;
-	name?: string;
-	packageDirectory: string;
-	packageManager?: string;
-	resolutions?: Dependencies;
-	scripts: Partial<Scripts>;
-	shortCssClasses: boolean;
-	url: string;
-	version?: string;
-	workingDirectory: string;
-}
-
-export interface Dependencies {
-	[ name: string ]: string;
-}
-
-export interface Certificates {
-	cert: string;
-	key: string;
-}
-
-export interface Scripts {
-	browserslist: string;
-	dist: string;
-	lint: string;
-	postinstall: string;
-	start: string;
-	test: string;
-}
-
-declare const packageConfig: PackageConfig & {
-	getPackageConfig: () => PackageConfig;
-};
-export default packageConfig;