@lipemat/js-boilerplate 8.0.0 → 8.2.0

package/README.md

@@ -15,12 +15,6 @@ A zero configuration starting point for a React or non React app.
 yarn add @lipemat/js-boilerplate
 ```
 
-## Version 7
-
-**Version 7 has some backward incompatibilities and should be updated with focus and thoroughness.**
-
-[Migration instructions are here.](https://github.com/lipemat/js-boilerplate/wiki/Version-7-Migration)
-
 ## Usage
 Add the following to your package.json. (this may also be found in the `templates` directory.
 
@@ -85,9 +79,6 @@ Babel will automatically compile TypeScript files into the finished javascript,
 All configurations are found in the `config` directory and may be extended by adding a matching file within your project directory.
 For instance is you want to adjust `webpack.dev.js` you may add a `config/webpack.dev.js` file in your project directory.
 
-**@note** The `jsPath` will be taken into account so if you specified a `jsPath` the `config` directory must be placed
-inside it. (e.g. `js/config/wepack.dev.js`).
-
 All declarations are merged in favor of the project config.
 
 ### Extensions

package/config/webpack.dev.js

@@ -17,7 +17,7 @@ const plugins = [
 	} ),
 ];
 
-// Loads a thread which verifies any TypeScripts on changes.
+// Loads a thread, which verifies any TypeScripts on changes.
 // Only use this if the project has a tsconfig.json file.
 if ( configHelper.hasLocalOverride( 'tsconfig.json', true ) ) {
 	plugins.push( new ForkTsCheckerWebpackPlugin( {

package/helpers/config.js

@@ -8,19 +8,19 @@ const extensions = Object.keys( packageConfig.dependencies ).filter( name => nam
 /**
  * Check to see if a local config file exists.
  *
- * @param {string} $fileName
- * @param {boolean} $inRoot - Look in the root their project directory instead of their /config directory
+ * @param {string} fileName
+ * @param {boolean} inWorkingDirectory - Look in working directory instead of their /config directory
  *
  * @return {boolean}
  */
-function hasLocalOverride( $fileName, $inRoot = false ) {
+function hasLocalOverride( fileName, inWorkingDirectory = false ) {
 	let hasLocal = false;
 	try {
-		if ( $inRoot ) {
-			require( path.resolve( packageConfig.workingDirectory, $fileName ) );
+		if ( inWorkingDirectory ) {
+			require( path.resolve( packageConfig.workingDirectory, fileName ) );
 			hasLocal = true;
 		} else {
-			require( path.resolve( packageConfig.workingDirectory + '/config', $fileName ) );
+			require( path.resolve( packageConfig.packageDirectory + '/config', fileName ) );
 			hasLocal = true;
 		}
 	} catch ( e ) {
@@ -44,7 +44,7 @@ function hasLocalOverride( $fileName, $inRoot = false ) {
 function getConfig( $fileName ) {
 	let config = {...require( '../config/' + $fileName ), ...getExtensionsConfig( $fileName )};
 	try {
-		const localConfig = require( path.resolve( packageConfig.workingDirectory + '/config', $fileName ) );
+		const localConfig = require( path.resolve( packageConfig.packageDirectory + '/config', $fileName ) );
 		config = {...config, ...localConfig};
 	} catch ( e ) {
 	}
@@ -52,8 +52,8 @@ function getConfig( $fileName ) {
 }
 
 /**
- * Get a config from any existing extension's /config directory's
- * merged together into one.
+ * Get a config from any existing extension's /config directories
+ * merged into one.
  *
  * @param {string} $fileName
  *

package/helpers/package-config.js

@@ -6,10 +6,13 @@ const fs = require( 'fs' );
 const workingDirectory = fs.realpathSync( process.cwd() );
 
 let packageConfig = require( path.resolve( workingDirectory, 'package.json' ) );
-packageConfig.workingDirectory = packageConfig.jsPath ? path.resolve( packageConfig.jsPath ) : workingDirectory;
+packageConfig.es6Modules = packageConfig.es6Modules || [];
+// Path of the package.json file (root).
+packageConfig.packageDirectory = workingDirectory;
 packageConfig.themeUrlPath = packageConfig.themeUrlPath || '/';
 packageConfig.url = packageConfig.url || 'http://localhost';
-packageConfig.es6Modules = packageConfig.es6Modules || [];
+// Path of JS application files.
+packageConfig.workingDirectory = packageConfig.jsPath ? path.resolve( packageConfig.jsPath ) : workingDirectory;
 
 try {
 	const localConfig = require( path.resolve( workingDirectory, './local-config.json' ) );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lipemat/js-boilerplate",
-  "version": "8.0.0",
+  "version": "8.2.0",
   "description": "Dependencies and scripts for a no config JavaScript app",
   "engines": {
     "node": ">=14.17.6"
@@ -37,7 +37,7 @@
     "@babel/preset-typescript": "^7.12.7",
     "@hot-loader/react-dom": "^17.0.1",
     "@lipemat/css-mqpacker": "^8.0.1",
-    "@lipemat/eslint-config": "^1.1.1",
+    "@lipemat/eslint-config": "^2.0.1",
     "@lipemat/postcss-loader": "^3.1.2",
     "@lipemat/webpack-cleanup-plugin": "^1.0.0",
     "@types/lipemat__js-boilerplate": "lipemat/types-js-boilerplate#semver:^1.3.0",

package/scripts/lint.js

@@ -1,4 +1,36 @@
-const eslint = require( 'eslint/lib/cli' );
+const {ESLint} = require( 'eslint' );
 const packageConfig = require( '../helpers/package-config' );
 
-eslint.execute( [ '', '', packageConfig.workingDirectory + '/src', '--fix', '--ext', '.tsx,.ts,.js,.jsx' ] );
+/**
+ * Use the public API to run the eslint commands.
+ *
+ * @link https://eslint.org/docs/developer-guide/nodejs-api
+ */
+( async function main() {
+	// 1. Create an instance with the `fix` option.
+	const eslint = new ESLint( {
+		fix: true,
+	} );
+
+	// 2. Lint files. This doesn't modify target files.
+	const results = await eslint.lintFiles( [
+		packageConfig.workingDirectory + '/src/**/*.{js,jsx,ts,tsx}',
+	] );
+
+	// 3. Modify the files with the fixed code.
+	await ESLint.outputFixes( results );
+
+	// 4. Format the results.
+	const formatter = await eslint.loadFormatter( 'stylish' );
+	const resultText = formatter.format( results );
+
+	// 5. Output it.
+	console.log( resultText );
+	if ( '' === resultText ) {
+		console.log( '>> Linted JS files without errors.' );
+		console.log( '-----------------------------------' );
+	}
+}() ).catch( error => {
+	process.exitCode = 1;
+	console.error( error );
+} );