@penskemediacorp/larva 1.25.0 → 1.28.0

package/__tests__/fixtures/larva.config.js

@@ -1,43 +1,36 @@
 const path = require( 'path' );
 
 module.exports = {
-
 	webpack: {
 		entry: {
 			common: './common.entry.js',
 			critical: './critical.entry.js',
 			special: './special.entry.js',
-			great: './great.entry.js'
-		}
+			great: './great.entry.js',
+		},
 	},
 
 	backstop: {
 		testBaseUrl: 'https://pmc:for-the-win@deadline-2019.pmcqa.com',
-		testPaths: [
-			'/',
-			'/blog/'
-		],
+		testPaths: [ '/', '/blog/' ],
 		testScenario: {
-			'delay': 5000,
-			'misMatchThreshold': 0.5
+			delay: 5000,
+			misMatchThreshold: 0.5,
 		},
-		larvaModules: [ 'footer', 'mega-menu-content', 'social-share' ]
+		larvaModules: [ 'footer', 'mega-menu-content', 'social-share' ],
 	},
 
 	patterns: {
 		projectPatternsDir: path.join( __dirname, './src/patterns' ),
 		larvaPatternsDir: path.resolve( __dirname, '../../../larva-patterns' ),
-		ignoredModules: [
-			'ignore-me'
-		]
+		ignoredModules: [ 'ignore-me' ],
 	},
 
 	assets: {
-		path: __dirname
+		path: __dirname,
 	},
 
 	parser: {
 		isCore: false,
 	},
-
-};
+};

package/__tests__/fixtures/src/patterns/components/c-nav-link/c-nav-link.featured.aia.js

@@ -1,3 +1,3 @@
 module.exports = {
-	modifier_class: 'featured aia'
-};
+	modifier_class: 'featured aia',
+};

package/__tests__/fixtures/src/patterns/components/c-nav-link/c-nav-link.featured.js

@@ -1,3 +1,3 @@
 module.exports = {
-	modifier_class: 'featured'
-};
+	modifier_class: 'featured',
+};

package/__tests__/fixtures/src/patterns/components/c-nav-link/c-nav-link.js

@@ -1 +1 @@
-// this could be JSX or a React component.
+// this could be JSX or a React component.

package/__tests__/fixtures/src/patterns/components/c-nav-link/c-nav-link.prototype.js

@@ -1,3 +1,3 @@
 module.exports = {
-	modifier_class: ''
-};
+	modifier_class: '',
+};

package/__tests__/fixtures/src/patterns/components/c-tagline/c-tagline.prototype.js

@@ -1,3 +1,3 @@
 module.exports = {
-	c_tagline_text: 'overrode the larva pattern'
-}
+	c_tagline_text: 'overrode the larva pattern',
+};

package/__tests__/fixtures/src/patterns/modules/_also-ignored/_also-ignored.prototype.js

@@ -1,3 +1,3 @@
 module.exports = {
-	also_ignored_classes: 'lrv-u-color-black'
-};
+	also_ignored_classes: 'lrv-u-color-black',
+};

package/__tests__/fixtures/src/patterns/modules/test-module/test-module.featured.js

@@ -1,3 +1,3 @@
 module.exports = {
-	test_module_classes: 'lrv-a-glue'
-}
+	test_module_classes: 'lrv-a-glue',
+};

package/__tests__/fixtures/src/patterns/modules/test-module/test-module.prototype.js

@@ -1,3 +1,3 @@
 module.exports = {
-	test_module_classes: 'lrv-u-flex'
-}
+	test_module_classes: 'lrv-u-flex',
+};

package/__tests__/fixtures/src/patterns/one-offs/newswire/newswire.prototype.js

@@ -1,3 +1,3 @@
 module.exports = {
-	name: "newswire"
-};
+	name: 'newswire',
+};

package/__tests__/lib/generateStatic.test.js

