@lipemat/js-boilerplate 10.4.0-beta.1 → 10.4.0-beta.3

package/bin/lipemat-js-boilerplate.js

@@ -15,6 +15,10 @@ 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':
@@ -32,7 +36,7 @@ switch ( script ) {
 		const result = spawn.sync(
 			'ts-node',
 			nodeArgs
-				.concat( require.resolve( '../scripts/' + script ) )
+				.concat( require.resolve( '../scripts/' + script + ( TS_CONVERTED.includes( script ) ? '.ts' : '.js' ) ) )
 				.concat( args.slice( scriptIndex + 1 ) ),
 			{stdio: 'inherit'}
 		);

package/config/jest.config.js

@@ -1,11 +1,21 @@
-// So we have something to check against for adjusting things like babel.config.js.
-global.__TEST__ = true;
+/**
+ * Kept here for backward compatibility.
+ *
+ * @deprecated
+ *
+ * @todo Remove on next major release.
+ *
+ * @see jest.config.ts
+ */
+
+// Necessary because some of the boilerplate code is written in TypeScript.
+require( 'ts-node/register' );
 
 const path = require( 'path' );
-const packageConfig = require( '../helpers/package-config' );
+const packageConfig = require( '../helpers/package-config.ts' );
 const fs = require( 'fs' );
 
-const babelConfig = require( '../helpers/config' ).getConfig( 'babel.config' );
+const babelConfig = require( '../helpers/config.ts' ).getConfig( 'babel.config' );
 delete babelConfig.cacheDirectory;
 
 let jestConfig = {
@@ -30,12 +40,13 @@ let jestConfig = {
 	setupFilesAfterEnv: [
 		path.resolve( packageConfig.workingDirectory, 'tests/setup.js' ),
 		path.resolve( packageConfig.workingDirectory, 'tests/setup.ts' ),
+		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
+ * We don't actually need to do this because `jest.config.[tj]s` in the project root
  * is already an override of this file, but we support it anyway to keep things consistent.
  */
 try {

package/config/jest.config.ts

@@ -0,0 +1,51 @@
+import type {Config} from 'jest';
+import {resolve} from 'path';
+const {getPackageConfig} = require( '../helpers/package-config' );
+const {existsSync} = require( 'fs' );
+const {getConfig} = require( '../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.js' ) );
+	jestConfig = {...jestConfig, ...localConfig};
+} catch ( e ) {
+}
+
+module.exports = jestConfig;

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

@@ -1,12 +1,11 @@
-const packageConfig = require( './package-config' );
+import {getPackageConfig} from './package-config';
 const path = require( 'path' );
 const browserslist = require( 'browserslist' );
 const fs = require( 'fs' );
-const config = require( './package-config' );
 
 const extensions = [
-	...Object.keys( packageConfig.dependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
-	...Object.keys( packageConfig.devDependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
+	...Object.keys( getPackageConfig().dependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
+	...Object.keys( getPackageConfig().devDependencies ?? {} ).filter( name => name.includes( 'js-boilerplate-' ) ),
 ];
 
 /**
@@ -19,6 +18,7 @@ const extensions = [
  */
 function hasLocalOverride( fileName, inWorkingDirectory = false, ) {
 	let hasLocal = false;
+	const packageConfig = getPackageConfig();
 	try {
 		if ( inWorkingDirectory ) {
 			require( path.resolve( packageConfig.workingDirectory, fileName ) );
@@ -62,6 +62,7 @@ function hasLocalOverride( fileName, inWorkingDirectory = false, ) {
  * @return {Object}
  */
 function getConfig( fileName ) {
+	const packageConfig = getPackageConfig();
 	let mergedConfig = require( '../config/' + fileName );
 	mergedConfig = {...mergedConfig, ...getExtensionsConfig( fileName, mergedConfig )};
 	try {
@@ -117,14 +118,15 @@ function getExtensionsConfig( fileName, defaultConfig ) {
  * @return {string}
  */
 function getTsConfigFile() {
+	const packageConfig = getPackageConfig();
 	const possibles = [
 		// Backward compatible for before @lipemat/eslint-config version 3.
-		path.resolve( config.workingDirectory + '/tsconfig.json' ),
-		path.resolve( config.packageDirectory + '/tsconfig.json' ),
+		path.resolve( packageConfig.workingDirectory + '/tsconfig.json' ),
+		path.resolve( packageConfig.packageDirectory + '/tsconfig.json' ),
 	];
 	let tsConfig = '';
 	possibles.forEach( filePath => {
-		if ( fs.existsSync( filePath ) ) {
+		if ( Boolean( fs.existsSync( filePath ) ) ) {
 			tsConfig = filePath;
 		}
 	} );
@@ -171,7 +173,6 @@ const getDefaultBrowsersList = () => {
 	return false;
 };
 
-
 module.exports = {
 	getBrowsersList,
 	getConfig,

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

@@ -1,8 +1,8 @@
-const path = require( 'path' );
-const fs = require( 'fs' );
+import {resolve} from 'path';
+import {realpathSync} from 'fs';
 
-const workingDirectory = fs.realpathSync( process.cwd() );
-let packageConfig = require( path.resolve( workingDirectory, 'package.json' ) );
+const workingDirectory = realpathSync( process.cwd() );
+let packageConfig = require( 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 !== '' ? path.resolve( packageConfig.jsPath ) : workingDirectory;
+packageConfig.workingDirectory = packageConfig.jsPath !== '' ? resolve( packageConfig.jsPath ) : workingDirectory;
 packageConfig.shortCssClasses ||= false;
 
 try {
-	const localConfig = require( path.resolve( workingDirectory, './local-config.json' ) );
+	const localConfig = require( resolve( workingDirectory, './local-config.json' ) );
 	packageConfig = {...packageConfig, ...localConfig};
 } catch ( e ) {
 }
@@ -27,9 +27,11 @@ try {
  *
  * @since 10.3.0
  */
-function getPackageConfig() {
+export function getPackageConfig() {
 	return packageConfig;
 }
 packageConfig.getPackageConfig = getPackageConfig;
 
+// Leaving old export structure for backwards compatibility.
+// @todo Remove in favor of default export in version 11.
 module.exports = packageConfig;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@lipemat/js-boilerplate",
-  "version": "10.4.0-beta.1",
+  "version": "10.4.0-beta.3",
   "description": "Dependencies and scripts for a no config JavaScript app",
   "author": "Mat Lipe",
   "license": "MIT",
+  "type": "commonjs",
   "engines": {
     "node": ">=16.14.2"
   },
@@ -23,6 +24,7 @@
     "no-config"
   ],
   "files": [
+    "tsconfig.json",
     "bin/",
     "config/",
     "helpers/",
@@ -77,6 +79,7 @@
     "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

@@ -0,0 +1,24 @@
+import path from 'path';
+import fs from 'fs';
+
+const packageConfig = require( '../helpers/package-config' );
+
+const possibleConfig = [
+	// @todo Remove pulling from the root on next major release.
+	path.resolve( packageConfig.workingDirectory + '/jest.config.js' ),
+
+	// New location.
+	path.resolve( packageConfig.workingDirectory + '/jest/jest.config.js' ),
+	path.resolve( packageConfig.workingDirectory + '/jest/jest.config.ts' ),
+].filter( fs.existsSync );
+
+if ( possibleConfig.length < 1 ) {
+	throw new Error( 'You must have a `jest.config.[tj]s` file in the root of your project or in the `jest` folder.' );
+} else {
+	const file = possibleConfig.shift();
+	if ( undefined !== file ) {
+		process.argv.push( '--config', file );
+	}
+}
+
+require( 'jest-cli/bin/jest' );

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./config/tsconfig.json",
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "JS Boilerplate",
+  "include": [
+    "bin/**/*",
+    "config/**/*",
+    "helpers/**/*",
+    "lib/**/*",
+    "scripts/**/*"
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "module": "CommonJS"
+  }
+}

package/scripts/test.js

@@ -1,12 +0,0 @@
-/**
- * Runs `jest` with any arguments passed via the terminal or yarn.
- *
- * @notice you must add `/templates/jest.config.js` to the `jsPath` of your project.
- *
- * @example `lipemat-js-boilerplate test`
- */
-
-const packageConfig = require( '../helpers/package-config' );
-process.argv.push( '--config', packageConfig.workingDirectory + '/jest.config.js' );
-
-require( 'jest-cli/bin/jest' );