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

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.js`
+1. `jest.config.ts`
 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.js`.
+2. __Working directory__: root of your app which contains the `jest.config.ts`.
 3. "All tests" to run an entire directory of tests.
 4. "Suite" to run a particular file of tests.
 

package/config/jest.config.ts

@@ -2,7 +2,7 @@ import type {Config} from 'jest';
 import {resolve} from 'path';
 const {getPackageConfig} = require( '../helpers/package-config' );
 const {existsSync} = require( 'fs' );
-const {getConfig} = require( '../helpers/config' );
+import {getConfig} from '../helpers/config';
 
 const packageConfig = getPackageConfig();
 const babelConfig = getConfig( 'babel.config' );
@@ -43,9 +43,9 @@ let jestConfig: Config = {
  * @todo Remove in version 11.
  */
 try {
-	const localConfig = require( resolve( packageConfig.workingDirectory + '/config', 'jest.config.js' ) );
+	const localConfig = require( resolve( packageConfig.workingDirectory + '/config', 'jest.config.ts' ) );
 	jestConfig = {...jestConfig, ...localConfig};
 } catch ( e ) {
 }
 
-module.exports = jestConfig;
+export default jestConfig;

package/config/tsconfig.json

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

package/helpers/config.ts

@@ -16,8 +16,8 @@ const extensions = [
  *
  * @return {boolean}
  */
-function hasLocalOverride( fileName, inWorkingDirectory = false, ) {
-	let hasLocal = false;
+function hasLocalOverride( fileName: string, inWorkingDirectory = false, ) {
+	let hasLocal: boolean = false;
 	const packageConfig = getPackageConfig();
 	try {
 		if ( inWorkingDirectory ) {
@@ -61,7 +61,7 @@ function hasLocalOverride( fileName, inWorkingDirectory = false, ) {
  *
  * @return {Object}
  */
-function getConfig( fileName ) {
+export function getConfig( fileName: string ) {
 	const packageConfig = getPackageConfig();
 	let mergedConfig = require( '../config/' + fileName );
 	mergedConfig = {...mergedConfig, ...getExtensionsConfig( fileName, mergedConfig )};
@@ -89,8 +89,8 @@ function getConfig( fileName ) {
  *
  * @return {Object}
  */
-function getExtensionsConfig( fileName, defaultConfig ) {
-	let mergedConfig = {};
+function getExtensionsConfig( fileName: string, defaultConfig: Record<string, any> ) {
+	let mergedConfig: Record<string, any> = {};
 	extensions.forEach( extension => {
 		try {
 			const extensionConfig = require( extension + '/config/' + fileName );
@@ -173,6 +173,10 @@ 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.js → modules.ts}

@@ -1,5 +1,5 @@
-const areYouES5 = require( 'are-you-es5' );
-const regexBuilder = require( 'are-you-es5/dist/babel-loader-regex-builder' );
+import {checkModules} from 'are-you-es5';
+import {getBabelLoaderIgnoreRegex} from 'are-you-es5/dist/babel-loader-regex-builder';
 const config = require( './package-config' );
 
 /**
@@ -13,15 +13,11 @@ const config = require( './package-config' );
  *
  * @return {RegExp}
  */
-function getBabelExcludeRegex() {
-	const nonES5 = areYouES5.checkModules( {} );
+export function getBabelExcludeRegex() {
+	const nonES5 = checkModules( {} );
 	// Support specifying additional es5Modules in package.json.
-	const regex = regexBuilder.getBabelLoaderIgnoreRegex( [ ...nonES5.es6Modules, ...config.es6Modules ] );
+	const regex = 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

@@ -1,4 +1,4 @@
-import {resolve} from 'path';
+const {resolve} = require( 'path' );
 import {realpathSync} from 'fs';
 
 const workingDirectory = realpathSync( process.cwd() );
@@ -30,8 +30,7 @@ try {
 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,10 +1,9 @@
 {
   "name": "@lipemat/js-boilerplate",
-  "version": "10.4.0-beta.3",
+  "version": "10.4.0-beta.4",
   "description": "Dependencies and scripts for a no config JavaScript app",
   "author": "Mat Lipe",
   "license": "MIT",
-  "type": "commonjs",
   "engines": {
     "node": ">=16.14.2"
   },

package/scripts/test.ts

@@ -1,16 +1,19 @@
-import path from 'path';
-import fs from 'fs';
+const {resolve: pathResolve} = require( 'path' );
+const {existsSync} = require( 'fs' );
 
-const packageConfig = require( '../helpers/package-config' );
+import {getPackageConfig} from '../helpers/package-config';
+
+const packageConfig = getPackageConfig();
 
 const possibleConfig = [
 	// @todo Remove pulling from the root on next major release.
-	path.resolve( packageConfig.workingDirectory + '/jest.config.js' ),
+	pathResolve( packageConfig.workingDirectory + '/jest.config.ts' ),
+	pathResolve( 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 );
+	pathResolve( packageConfig.workingDirectory + '/jest/jest.config.ts' ),
+	pathResolve( packageConfig.workingDirectory + '/jest/jest.config.js' ),
+].filter( 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.' );

package/tsconfig.json

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

package/config/jest.config.js

@@ -1,58 +0,0 @@
-/**
- * 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.ts' );
-const fs = require( 'fs' );
-
-const babelConfig = require( '../helpers/config.ts' ).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: [
-		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.[tj]s` 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;