@@ -13,113 +13,149 @@ const buildPath = path.join( fixture, './build/html/project' );
 beforeAll( ( done ) => {
 	app.listen( port, () => {
 		done();
-	});
-});
+	} );
+} );
 
 describe( 'generateStatic', () => {
-
 	beforeEach( ( done ) => {
-
 		exec( 'mkdir -p ' + buildPath, ( err ) => {
 			if ( err ) {
 				console.error( err );
 			}
 			done();
 		} );
-
 	} );
 
 	it( 'creates an index.html file for a prototype pattern', ( done ) => {
-
-		const routesArr = [
-			'components/c-link'
-		];
-
-		generateStatic( routesArr, buildPath, () => {
-			expect(
-				fs.existsSync( path.join( buildPath, 'components/c-link/index.html' ) )
-			).toBe( true );
-			done();
-		}, urlBase );
-
+		const routesArr = [ 'components/c-link' ];
+
+		generateStatic(
+			routesArr,
+			buildPath,
+			() => {
+				expect(
+					fs.existsSync(
+						path.join( buildPath, 'components/c-link/index.html' )
+					)
+				).toBe( true );
+				done();
+			},
+			urlBase
+		);
 	} );
 
 	it( 'creates an html file for a pattern variant', ( done ) => {
-		const routesArr = [
-			'components/c-button/brand-basic'
-		];
-
-		generateStatic( routesArr, buildPath, () => {
-			expect(
-				fs.existsSync( path.join( buildPath, 'components/c-button/brand-basic/index.html' ) )
-			).toBe( true );
-			done();
-		}, urlBase );
-
+		const routesArr = [ 'components/c-button/brand-basic' ];
+
+		generateStatic(
+			routesArr,
+			buildPath,
+			() => {
+				expect(
+					fs.existsSync(
+						path.join(
+							buildPath,
+							'components/c-button/brand-basic/index.html'
+						)
+					)
+				).toBe( true );
+				done();
+			},
+			urlBase
+		);
 	} );
 
 	it( 'contains content for the pattern', ( done ) => {
-		const routesArr = [
-			'modules/footer',
-		];
-
-		generateStatic( routesArr, buildPath, () => {
-			expect(
-				// Hacky way to test that the response actually contains
-				// the content, not an error.
-				fs.readFileSync(
-					path.join( buildPath, routesArr[0] + '/index.html' ),
-					{ encoding: 'utf8' }
-				).indexOf( 'footer_classes' )
-			).not.toBe( -1 );
-			done();
-		}, urlBase );
+		const routesArr = [ 'modules/footer' ];
+
+		generateStatic(
+			routesArr,
+			buildPath,
+			() => {
+				expect(
+					// Hacky way to test that the response actually contains
+					// the content, not an error.
+					fs
+						.readFileSync(
+							path.join(
+								buildPath,
+								routesArr[ 0 ] + '/index.html'
+							),
+							{ encoding: 'utf8' }
+						)
+						.indexOf( 'footer_classes' )
+				).not.toBe( -1 );
+				done();
+			},
+			urlBase
+		);
 	} );
 
 	it( 'copies static assets', ( done ) => {
-		const routesArr = [
-			'components/c-button/brand-basic'
-		];
-
-		generateStatic( routesArr, buildPath, () => {
-
-			// This is kinda sloppy and may be annoying to maintain, and there is
-			// surely a more elegant way to test this functionality than checking
-			// if the file exists...
-
-			// JS
-			expect(
-				fs.existsSync( path.join( buildPath, '../assets/build/js/larva-ui.js' ) )
-			).toBe( true );
-
-			// CSS
-			expect(
-				fs.existsSync( path.join( buildPath, '../assets/build/css/common.inline.css' ) )
-			).toBe( true );
-
-			// Images
-			expect(
-				fs.existsSync( path.join( buildPath, '../assets/build/images/test.png' ) )
-			).toBe( true );
-
-			// SVG
-			expect(
-				fs.existsSync( path.join( buildPath, '../assets/build/svg/defs/sprite.svg' ) )
-			).toBe( true );
-
-			// Public dir
-			expect(
-				fs.existsSync( path.join( buildPath, '../assets/public/some-library.js' ) )
-			).toBe( true );
-
-			done();
-
-		}, urlBase );
-
+		const routesArr = [ 'components/c-button/brand-basic' ];
+
+		generateStatic(
+			routesArr,
+			buildPath,
+			() => {
+				// This is kinda sloppy and may be annoying to maintain, and there is
+				// surely a more elegant way to test this functionality than checking
+				// if the file exists...
+
+				// JS
+				expect(
+					fs.existsSync(
+						path.join( buildPath, '../assets/build/js/larva-ui.js' )
+					)
+				).toBe( true );
+
+				// CSS
+				expect(
+					fs.existsSync(
+						path.join(
+							buildPath,
+							'../assets/build/css/common.inline.css'
+						)
+					)
+				).toBe( true );
+
+				// Images
+				expect(
+					fs.existsSync(
+						path.join(
+							buildPath,
+							'../assets/build/images/test.png'
+						)
+					)
+				).toBe( true );
+
+				// SVG
+				expect(
+					fs.existsSync(
+						path.join(
+							buildPath,
+							'../assets/build/svg/defs/sprite.svg'
+						)
+					)
+				).toBe( true );
+
+				// Public dir
+				expect(
+					fs.existsSync(
+						path.join(
+							buildPath,
+							'../assets/public/some-library.js'
+						)
+					)
+				).toBe( true );
+
+				done();
+			},
+			urlBase
+		);
 	} );
 
 	afterEach( ( done ) => {
-
 		const htmlDir = path.join( buildPath, '../' );
 
 		exec( 'rm -r ' + htmlDir, ( err ) => {
@@ -128,13 +164,11 @@ describe( 'generateStatic', () => {
 			}
 			done();
 		} );
-
 	} );
-
 } );
 
 afterAll( async ( done ) => {
 	const server = app.listen();
 	server.close();
 	done();
-});
+} );

