@penskemediacorp/larva 1.67.0 → 1.68.0

package/lib/generateStatic.js

@@ -18,14 +18,12 @@ const themeAssetsConfig = getAppConfiguration( 'themeAssets' );
  * of each route, and write the content to directory structure that
  * mirrors the pattern routes.
  *
- * @param {Array} routesArr  An array of routes in a pattern server, excluding the pattern source (i.e. larva or project).
- *                           This is the result of getPatternRoutes.
- * @param {string} buildPath A directory where the HTML files should be written.
- * @param {Function} done    A callback function to run when the site generation completes.
- * @param {string} urlBase   The base URL for the pattern library e.g. 'http://localhost:3001/larva'.
- *                           Pattern routes will be appended to this. Should not end in slash.
- *
- * @see {@link getPatternRoutes}.
+ * @param {Array}    routesArr An array of routes in a pattern server, excluding the pattern source (i.e. larva or project).
+ *                             This is the result of getPatternRoutes.
+ * @param {string}   buildPath A directory where the HTML files should be written.
+ * @param {Function} done      A callback function to run when the site generation completes.
+ * @param {string}   urlBase   The base URL for the pattern library e.g. 'http://localhost:3001/larva'.
+ *                             Pattern routes will be appended to this. Should not end in slash.
  */
 
 module.exports = function generateStatic(
@@ -40,6 +38,7 @@ module.exports = function generateStatic(
 
 	// Copy assets from assets/build and assets/public
 	// to the static site build directory.
+	// eslint-disable-next-line no-console
 	console.log( '\nCopying assets...\n' );
 
 	// assets/public dir contains fonts and non-built things.
@@ -78,6 +77,7 @@ module.exports = function generateStatic(
 	// Build the site.
 	// Cycle through the list of routes and write the response
 	// to files.
+	// eslint-disable-next-line no-console
 	console.log( '\nBuilding site...\n' );
 
 	try {
@@ -94,6 +94,7 @@ module.exports = function generateStatic(
 							`${ dir }/index.html`,
 							response.data
 						);
+						// eslint-disable-next-line no-console
 						console.log( `Built ${ route }.` );
 					}
 				} )
@@ -104,6 +105,7 @@ module.exports = function generateStatic(
 						mkdirp.sync( dir );
 						fs.writeFileSync( `${ dir }/index.html`, e.message );
 
+						// eslint-disable-next-line no-console
 						console.log(
 							chalk.yellow(
 								`Error writing ${ route }: ${ e.message }.`
@@ -117,6 +119,7 @@ module.exports = function generateStatic(
 			.all( promises )
 			.then( () => {
 				if ( errors.length > 0 ) {
+					// eslint-disable-next-line no-console
 					console.log( errors );
 				}
 
@@ -132,6 +135,7 @@ module.exports = function generateStatic(
 				done( chalk.bold.red( e ) );
 			} );
 	} catch ( e ) {
+		// eslint-disable-next-line no-console
 		console.error( e );
 	}
 };

package/lib/server.js

@@ -231,6 +231,7 @@ app.get( '/:source/:type/:name/:variant?', function ( req, res ) {
 		.catch( ( e ) => {
 			const errorMessage = `Cannot render template! \n\n${ e }`;
 
+			// eslint-disable-next-line no-console
 			console.log( e );
 
 			res.end( errorMessage );
@@ -287,6 +288,7 @@ app.get( '/:source?/style-guide', function ( req, res ) {
 		.catch( ( e ) => {
 			const errorMessage = `Cannot render template! \n\n${ e }`;
 
+			// eslint-disable-next-line no-console
 			console.log( e );
 
 			res.end( errorMessage );

package/lib/start.js

@@ -3,5 +3,6 @@ const app = require( './server' );
 const port = process.env.NODE_PORT || 3000;
 
 app.listen( port, () => {
+	// eslint-disable-next-line no-console
 	console.log( 'Larva server is listening on port ' + port );
 } );

package/lib/utils/copySyncHelper.js

@@ -8,9 +8,8 @@ const chalk = require( 'chalk' );
  * Wrap the fs.copySync funtion and provide useful logging.
  * See {@link https://github.com/jprichardson/node-fs-extra/blob/master/docs/copy-sync.md fs.copySync}.
  *
- * @param {string} src Path of directory or file to copy.
+ * @param {string} src  Path of directory or file to copy.
  * @param {string} dest Path of destination for copied directory or file.
- *
  */
 
 module.exports = function copySyncHelper( src, dest ) {
@@ -19,13 +18,16 @@ module.exports = function copySyncHelper( src, dest ) {
 	try {
 		fs.copySync( src, dest );
 
+		// eslint-disable-next-line no-console
 		console.log( `Copied '${ name }'.` );
 	} catch ( e ) {
 		if ( 'ENOENT' === e.code ) {
+			// eslint-disable-next-line no-console
 			console.log(
 				chalk.grey( `Can't find '${ name }' to copy, skipping.` )
 			);
 		} else {
+			// eslint-disable-next-line no-console
 			console.error( e );
 		}
 	}

package/lib/utils/getAllPatternsObj.js

@@ -22,6 +22,7 @@ module.exports = function getAllPatternsObj( startPath ) {
 	const obj = {};
 
 	try {
+		// eslint-disable-next-line array-callback-return
 		patternDirs.map( ( patternType ) => {
 			let patterns = [];
 			obj[ patternType ] = {};
@@ -39,6 +40,7 @@ module.exports = function getAllPatternsObj( startPath ) {
 				);
 			}
 
+			// eslint-disable-next-line array-callback-return
 			patterns.map( ( pattern ) => {
 				obj[ patternType ][ pattern ] = getPatternVariants(
 					path.join( startPath, `${ patternType }/${ pattern }` )
@@ -46,6 +48,7 @@ module.exports = function getAllPatternsObj( startPath ) {
 			} );
 		} );
 	} catch ( e ) {
+		// eslint-disable-next-line no-console
 		console.error( e );
 	}
 

package/lib/utils/getAppConfiguration.js

@@ -11,7 +11,7 @@ const path = require( 'path' );
  * For test env, the CWD is overridden to the local directory for fixtures.
  * (this is a problem for writing project-level tests, but for a later time.)
  *
- * @param {string} key string that indicates a specific configuration property, e.g. patterns.
+ * @param {string}  key               string that indicates a specific configuration property, e.g. patterns.
  * @param {boolean} usePackageDefault fall back to package default if not defined in app
  *
  * @return value of the specified key.
@@ -77,6 +77,7 @@ module.exports = function getAppConfiguration( key, usePackageDefault = true ) {
 
 		return config[ key ];
 	} catch ( error ) {
+		// eslint-disable-next-line no-console
 		console.warn( 'Using default configuration. ' );
 
 		return defaultConfig[ key ];

package/lib/utils/getPatternData.js

@@ -4,7 +4,7 @@ const path = require( 'path' );
  * Get Pattern Data
  *
  * @param {string} patternsPath
- * @param {Object} params Object containing name of pattern
+ * @param {Object} params       Object containing name of pattern
  */
 function getPatternData( patternsPath, params ) {
 	const variant = params.variant || 'prototype';
@@ -14,12 +14,6 @@ function getPatternData( patternsPath, params ) {
 		params.name,
 		params.name + '.' + variant + '.js'
 	);
-	const jsonPath = path.join(
-		patternsPath,
-		params.type,
-		params.name,
-		params.name + '.json'
-	);
 
 	try {
 		return require( patternPath );
@@ -27,10 +21,17 @@ function getPatternData( patternsPath, params ) {
 		const originalError = e;
 
 		try {
+			const jsonPath = path.join(
+				patternsPath,
+				params.type,
+				params.name,
+				params.name + '.json'
+			);
+
 			// Backwards compat for Deadline when patterns were stored as JSON
 			const patternData = require( jsonPath );
 			return patternData;
-		} catch ( e ) {
+		} catch {
 			return {
 				message: `Error getting data for "${ params.name }".<br>There is likely a problem with ${ params.name }.${ variant }.js.`,
 				error: originalError,

package/lib/utils/getPatternRoutes.js

@@ -48,6 +48,7 @@ module.exports = function getPatternRoutes( patterns ) {
 			} )
 			.flat();
 	} catch ( error ) {
+		// eslint-disable-next-line no-console
 		console.error(
 			chalk.red(
 				'Could not build the pattern routes. Is the pattern object structure correct?'

package/lib/utils/getPatternVariants.js

@@ -12,6 +12,7 @@ const regex = new RegExp( '(.[^.]+).(.+).js$' );
 
 module.exports = function getPatternVariants( startPath ) {
 	// Only return Node prototype files that follow pattern name.XX.js
+	// eslint-disable-next-line array-callback-return
 	const files = fs.readdirSync( startPath ).filter( ( file ) => {
 		if ( /.+\..*\.js$/.test( file ) ) {
 			return file;

package/lib/utils/getPatternsIndexPath.js

@@ -1,3 +1,5 @@
+// We may need to fix this later? See comment below.
+// eslint-disable-next-line no-unused-vars
 const isCoreTheme = require( './isCoreTheme' );
 
 module.exports = function getPatternsIndexPath( config ) {

package/lib/utils/getSubDirectoryNames.js

@@ -6,8 +6,8 @@ const fs = require( 'fs' );
  * @param {string} path path to a directory containing subdirectories.
  * @return {Array} array of strings representing names of subdirectories.
  *
- * @link: https://stackoverflow.com/questions/18112204/get-all-directories-within-directory-nodejs
- **/
+ * @see https://stackoverflow.com/questions/18112204/get-all-directories-within-directory-nodejs
+ */
 
 module.exports = function getSubDirectoryNames( path ) {
 	try {
@@ -15,8 +15,10 @@ module.exports = function getSubDirectoryNames( path ) {
 			if ( 'node_modules' !== file && 'fixtures' !== file ) {
 				return fs.statSync( path + '/' + file ).isDirectory();
 			}
+			return true;
 		} );
 	} catch {
+		// eslint-disable-next-line no-console
 		console.error( path + " doesn't exist." );
 	}
 };

package/lib/writeJson.js

@@ -52,17 +52,20 @@ module.exports = function writeJson( patternConfig, fromLarva = false ) {
 					hasChanged = false;
 				}
 			} catch ( error ) {
+				// eslint-disable-next-line no-console
 				console.warn( error );
 			}
 
 			if ( hasChanged ) {
 				writeJsonToFile( jsonDestPath, moduleData );
+				// eslint-disable-next-line no-console
 				console.log(
 					chalk.green.bold(
 						`Wrote JSON for ${ moduleName }.${ variant }`
 					)
 				);
 			} else {
+				// eslint-disable-next-line no-console
 				console.log(
 					chalk.grey( `No updates in ${ moduleName }.${ variant }` )
 				);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penskemediacorp/larva",
-  "version": "1.67.0",
+  "version": "1.68.0",
   "description": "> TODO: description",
   "author": "laras126 <laras126@gmail.com>",
   "homepage": "https://github.com/Penske-Media-Corp/pmc-larva/tree/master/packages/larva#readme",
@@ -44,16 +44,16 @@
   "dependencies": {
     "@babel/core": "^7",
     "@babel/preset-env": "^7",
-    "@penskemediacorp/backstopjs-config": "^1.66.4",
-    "@penskemediacorp/eslint-config": "^1.66.4",
-    "@penskemediacorp/larva-css": "^1.66.4",
-    "@penskemediacorp/larva-js": "^1.66.4",
-    "@penskemediacorp/larva-patterns": "^1.67.0",
+    "@penskemediacorp/backstopjs-config": "^1.68.0",
+    "@penskemediacorp/eslint-config": "^1.68.0",
+    "@penskemediacorp/larva-css": "^1.68.0",
+    "@penskemediacorp/larva-js": "^1.68.0",
+    "@penskemediacorp/larva-patterns": "^1.68.0",
     "@penskemediacorp/larva-scss": "^1.66.4",
     "@penskemediacorp/larva-svg": "^1.66.4",
-    "@penskemediacorp/larva-tokens": "^1.66.4",
-    "@penskemediacorp/stylelint-config": "^1.66.4",
-    "@penskemediacorp/twig-to-php-parser": "^1.66.4",
+    "@penskemediacorp/larva-tokens": "^1.68.0",
+    "@penskemediacorp/stylelint-config": "^1.68.0",
+    "@penskemediacorp/twig-to-php-parser": "^1.68.0",
     "axios": "^1",
     "babel-loader": "^9",
     "chalk": "^4",
@@ -95,5 +95,5 @@
   "overrides": {
     "@wordpress/eslint-plugin": "^17"
   },
-  "gitHead": "5016a6408bfa1bccc72babcab32eb9fd8c02ec7f"
+  "gitHead": "e6d0aaafb0abefe1fa8a691911ae23b0bde14528"
 }

package/scripts/build-html.js

@@ -52,6 +52,7 @@ generateStatic(
 		// TODO: copy assets into build path
 		// copy assets from larva package to static
 		// copy assets from project to assets
+		// eslint-disable-next-line no-console
 		console.log( message );
 	},
 	urlBase

package/scripts/build-icons.js

@@ -49,6 +49,7 @@ const svgFiles = globby.sync( [ larvaIconsPath, projectIconsPath ], {
 // TODO: unfinished feature
 // let scssIcons = {};
 
+// eslint-disable-next-line no-console
 console.log(
 	`Looking for icon SVGs in ${ path.relative(
 		process.cwd(),
@@ -68,6 +69,7 @@ svgFiles.forEach( ( file ) => {
 	);
 } );
 
+// eslint-disable-next-line no-console
 console.log( 'Building SVG icon sprite...' );
 
 // Write the Sass variables.
@@ -75,7 +77,7 @@ console.log( 'Building SVG icon sprite...' );
 // fs.writeFileSync( path.join( process.cwd(), './build/a-icon-svg.scss' ), getSassVarsString( scssIcons ) );
 
 // Compile the sprite
-spriter.compile( function ( error, result, cssData ) {
+spriter.compile( function ( error, result ) {
 	// Run through all configured output modes
 	for ( const mode in result ) {
 		// Run through all created resources and write them to disk
@@ -88,5 +90,6 @@ spriter.compile( function ( error, result, cssData ) {
 		}
 	}
 
+	// eslint-disable-next-line no-console
 	console.log( 'Completed building SVG icon sprite.' );
 } );

package/scripts/config/.eslintrc.json

@@ -1,3 +1,4 @@
+// This config applies only to Larva's lint:js command but not other projects that use @penskemediacorp/eslint-config, such as Nova.
 {
 	"extends": "@penskemediacorp/eslint-config",
 	"overrides": [ {
@@ -5,7 +6,14 @@
 			"**/*.js"
 		],
 		"rules": {
-			"import/no-unresolved": "off"
+			"import/no-unresolved": "off",
+			"import/no-extraneous-dependencies": "off",
+			"camelcase": "off"
+		},
+		"parserOptions": {
+			"babelOptions": {
+				"presets": ["@babel/preset-react"]
+			}
 		}
 	} ],
 	"root": true

package/scripts/config/gulpfile.js

@@ -124,7 +124,7 @@ const composeTask = ( done, generateImportantVariants = false ) => {
  *
  * @param {Object} style  PostCSS Root object for current CSS.
  * @param {Object} result PostCSS Result object containing transformed CSS.
- * @return {Result} PostCSS Result object.
+ * @return {Object} PostCSS Result object.
  */
 const declareImportanceForAll = ( style, result ) => {
 	const root = postCss.parse( style );

package/scripts/config/webpack.config.js

@@ -84,6 +84,7 @@ module.exports = ( env, argv ) => {
 	}
 
 	if ( 'production' === argv.mode ) {
+		// eslint-disable-next-line no-console
 		console.log( 'Building Prod JS..' );
 
 		config.module.rules = ( config.module.rules || [] ).concat( [

package/scripts/help.js

@@ -18,6 +18,7 @@
 // Dependencies.
 const fs = require( 'fs' );
 const path = require( 'path' );
+// eslint-disable-next-line no-unused-vars
 const shell = require( 'shelljs' );
 
 // CLI arguments.
@@ -35,33 +36,34 @@ const allowedCommands = [
 
 // Display a generic help description.
 if ( 2 !== cliArgs.length ) {
-	console.log( 'Usage: npx @penskemediacorp/larval <command> [--help]\n' );
-	console.log(
+	process.stdout.write(
+		'Usage: npx @penskemediacorp/larval <command> [--help]\n'
+	);
+	process.stdout.write(
 		`Where <command> is one of ${ allowedCommands.join( ', ' ) }.\n`
 	);
-	return;
+	process.exit( 0 );
 }
-
-// Check for invalid commands.
+// Check for invalid commands.const command = cliArgs[ 1 ];
 const command = cliArgs[ 1 ];
+
 if ( ! allowedCommands.includes( command ) ) {
-	console.log( `Invalid command '${ command }'.\n` );
-	return;
+	process.stderr.write( `Invalid command '${ command }'.\n` );
+	process.exit( 0 );
 }
-
 // Display the docblock for a given command.
 const pathToFile = path.resolve( __dirname, `${ command }.js` );
 try {
 	if ( fs.existsSync( pathToFile ) ) {
 		fs.readFile( pathToFile, 'utf8', ( error, data ) => {
 			if ( error ) {
-				console.error( error );
+				process.stderr.write( error );
 				return;
 			}
 			const fileParts = data.split( '*/', 1 );
-			console.log( fileParts[ 0 ] + '*/' );
+			process.stdout.write( fileParts[ 0 ] + '*/' );
 		} );
 	}
 } catch ( error ) {
-	console.error( error );
+	process.stderr.write( error );
 }

package/scripts/init.js

@@ -7,12 +7,14 @@ const copyTo = process.cwd();
 
 copySync( copyFrom, copyTo );
 
+// eslint-disable-next-line no-console
 console.log(
 	chalk.green(
 		'Copied folder structure. Now, add the following scripts to package.json:'
 	)
 );
 
+// eslint-disable-next-line no-console
 console.log( `
 "backstop": "backstop --config=node_modules/@penskemediacorp/backstopjs-config",
 "build-html": "larva build-html",

package/scripts/link-all.js

@@ -27,9 +27,8 @@ const cliArgs = getArgsFromCli();
 // Handle help command.
 if ( cliArgs.includes( '--help' ) ) {
 	shell.exec( `npx @penskemediacorp/larva help link-all` );
-	return;
+	process.exit();
 }
-
 shell.exec( 'npm link @penskemediacorp/larva' );
 shell.exec( 'npm link @penskemediacorp/larva-css' );
 shell.exec( 'npm link @penskemediacorp/larva-js' );

package/scripts/lint.js

@@ -51,7 +51,7 @@ const cliArgs = getArgsFromCli();
 // Handle help command.
 if ( cliArgs.includes( '--help' ) ) {
 	shell.exec( `npx @penskemediacorp/larva help lint` );
-	return;
+	process.exit( 0 );
 }
 
 // Trigger linting when a specific flag is present, or when neither flag is
@@ -63,11 +63,11 @@ const lintJS = cliArgs.includes( '--js' ) || ! cliArgs.includes( '--css' );
 const fix = cliArgs.includes( '--fix' ) ? ' fix' : '';
 
 if ( lintCSS ) {
-	console.log( 'Linting CSS assets\n\n\n' );
+	process.stdout.write( 'Linting CSS assets\n\n\n' );
 	shell.exec( `${ binPath } lint-scss${ fix }` );
 }
 
 if ( lintJS ) {
-	console.log( 'Linting JavaScript assets\n\n\n' );
+	process.stdout.write( 'Linting JavaScript assets\n\n\n' );
 	shell.exec( `${ binPath } lint-js ${ workingDirectory }${ fix }` );
 }

package/scripts/prod.js

@@ -59,7 +59,7 @@ const cliArgs = getArgsFromCli();
 // Handle help command.
 if ( cliArgs.includes( '--help' ) ) {
 	shell.exec( `npx @penskemediacorp/larva help prod` );
-	return;
+	process.exit( 0 );
 }
 
 // Run the Twig-to-PHP parser.
@@ -68,49 +68,47 @@ if (
 	cliArgs.includes( '--parser' ) ||
 	cliArgs.includes( '--parse' )
 ) {
-	console.log( 'Parsing Twig templates\n\n' );
+	process.stdout.write( 'Parsing Twig templates\n\n' );
 	shell.exec( `npx @penskemediacorp/twig-to-php-parser` );
 } else {
-	console.log( 'Skipping Twig templates\n' );
+	process.stdout.write( 'Skipping Twig templates\n' );
 }
-
 // Run the write-json script.
 if (
 	1 === cliArgs.length ||
 	cliArgs.includes( '--json' ) ||
 	cliArgs.includes( '--write-json' )
 ) {
-	console.log( 'Building JSON assets\n\n' );
+	process.stdout.write( 'Building JSON assets\n\n' );
 	shell.exec( `${ binPath } write-json` );
 } else {
-	console.log( 'Skipping write-json\n' );
+	process.stdout.write( 'Skipping write-json\n' );
 }
-
 // Build CSS/SCSS.
 if (
 	1 === cliArgs.length ||
 	cliArgs.includes( '--css' ) ||
 	cliArgs.includes( '--scss' )
 ) {
-	console.log( 'Building CSS assets\n\n' );
+	process.stdout.write( 'Building CSS assets\n\n' );
 	shell.exec( `${ binPath } prod-scss` );
 } else {
-	console.log( 'Skipping building CSS\n' );
+	process.stdout.write( 'Skipping building CSS\n' );
 }
 
 // Build JS.
 if ( 1 === cliArgs.length || cliArgs.includes( '--js' ) ) {
-	console.log( 'Building JavaScript assets\n\n' );
+	process.stdout.write( 'Building JavaScript assets\n\n' );
 	shell.exec( `${ binPath } prod-js` );
 } else {
-	console.log( 'Skipping building JavaScript\n' );
+	process.stdout.write( 'Skipping building JavaScript\n' );
 }
 
 // Build SVG.
 if ( 1 === cliArgs.length || cliArgs.includes( '--svg' ) ) {
-	console.log( 'Building SVG assets\n\n' );
+	process.stdout.write( 'Building SVG assets\n\n' );
 	shell.exec( `${ binPath } build-icons` );
 	shell.exec( 'npx svgo -f src/svg -o build/svg' );
 } else {
-	console.log( 'Skipping building the SVGs\n' );
+	process.stdout.write( 'Skipping building the SVGs\n' );
 }

package/scripts/start.js

@@ -26,7 +26,7 @@ const cliArgs = getArgsFromCli();
 // Handle help command.
 if ( cliArgs.includes( '--help' ) ) {
 	shell.exec( `npx @penskemediacorp/larva help start` );
-	return;
+	process.exit( 0 );
 }
 
 // Construct some paths to point our scripts at.

package/scripts/upgrade.js

@@ -52,9 +52,8 @@ const cliArgs = getArgsFromCli();
 // Handle help command.
 if ( cliArgs.includes( '--help' ) ) {
 	shell.exec( `npx @penskemediacorp/larva help upgrade` );
-	return;
+	process.exit( 0 );
 }
-
 // Parse the --version flag. Defaults to 'latest'.
 const getVersionArg = () => {
 	// Loop through our args, looking for `--version=`.
@@ -76,7 +75,7 @@ const getVersionArg = () => {
 };
 
 // Update Larva version installed.
-console.log( `Installing Larva@${ getVersionArg() }\n\n` );
+shell.echo( `Installing Larva@${ getVersionArg() }\n\n` );
 shell.exec( `npm install @penskemediacorp/larva@${ getVersionArg() }` );
 
 // Build CSS.
@@ -84,12 +83,11 @@ if (
 	! cliArgs.includes( '--skip-css' ) ||
 	cliArgs.includes( '--skip-build' )
 ) {
-	console.log( 'Building CSS assets\n\n' );
+	shell.echo( 'Building CSS assets\n\n' );
 	shell.exec( `${ binPath } prod-scss` );
 }
-
 // Build JavaScript.
 if ( ! cliArgs.includes( '--skip-js' ) || cliArgs.includes( '--skip-build' ) ) {
-	console.log( 'Building JavaScript assets\n\n' );
+	shell.echo( 'Building JavaScript assets\n\n' );
 	shell.exec( `${ binPath } prod-js` );
 }

package/scripts/write-json.js

@@ -9,6 +9,7 @@ const cliArgs = getArgsFromCli();
 
 const fromLarva = 'larva' === cliArgs[ 1 ] ? true : false;
 
+// eslint-disable-next-line no-console
 console.log(
 	chalk.bold( `\n---- ${ cliArgs[ 1 ] || 'Project' } JSON ----\n` )
 );