Merge pull request #13 from Automattic/update/dev-environment

Update Development environment

Author: pyronaur

.editorconfig

@@ -0,0 +1,25 @@
+
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+# WordPress Coding Standards
+# https://make.wordpress.org/core/handbook/coding-standards/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = tab
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.txt]
+end_of_line = crlf

.eslintignore

@@ -0,0 +1,6 @@
+**/*.min.js
+**/node_modules/**
+**/vendor/**
+**/dist/**
+**/tests/**
+bin/*

.eslintrc

@@ -13,8 +13,8 @@
 		"ecmaVersion": 2020
 	},
 	"extends": [
-		"eslint:recommended"
-	],
-	"ignorePatterns": [ "dist/**" ]
+		"eslint:recommended",
+		"plugin:@wordpress/eslint-plugin/recommended"
+	]
 }
 

bin/generate.js

@@ -1,5 +1,8 @@
 const puppeteer = require( 'puppeteer' );
-const { generateCriticalCSS, BrowserInterfacePuppeteer } = require( '../index' );
+const {
+	generateCriticalCSS,
+	BrowserInterfacePuppeteer,
+} = require( '../index' );
 
 async function main() {
 	const urls = process.argv.slice( 2 );
@@ -20,15 +23,15 @@ async function main() {
 
 	console.log( 'Generating Critical CSS...' );
 
-	const [ css, warnings ] = await generateCriticalCSS({
+	const [ css, warnings ] = await generateCriticalCSS( {
 		urls,
 		viewports: [
 			{ width: 414, height: 896 },
 			{ width: 1200, height: 800 },
 			{ width: 1920, height: 1080 },
 		],
 		browserInterface: new BrowserInterfacePuppeteer( testPages ),
-	});
+	} );
 
 	if ( warnings.length ) {
 		console.log( '\n\nwarnings => ' );
@@ -39,7 +42,9 @@ async function main() {
 	console.log( css );
 }
 
-main().catch( err => {
-	console.error( err );
-	process.exit( 1 ); 
-} ).then( () => process.exit( 0 ) );
+main()
+	.catch( ( err ) => {
+		console.error( err );
+		process.exit( 1 );
+	} )
+	.then( () => process.exit( 0 ) );

jest.config.js

@@ -1,7 +1,7 @@
 module.exports = {
-	testMatch: ['**/?(*.)+(spec|test).js'],
-	setupFilesAfterEnv: ['./tests/config/jest-setup.js'],
-	collectCoverageFrom: ['lib/**/*.js', 'index.js'],
+	testMatch: [ '**/?(*.)+(spec|test).js' ],
+	setupFilesAfterEnv: [ './tests/config/jest-setup.js' ],
+	collectCoverageFrom: [ 'lib/**/*.js', 'index.js' ],
 	globalSetup: 'jest-environment-puppeteer/setup',
 	globalTeardown: 'jest-environment-puppeteer/teardown',
 	testEnvironment: 'jest-environment-puppeteer',

lib/browser-interface-iframe.js