package/__tests__/lib/utils/clonePatternData.test.js

@@ -4,20 +4,27 @@ const getConfig = require( '../../../lib/utils/getAppConfiguration' );
 const { projectPatternsDir, larvaPatternsDir } = getConfig( 'patterns' );
 
 describe( 'clonePatternData', () => {
-
 	it( 'gets object from project patterns dir first', () => {
-
-		const expected = require( path.join( projectPatternsDir, '/components/c-tagline/c-tagline.prototype' ) );
-		const c_tagline = clonePatternData( 'components/c-tagline/c-tagline.prototype');
+		const expected = require( path.join(
+			projectPatternsDir,
+			'/components/c-tagline/c-tagline.prototype'
+		) );
+		const c_tagline = clonePatternData(
+			'components/c-tagline/c-tagline.prototype'
+		);
 
 		expect( c_tagline ).toStrictEqual( expected );
-	});
+	} );
 
 	it( 'falls back to object from larva patterns dir', () => {
-		const expected = require( path.join( larvaPatternsDir, '/components/c-button/c-button.prototype' ) );
-		const c_button = clonePatternData( 'components/c-button/c-button.prototype');
+		const expected = require( path.join(
+			larvaPatternsDir,
+			'/components/c-button/c-button.prototype'
+		) );
+		const c_button = clonePatternData(
+			'components/c-button/c-button.prototype'
+		);
 
 		expect( c_button ).toStrictEqual( expected );
-	});
-
-});
+	} );
+} );

package/__tests__/lib/utils/getAllPatternsObj.test.js

@@ -3,43 +3,28 @@ const getAppConfiguration = require( '../../../lib/utils/getAppConfiguration' );
 const getAllPatternsObj = require( '../../../lib/utils/getAllPatternsObj' );
 
 const expectedPatterns = {
-	'__tests__' : {},
-	'components': {
-		'c-nav-link': [
-			'featured.aia',
-			'featured',
-			'prototype'
-		],
-		'c-tagline': [
-			'prototype'
-		]
+	__tests__: {},
+	components: {
+		'c-nav-link': [ 'featured.aia', 'featured', 'prototype' ],
+		'c-tagline': [ 'prototype' ],
 	},
-	'modules': {
-		'test-module': [
-			'featured',
-			'prototype'
-		]
+	modules: {
+		'test-module': [ 'featured', 'prototype' ],
 	},
-	'objects': {
+	objects: {
 		'o-crap': [],
-		'o-nav': []
+		'o-nav': [],
 	},
 	'one-offs': {
-		'newswire': [
-			'prototype'
-		]
-	}
-}
+		newswire: [ 'prototype' ],
+	},
+};
 const config = getAppConfiguration( 'patterns' );
 
 describe( 'getAllPatternsObj', () => {
-
 	it( 'returns an object containing all patterns and variants', () => {
-
-		expect(
-			getAllPatternsObj( config.projectPatternsDir )
-		).toEqual(
+		expect( getAllPatternsObj( config.projectPatternsDir ) ).toEqual(
 			expectedPatterns
 		);
-	});
-});
+	} );
+} );

