@lipemat/js-boilerplate 10.4.0-beta.4 → 10.4.0-beta.6

package/README.md

@@ -88,7 +88,7 @@ This is useful when you have often reused overrides to support a particular libr
 
 ### Testing
 To use the built in testing, copy the following items from `templates` into your project root:
-1. `jest.config.ts`
+1. `jest.config.js`
 2. `tests`
 
 Now you may write `jest` tests as desired and run them via `yarn run test` 
@@ -96,7 +96,7 @@ Now you may write `jest` tests as desired and run them via `yarn run test`
 
 **Alternatively you may create a [run configuration](https://www.jetbrains.com/help/phpstorm/running-unit-tests-on-jest.html#createRunConfigJest) in PHPStorm for an interactive testing experience.**
 1. __Jest package__: `<project root>/node_modules/jest-cli`
-2. __Working directory__: root of your app which contains the `jest.config.ts`.
+2. __Working directory__: root of your app which contains the `jest.config.js`.
 3. "All tests" to run an entire directory of tests.
 4. "Suite" to run a particular file of tests.
 

package/bin/lipemat-js-boilerplate.js

@@ -15,10 +15,6 @@ const scriptIndex = args.findIndex(
 const script = -1 === scriptIndex ? args[ 0 ] : args[ scriptIndex ];
 const nodeArgs = scriptIndex > 0 ? args.slice( 0, scriptIndex ) : [];
 
-const TS_CONVERTED = [
-	'test',
-];
-
 switch ( script ) {
 	case 'browserslist':
 	case 'dist':
@@ -36,7 +32,7 @@ switch ( script ) {
 		const result = spawn.sync(
 			'ts-node',
 			nodeArgs
-				.concat( require.resolve( '../scripts/' + script + ( TS_CONVERTED.includes( script ) ? '.ts' : '.js' ) ) )
+				.concat( require.resolve( '../scripts/' + script ) )
 				.concat( args.slice( scriptIndex + 1 ) ),
 			{stdio: 'inherit'}
 		);

package/config/jest.config.js

@@ -0,0 +1,51 @@
+// So we have something to check against for adjusting things like babel.config.js.
+global.__TEST__ = true;
+
+const path = require( 'path' );
+const packageConfig = require( '../helpers/package-config' );
+const fs = require( 'fs' );
+
+const babelConfig = require( '../helpers/config' ).getConfig( 'babel.config' );
+delete babelConfig.cacheDirectory;
+
+let 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 ],
+	},
+	setupFilesAfterEnv: [
+		// @todo Remove old "tests" directory on next major release.
+		path.resolve( packageConfig.workingDirectory, 'tests/setup.js' ),
+		path.resolve( packageConfig.workingDirectory, 'tests/setup.ts' ),
+
+		// New location.
+		path.resolve( packageConfig.workingDirectory, 'jest/setup.ts' ),
+	].filter( fs.existsSync ),
+};
+
+/**
+ * Allows overriding configurations in the project `/config/jest.config.js` file.
+ * We don't actually need to do this because `jest.config.js` in the project root
+ * is already an override of this file, but we support it anyway to keep things consistent.
+ */
+try {
+	const localConfig = require( path.resolve( packageConfig.workingDirectory + '/config', 'jest.config.js' ) );
+	jestConfig = {...jestConfig, ...localConfig};
+} catch ( e ) {
+}
+
+module.exports = jestConfig;

package/config/tsconfig.json

@@ -5,20 +5,18 @@
   "display": "JS Boilerplate",
   "compilerOptions": {
     "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "jsx": "preserve",
     "lib": [
       "dom",
       "es2018"
     ],
-    "module": "Node16",
+    "module": "ESNext",
     "moduleResolution": "Node",
     "noFallthroughCasesInSwitch": true,
     "noImplicitReturns": true,
     "noImplicitThis": true,
     "sourceMap": true,
-    "strict": false,
     "strictBindCallApply": true,
     "strictNullChecks": true,
     "target": "es6",

package/config/webpack.dist.js

@@ -36,12 +36,6 @@ const plugins = [
 		// Remove all files except the `.running` file created by "Start".
 		cleanOnceBeforeBuildPatterns: [ '**/*', '!.running' ],
 	} ),
-	new ForkTsCheckerWebpackPlugin( {
-		formatter: 'basic',
-		typescript: {
-			configFile: getTsConfigFile(),
-		},
-	} ),
 	new SubresourceIntegrityPlugin( {
 		hashFuncNames: [ 'sha384' ],
 	} ),
@@ -49,6 +43,16 @@ const plugins = [
 	ManifestPlugin,
 ];
 
+// Loads a thread, which verifies any TypeScripts if project has a "tsconfig.json" file.
+if ( '' !== getTsConfigFile() ) {
+	plugins.push( new ForkTsCheckerWebpackPlugin( {
+		formatter: 'basic',
+		typescript: {
+			configFile: getTsConfigFile(),
+		},
+	} ) );
+}
+
 /**
  * Generate .br files if enabled.
  *

package/helpers/{config.ts → config.js}

@@ -1,11 +1,12 @@
-import {getPackageConfig} from './package-config';
+const packageConfig = require( './package-config' );
 const path = require( 'path' );
 const browserslist = require( 'browserslist' );
 const fs = require( 'fs' );
+const config = require( './package-config' );
 
 const extensions = [
-	...Object.keys( getPackageConfig().dependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
-	...Object.keys( getPackageConfig().devDependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
+	...Object.keys( packageConfig.dependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
+	...Object.keys( packageConfig.devDependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
 ];
 
 /**
@@ -16,9 +17,8 @@ const extensions = [
  *
  * @return {boolean}
  */
-function hasLocalOverride( fileName: string, inWorkingDirectory = false, ) {
-	let hasLocal: boolean = false;
-	const packageConfig = getPackageConfig();
+function hasLocalOverride( fileName, inWorkingDirectory = false, ) {
+	let hasLocal = false;
 	try {
 		if ( inWorkingDirectory ) {
 			require( path.resolve( packageConfig.workingDirectory, fileName ) );
@@ -61,8 +61,7 @@ function hasLocalOverride( fileName: string, inWorkingDirectory = false, ) {
  *
  * @return {Object}
  */
-export function getConfig( fileName: string ) {
-	const packageConfig = getPackageConfig();
+function getConfig( fileName ) {
 	let mergedConfig = require( '../config/' + fileName );
 	mergedConfig = {...mergedConfig, ...getExtensionsConfig( fileName, mergedConfig )};
 	try {
@@ -89,8 +88,8 @@ export function getConfig( fileName: string ) {
  *
  * @return {Object}
  */
-function getExtensionsConfig( fileName: string, defaultConfig: Record<string, any> ) {
-	let mergedConfig: Record<string, any> = {};
+function getExtensionsConfig( fileName, defaultConfig ) {
+	let mergedConfig = {};
 	extensions.forEach( extension => {
 		try {
 			const extensionConfig = require( extension + '/config/' + fileName );
@@ -118,15 +117,14 @@ function getExtensionsConfig( fileName: string, defaultConfig: Record<string, an
  * @return {string}
  */
 function getTsConfigFile() {
-	const packageConfig = getPackageConfig();
 	const possibles = [
 		// Backward compatible for before @lipemat/eslint-config version 3.
-		path.resolve( packageConfig.workingDirectory + '/tsconfig.json' ),
-		path.resolve( packageConfig.packageDirectory + '/tsconfig.json' ),
+		path.resolve( config.workingDirectory + '/tsconfig.json' ),
+		path.resolve( config.packageDirectory + '/tsconfig.json' ),
 	];
 	let tsConfig = '';
 	possibles.forEach( filePath => {
-		if ( Boolean( fs.existsSync( filePath ) ) ) {
+		if ( fs.existsSync( filePath ) ) {
 			tsConfig = filePath;
 		}
 	} );
@@ -173,10 +171,7 @@ const getDefaultBrowsersList = () => {
 	return false;
 };
 
-/**
- * @notice This module must remain CommonJS for use with Jest.
- *         It is loaded before TS is loaded by Jest.
- */
+
 module.exports = {
 	getBrowsersList,
 	getConfig,

package/helpers/{modules.ts → modules.js}

@@ -1,5 +1,5 @@
-import {checkModules} from 'are-you-es5';
-import {getBabelLoaderIgnoreRegex} from 'are-you-es5/dist/babel-loader-regex-builder';
+const areYouES5 = require( 'are-you-es5' );
+const regexBuilder = require( 'are-you-es5/dist/babel-loader-regex-builder' );
 const config = require( './package-config' );
 
 /**
@@ -13,11 +13,15 @@ const config = require( './package-config' );
  *
  * @return {RegExp}
  */
-export function getBabelExcludeRegex() {
-	const nonES5 = checkModules( {} );
+function getBabelExcludeRegex() {
+	const nonES5 = areYouES5.checkModules( {} );
 	// Support specifying additional es5Modules in package.json.
-	const regex = getBabelLoaderIgnoreRegex( [ ...nonES5.es6Modules, ...config.es6Modules ] );
+	const regex = regexBuilder.getBabelLoaderIgnoreRegex( [ ...nonES5.es6Modules, ...config.es6Modules ] );
 
 	// We must strip off the leading and trailing '/'.
 	return new RegExp( regex.replace( /^\/|\/$/g, '' ) );
 }
+
+module.exports = {
+	getBabelExcludeRegex,
+};

package/helpers/{package-config.ts → package-config.js}

@@ -1,8 +1,8 @@
-const {resolve} = require( 'path' );
-import {realpathSync} from 'fs';
+const path = require( 'path' );
+const fs = require( 'fs' );
 
-const workingDirectory = realpathSync( process.cwd() );
-let packageConfig = require( resolve( workingDirectory, 'package.json' ) );
+const workingDirectory = fs.realpathSync( process.cwd() );
+let packageConfig = require( path.resolve( workingDirectory, 'package.json' ) );
 packageConfig.brotliFiles ||= false;
 packageConfig.es6Modules ||= [];
 packageConfig.jsPath ||= '';
@@ -10,11 +10,11 @@ packageConfig.jsPath ||= '';
 packageConfig.packageDirectory = workingDirectory;
 packageConfig.url ||= 'http://localhost';
 // Path of JS application files.
-packageConfig.workingDirectory = packageConfig.jsPath !== '' ? resolve( packageConfig.jsPath ) : workingDirectory;
+packageConfig.workingDirectory = packageConfig.jsPath !== '' ? path.resolve( packageConfig.jsPath ) : workingDirectory;
 packageConfig.shortCssClasses ||= false;
 
 try {
-	const localConfig = require( resolve( workingDirectory, './local-config.json' ) );
+	const localConfig = require( path.resolve( workingDirectory, './local-config.json' ) );
 	packageConfig = {...packageConfig, ...localConfig};
 } catch ( e ) {
 }
@@ -27,10 +27,9 @@ try {
  *
  * @since 10.3.0
  */
-export function getPackageConfig() {
+function getPackageConfig() {
 	return packageConfig;
 }
-
 packageConfig.getPackageConfig = getPackageConfig;
 
 module.exports = packageConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lipemat/js-boilerplate",
-  "version": "10.4.0-beta.4",
+  "version": "10.4.0-beta.6",
   "description": "Dependencies and scripts for a no config JavaScript app",
   "author": "Mat Lipe",
   "license": "MIT",
@@ -78,7 +78,6 @@
     "react-dom": "^18.2.0",
     "react-refresh": "^0.14.0",
     "style-loader": "^3.3.1",
-    "ts-node": "^10.9.1",
     "typescript": "^5.1.3",
     "update-notifier": "^4.1.3",
     "webpack": "^5.72.1",

package/scripts/{test.ts → test.js}

@@ -1,7 +1,7 @@
 const {resolve: pathResolve} = require( 'path' );
 const {existsSync} = require( 'fs' );
 
-import {getPackageConfig} from '../helpers/package-config';
+const {getPackageConfig} = require( '../helpers/package-config' );
 
 const packageConfig = getPackageConfig();
 

package/tsconfig.json

@@ -2,14 +2,15 @@
   "extends": "./config/tsconfig.json",
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "JS Boilerplate",
+  "compilerOptions": {
+    "module": "CommonJS"
+  },
   "include": [
-    "jest.config.js",
-    "jest.config.ts",
     "bin/**/*",
     "config/**/*",
     "helpers/**/*",
     "lib/**/*",
-    "scripts/**/*",
-    "tests/**/*",
+    "jest/**/*",
+    "scripts/**/*"
   ]
 }

package/config/jest.config.ts

@@ -1,51 +0,0 @@
-import type {Config} from 'jest';
-import {resolve} from 'path';
-const {getPackageConfig} = require( '../helpers/package-config' );
-const {existsSync} = require( 'fs' );
-import {getConfig} from '../helpers/config';
-
-const packageConfig = getPackageConfig();
-const babelConfig = getConfig( 'babel.config' );
-delete babelConfig.cacheDirectory;
-
-let 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: packageConfig.url,
-	},
-	transform: {
-		'^.+\\.[tj]sx?$': [ 'babel-jest', babelConfig ],
-	},
-	setupFilesAfterEnv: [
-		// @todo Remove old "tests" directory on next major release.
-		resolve( packageConfig.workingDirectory, 'tests/setup.js' ),
-		resolve( packageConfig.workingDirectory, 'tests/setup.ts' ),
-
-		// New location.
-		resolve( packageConfig.workingDirectory, 'jest/setup.ts' ),
-	].filter( existsSync ),
-};
-
-/**
- * Never ended up using this.
- *
- * @todo Remove in version 11.
- */
-try {
-	const localConfig = require( resolve( packageConfig.workingDirectory + '/config', 'jest.config.ts' ) );
-	jestConfig = {...jestConfig, ...localConfig};
-} catch ( e ) {
-}
-
-export default jestConfig;