@@ -25,7 +25,7 @@ class BrowserInterfaceIframe extends BrowserInterface {
 		this.verifyPage = verifyPage;
 
 		// Default 'allowScripts' to true if not specified.
-		allowScripts = ( allowScripts !== false );
+		allowScripts = allowScripts !== false;
 
 		if ( ! verifyPage ) {
 			throw new ConfigurationError( {
@@ -90,7 +90,10 @@ class BrowserInterfaceIframe extends BrowserInterface {
 			const response = await fetch( url );
 			if ( response.status === 200 ) {
 				if ( response.redirected ) {
-					return new RedirectError( { url, redirectUrl: response.url } )
+					return new RedirectError( {
+						url,
+						redirectUrl: response.url,
+					} );
 				}
 				return null;
 			}

lib/browser-interface-puppeteer.js

@@ -1,5 +1,5 @@
 const BrowserInterface = require( './browser-interface' );
-const { ConfigurationError } = require('./errors');
+const { ConfigurationError } = require( './errors' );
 
 class BrowserInterfacePuppeteer extends BrowserInterface {
 	constructor( pages ) {
@@ -13,7 +13,7 @@ class BrowserInterfacePuppeteer extends BrowserInterface {
 
 		if ( ! page ) {
 			throw new ConfigurationError( {
-				message: `Puppeteer interface does not include URL ${ pageUrl }`
+				message: `Puppeteer interface does not include URL ${ pageUrl }`,
 			} );
 		}
 

lib/browser-interface.js

@@ -4,7 +4,7 @@ class BrowserInterface {
 	// eslint-disable-next-line no-unused-vars
 	async runInPage( pageUrl, viewport, method, ...args ) {
 		throw new InternalError( {
-			message: 'Undefined interface method: BrowserInterface.runInPage()'
+			message: 'Undefined interface method: BrowserInterface.runInPage()',
 		} );
 	}
 
@@ -23,7 +23,7 @@ class BrowserInterface {
 			.filter( ( link ) => link.rel === 'stylesheet' )
 			.reduce( ( set, link ) => {
 				set[ link.href ] = {
-					media: link.media || null
+					media: link.media || null,
 				};
 
 				return set;

lib/css-file-set.js

@@ -1,4 +1,4 @@
-const { HttpError, GenericUrlError, CriticalCssError } = require('./errors');
+const { HttpError, GenericUrlError, CriticalCssError } = require( './errors' );
 const StyleAST = require( './style-ast' );
 const fetch =
 	( typeof window !== 'undefined' && window.fetch ) ||
@@ -27,8 +27,8 @@ class CSSFileSet {
 	 */
 	async addMultiple( page, cssIncludes ) {
 		return Promise.all(
-			Object.keys( cssIncludes ).map(
-				( url ) => this.add( page, url, cssIncludes[ url ] )
+			Object.keys( cssIncludes ).map( ( url ) =>
+				this.add( page, url, cssIncludes[ url ] )
 			)
 		);
 	}
@@ -38,6 +38,7 @@ class CSSFileSet {
 	 *
 	 * @param {string} page - URL of the page the CSS URL was found on.
 	 * @param {string} cssUrl - The CSS file URL.
+	 * @param {Object} settings
 	 */
 	async add( page, cssUrl, settings = {} ) {
 		// Add by reference if we already know this file.
@@ -71,7 +72,10 @@ class CSSFileSet {
 
 			// Wrap any unfamiliar fetch errors in a generic url error.
 			if ( ! ( err instanceof CriticalCssError ) ) {
-				wrappedError = new GenericUrlError( { code: cssUrl, url: err.message } );
+				wrappedError = new GenericUrlError( {
+					code: cssUrl,
+					url: err.message,
+				} );
 			}
 
 			this.storeError( cssUrl, wrappedError );
@@ -249,10 +253,7 @@ class CSSFileSet {
 				return set;
 			}, {} );
 
-			await cssFiles.addMultiple(
-				url,
-				absoluteIncludes
-			);
+			await cssFiles.addMultiple( url, absoluteIncludes );
 		}
 
 		return cssFiles;

lib/errors.js

@@ -31,13 +31,17 @@ class CriticalCssError extends Error {
 
 	/**
 	 * Returns true if this error object has the specified data value.
+	 *
+	 * @param {string} key
 	 */
 	has( key ) {
 		return Object.prototype.hasOwnProperty.call( this.data, key );
 	}
 
 	/**
 	 * Gets the data value with the specified key, or undefined if not defined.
+	 *
+	 * @param {string} key
 	 */
 	get( key ) {
 		return this.data[ key ];
@@ -59,13 +63,13 @@ class CriticalCssError extends Error {
 	 * Reverse of toJSON; constructs a CriticalCssError object from
 	 * a previously serialized value.
 	 *
-	 * @param {object} jsonObject - JSON compatible object
+	 * @param {Object} jsonObject - JSON compatible object
 	 */
 	static fromJSON( jsonObject ) {
 		const ErrorClass = CriticalCssErrorTypes[ jsonObject.type ];
 		if ( ! ErrorClass ) {
 			return new UnknownError( {
-				message: jsonObject.message || jsonObject
+				message: jsonObject.message || jsonObject,
 			} );
 		}
 

lib/minify-css.js

@@ -8,7 +8,7 @@ const CleanCSS = require( 'clean-css' );
  *
  * @param {string} css - CSS to minify.
  *
- * @return {[ string, string[] ]} - Minified CSS and a list of errors returned.
+ * return {[ string, string[] ]} - Minified CSS and a list of errors returned.
  */
 function minifyCss( css ) {
 	const result = new CleanCSS().minify( css );

lib/style-ast.js

@@ -232,7 +232,10 @@ class StyleAST {
 				} );
 
 				// If there are no useful media query lists left, throw away the block.
-				if ( atrule.prelude.children && atrule.prelude.children.isEmpty() ) {
+				if (
+					atrule.prelude.children &&
+					atrule.prelude.children.isEmpty()
+				) {
 					atlist.remove( atitem );
 				}
 			},
@@ -336,7 +339,10 @@ class StyleAST {
 				);
 
 				// If the selector list is empty, prune the whole rule.
-				if ( rule.prelude.children && rule.prelude.children.isEmpty() ) {
+				if (
+					rule.prelude.children &&
+					rule.prelude.children.isEmpty()
+				) {
 					list.remove( item );
 				}
 			},