package/__tests__/lib/utils/getAppConfiguration.test.js

@@ -5,9 +5,9 @@ const getAppConfiguration = require( '../../../lib/utils/getAppConfiguration' );
 const expectedLarvaConfig = require( fixture + '/larva.config.js' );
 
 describe( 'getAppConfiguration', () => {
-
 	it( 'Get Larva Configuration', () => {
-		expect(getAppConfiguration( 'backstop' )).toStrictEqual( expectedLarvaConfig.backstop );
-	});
-
-});
+		expect( getAppConfiguration( 'backstop' ) ).toStrictEqual(
+			expectedLarvaConfig.backstop
+		);
+	} );
+} );

package/__tests__/lib/utils/getModuleNamesFromDirectory.test.js

@@ -5,19 +5,38 @@ const config = getAppConfiguration( 'patterns' );
 
 describe( 'getModuleNamesFromDirectory', () => {
 	it( 'gets an array of modules', () => {
-		expect( getModuleNamesFromDirectory( config.projectPatternsDir, config.ignoredModules ) ).toEqual( expect.arrayContaining( [ 'test-module' ] ) );
-	});
+		expect(
+			getModuleNamesFromDirectory(
+				config.projectPatternsDir,
+				config.ignoredModules
+			)
+		).toEqual( expect.arrayContaining( [ 'test-module' ] ) );
+	} );
 
 	it( 'ignored modules with underscores', () => {
-		expect( getModuleNamesFromDirectory( config.projectPatternsDir, config.ignoredModules ) ).toEqual( expect.not.arrayContaining( [ '_also-ignored' ] ) );
-	});
+		expect(
+			getModuleNamesFromDirectory(
+				config.projectPatternsDir,
+				config.ignoredModules
+			)
+		).toEqual( expect.not.arrayContaining( [ '_also-ignored' ] ) );
+	} );
 
 	it( 'ignores modules listed in larva.config.ignoredModules', () => {
-		expect( getModuleNamesFromDirectory( config.projectPatternsDir, config.ignoredModules ) ).toEqual( expect.not.arrayContaining( [ 'ignore-me' ] ) );
-	});
+		expect(
+			getModuleNamesFromDirectory(
+				config.projectPatternsDir,
+				config.ignoredModules
+			)
+		).toEqual( expect.not.arrayContaining( [ 'ignore-me' ] ) );
+	} );
 
 	it( 'gets module names from larva', () => {
-		expect( getModuleNamesFromDirectory( config.larvaPatternsDir, config.ignoredModules ) ).toEqual( expect.arrayContaining( [ 'pmc-footer' ] ) );
-	});
-
-});
+		expect(
+			getModuleNamesFromDirectory(
+				config.larvaPatternsDir,
+				config.ignoredModules
+			)
+		).toEqual( expect.arrayContaining( [ 'pmc-footer' ] ) );
+	} );
+} );

package/__tests__/lib/utils/getPatternData.test.js

@@ -4,52 +4,65 @@ const fs = require( 'fs' );
 const fixture = path.join( __dirname, '../../fixtures' );
 
 const getPatternData = require( '../../../lib/utils/getPatternData' );
-const appConfiguration = require( '../../../lib/utils/getAppConfiguration' )('patterns');
+const appConfiguration = require( '../../../lib/utils/getAppConfiguration' )(
+	'patterns'
+);
 
-const expectedSchema = require( fixture + '/src/patterns/components/c-nav-link/c-nav-link.prototype.js' );
-const expectedVariantSchema = require( fixture + '/src/patterns/components/c-nav-link/c-nav-link.featured.js' );
-const expectedSchemaFromJson = require( fixture + '/src/patterns/objects/o-crap/o-crap.json' );
+const expectedSchema = require( fixture +
+	'/src/patterns/components/c-nav-link/c-nav-link.prototype.js' );
+const expectedVariantSchema = require( fixture +
+	'/src/patterns/components/c-nav-link/c-nav-link.featured.js' );
+const expectedSchemaFromJson = require( fixture +
+	'/src/patterns/objects/o-crap/o-crap.json' );
 const expectedPath = fixture + '/src/patterns/objects/o-nav/o-nav.json';
-const expectedOneOffSchema = require( fixture + '/src/patterns/one-offs/newswire/newswire.prototype.js' );
+const expectedOneOffSchema = require( fixture +
+	'/src/patterns/one-offs/newswire/newswire.prototype.js' );
 
-let compStub = {
+const compStub = {
 	name: 'c-nav-link',
 	type: 'components',
-	variant: 'prototype'
+	variant: 'prototype',
 };
 
 const objStub = {
 	name: 'o-crap',
 	type: 'objects',
-	variant: 'prototype'
+	variant: 'prototype',
 };
 
 const oneOffStub = {
 	name: 'newswire',
 	type: 'one-offs',
-	variant: 'prototype'
+	variant: 'prototype',
 };
 
 describe( 'getPatternData', () => {
-	
 	it( 'first returns the pattern object if the schema is found', () => {
-		assert.equal( getPatternData( fixture + '/src/patterns', compStub ), expectedSchema );
-	});
+		assert.equal(
+			getPatternData( fixture + '/src/patterns', compStub ),
+			expectedSchema
+		);
+	} );
 
 	it( 'returns the pattern object for one-offs', () => {
-		assert.equal( getPatternData( fixture + '/src/patterns', oneOffStub ), expectedOneOffSchema );
-	});
+		assert.equal(
+			getPatternData( fixture + '/src/patterns', oneOffStub ),
+			expectedOneOffSchema
+		);
+	} );
 
 	it( 'returns the pattern json object if no prototype is found', () => {
-		assert.equal( getPatternData( fixture + '/src/patterns', objStub ), expectedSchemaFromJson );
-	});
+		assert.equal(
+			getPatternData( fixture + '/src/patterns', objStub ),
+			expectedSchemaFromJson
+		);
+	} );
 
 	it( 'gets a variant specified in params', () => {
 		compStub.variant = 'featured';
-		assert.equal( getPatternData( fixture + '/src/patterns', compStub ), expectedVariantSchema );
-	});
-
-});
-
-
-
+		assert.equal(
+			getPatternData( fixture + '/src/patterns', compStub ),
+			expectedVariantSchema
+		);
+	} );
+} );

package/__tests__/lib/utils/getPatternPathsToLoad.test.js

@@ -2,12 +2,12 @@ const assert = require( 'assert' );
 const path = require( 'path' );
 const fixture = path.join( __dirname, '../../fixtures' );
 const getPatternPathsToLoad = require( '../../../lib/utils/getPatternPathsToLoad' );
-const appConfiguration = require( '../../../lib/utils/getAppConfiguration' )('patterns');
+const appConfiguration = require( '../../../lib/utils/getAppConfiguration' )(
+	'patterns'
+);
 
 describe( 'getPatternPathsToLoad', () => {
-
 	it( 'returns an array of paths loads larvaPath if it is the core theme', () => {
 		assert.equal( getPatternPathsToLoad( appConfiguration ).length, 2 );
-	});
-
-});
+	} );
+} );

package/__tests__/lib/utils/getPatternRoutes.test.js

@@ -5,10 +5,10 @@ const getAllPatternsObj = require( '../../../lib/utils/getAllPatternsObj' );
 const getPatternRoutes = require( '../../../lib/utils/getPatternRoutes' );
 
 describe( 'getPatternRoutes', () => {
-
 	it( 'outputs an array of routes from a pattern object', () => {
-
-		const patterns = getAllPatternsObj( path.join( fixture, 'src/patterns' ) );
+		const patterns = getAllPatternsObj(
+			path.join( fixture, 'src/patterns' )
+		);
 
 		const expected = [
 			'components/c-nav-link/featured.aia',
@@ -19,11 +19,9 @@ describe( 'getPatternRoutes', () => {
 			'modules/test-module',
 			'objects/o-crap',
 			'objects/o-nav',
-			'one-offs/newswire'
+			'one-offs/newswire',
 		];
 
 		expect( getPatternRoutes( patterns ) ).toStrictEqual( expected );
-
 	} );
-
 } );