Finish conforming codebase to new eslintrc

Author: kadamwhite

.editorconfig

@@ -8,18 +8,13 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 
-# Avoid trailing whitespace
 [*.js]
+# Avoid trailing whitespace
 trim_trailing_whitespace = true
-
 # Set default charset for JS files
-[*.js]
 charset = utf-8
-
-# Tab indentation (no size specified)
-[*.js]
+# Tab indentation
 indent_style = tab
-indent_size = tab
 tab_width = 2
 
 # Matches the exact files either package.json or .travis.yml

.eslintignore

@@ -0,0 +1,13 @@
+# /node_modules/* and /bower_components/* in the project root are ignored by default
+
+# Ignore built files
+browser/
+
+# Ignore generated coverage directory
+coverage/
+
+# Ignore documentation site scaffold
+documentation/
+
+# Ignore local testing script
+test.js

Gruntfile.js

@@ -6,16 +6,16 @@
 'use strict';
 
 module.exports = function( grunt ) {
-	grunt.initConfig({
-		pkg: grunt.file.readJSON( 'package.json' )
-	});
+	grunt.initConfig( {
+		pkg: grunt.file.readJSON( 'package.json' ),
+	} );
 
 	// Individual tasks are defined within build/grunt
 	grunt.loadTasks( 'build/grunt' );
 
 	grunt.registerTask( 'docs', [
 		'clean',
 		'generate_readme_docs',
-		'zip'
-	]);
+		'zip',
+	] );
 };

build/.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+	'rules': {
+		'no-console': [ 'off' ],
+	},
+};

build/grunt/zip.js

@@ -2,12 +2,12 @@
 
 module.exports = function( grunt ) {
 	grunt.config.set( 'zip', {
-			bundle: {
-				cwd: 'browser',
-				src: [ 'browser/**/*', 'LICENSE' ],
-				dest: 'documentation/wpapi.zip',
-			},
-		} );
+		bundle: {
+			cwd: 'browser',
+			src: [ 'browser/**/*', 'LICENSE' ],
+			dest: 'documentation/wpapi.zip',
+		},
+	} );
 
 	grunt.loadNpmTasks( 'grunt-zip' );
 };

build/scripts/generate-docs-markdown.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 'use strict';
 
 const fs = require( 'fs' );
@@ -61,7 +60,7 @@ const titleToSlug = title => title
 	.split( /\s+/ )
 	.join( '-' );
 
-const fileHeader = title => {
+const fileHeader = ( title ) => {
 	const slug = titleToSlug( title );
 	return `---\nlayout: page\ntitle: ${ title }\npermalink: /${ slug }/\n---`;
 };
@@ -73,12 +72,12 @@ const isTitle = token => token.match( titleRE );
 
 const getTitle = token => token.replace( titleRE, '$1' ).trim();
 
-const getLevel = mdHeading => {
+const getLevel = ( mdHeading ) => {
 	const match = mdHeading.match( /#+/ );
 	return match ? match[ 0 ].length : -1;
 };
 
-const getContents = entry => {
+const getContents = ( entry ) => {
 	// Strip any top-level headings: those are rendered as titles elsewhere
 	const fileContents = entry.tokens.join( '' ).replace( /^# [^\n]+/, '' );
 	const title = fileHeader( entry.title );
@@ -102,7 +101,7 @@ const readFile = sourcePath => new Promise( ( resolve, reject ) => {
 } );
 
 const writeFile = ( outputPath, fileContents ) => new Promise( ( resolve, reject ) => {
-	fs.writeFile( outputPath, fileContents, ( err, result ) => {
+	fs.writeFile( outputPath, fileContents, ( err ) => {
 		if ( err ) {
 			return reject( err );
 		}
@@ -111,7 +110,7 @@ const writeFile = ( outputPath, fileContents ) => new Promise( ( resolve, reject
 	} );
 } );
 
-const copyFile = ( sourcePath, title ) => readFile( sourcePath ).then( contents => {
+const copyFile = ( sourcePath, title ) => readFile( sourcePath ).then( ( contents ) => {
 	const outputPath = path.join( docsDir, `${ titleToSlug( title ) }.md` );
 	return writeFile( outputPath, getContents( {
 		title: title,
@@ -120,7 +119,7 @@ const copyFile = ( sourcePath, title ) => readFile( sourcePath ).then( contents
 } );
 
 // Break the README into individual files
-const readmeOutput = readFile( readmePath ).then( contents => {
+const readmeOutput = readFile( readmePath ).then( ( contents ) => {
 	const tokens = contents.split( /(\n+#+ .*\n+)/ );
 	const entries = [];
 	let entry = null;
@@ -192,7 +191,7 @@ const changelogOutput = copyFile( changelogPath, 'Changelog' );
 const licenseOutput = copyFile( licensePath, 'License' );
 
 // Build the template context to use with the
-const templateContext = readmeOutput.then( entries => {
+const templateContext = readmeOutput.then( ( entries ) => {
 	return entries.reduce( ( context, entry ) => {
 		const isAboutPage = entry.slug === 'about';
 		if ( isAboutPage ) {
@@ -217,15 +216,15 @@ const fileAndContext = filePath => Promise.all( [
 } ) );
 
 // Create the index HTML page
-const indexOutput = fileAndContext( indexTemplatePath ).then( result => {
+const indexOutput = fileAndContext( indexTemplatePath ).then( ( result ) => {
 	console.log( 'index' );
 	const outputPath = path.join( docsDir, 'index.html' );
 	const fileContents = combyne( result.template ).render( result.context );
 	return writeFile( outputPath, fileContents );
 } );
 
 // Create the Error 404 page
-const err404Output = fileAndContext( err404TemplatePath ).then( result => {
+const err404Output = fileAndContext( err404TemplatePath ).then( ( result ) => {
 	console.log( '404' );
 	const outputPath = path.join( docsDir, '404.html' );
 	const fileContents = combyne( result.template ).render( result.context );
@@ -240,4 +239,4 @@ module.exports = Promise.all( [
 	indexOutput,
 	err404Output,
 ] )
-.catch( err => console.log( err && err.stack ) );
+	.catch( err => console.log( err && err.stack ) );

build/scripts/release-docs.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 'use strict';
 
 const fs = require( 'fs' );
@@ -25,7 +24,7 @@ const OMIT_FILE_RE = /^\.|\.lock|\.combyne$/;
 // incorrect but still helpful assumption that no file extension means that
 // something is a directory. This means Gemfile and other no-ext files are
 // unnecessarily deleted, but it makes things work with minimal complexity.
-const PROBABLY_A_DIRECTORY_RE = /^[^\.]+$/;
+const PROBABLY_A_DIRECTORY_RE = /^[^.]+$/;
 
 // RE to match the markdown files that are extracted from the README.md
 const GENERATED_MARKDOWN_RE = /^\d+-.*\.md$/;
@@ -59,7 +58,7 @@ const promptYN = () => new Promise( ( resolve, reject ) => {
  * @param {string} inputDir The file system path to the directory to read
  * @returns {Promise} A promise to the string array of file names
  */
-const ls = ( inputDir, absolute ) => {
+const ls = ( inputDir ) => {
 	return new Promise( ( resolve, reject ) => {
 		fs.readdir( inputDir, ( err, list ) => {
 			if ( err ) {
@@ -95,11 +94,11 @@ const runCommand = ( commandStr, otherArgs ) => {
 			stdio: 'inherit',
 		} );
 
-		spawnedCommand.on( 'error', err => {
+		spawnedCommand.on( 'error', ( err ) => {
 			reject( err );
 		} );
 
-		spawnedCommand.on( 'close', code => {
+		spawnedCommand.on( 'close', ( code ) => {
 			return code ? reject( code ) : resolve();
 		} );
 	} );
@@ -113,7 +112,7 @@ const runCommand = ( commandStr, otherArgs ) => {
  * @returns {Promise} A promise that will resolve once all the promises
  * returned by that function successfully complete
  */
-const runInSequence = arrOfFnsReturningPromises => {
+const runInSequence = ( arrOfFnsReturningPromises ) => {
 	return arrOfFnsReturningPromises.reduce(
 		( lastStep, startNextStep ) => lastStep.then( startNextStep ),
 		Promise.resolve()
@@ -132,7 +131,7 @@ runCommand( 'rm -rf docs-tmp' )
 		console.log( 'By proceeding, you affirm that this is not going to ruin anybody\'s day.' );
 		console.log( '\nContinue?' );
 
-		return promptYN().then( result => {
+		return promptYN().then( ( result ) => {
 			if ( result ) {
 				console.log( '\nGreat, let\'s get this show on the road...' );
 				resolve();
@@ -155,7 +154,7 @@ runCommand( 'rm -rf docs-tmp' )
 	// Remove auto-generated files from the root of the gh-pages branch, in case
 	// file names have changed since the last deploy
 	.then( () => ls( projectRoot )
-		.then( files => {
+		.then( ( files ) => {
 			const removeFiles = files
 				.filter( file => GENERATED_MARKDOWN_RE.test( file ) )
 				.map( file => () => runCommand( `rm ${file}` ) );
@@ -169,12 +168,12 @@ runCommand( 'rm -rf docs-tmp' )
 	// Filter out unneeded files from the list
 	.then( fileList => fileList.filter( result => ! OMIT_FILE_RE.test( result ) ) )
 	// Copy things from the temp directory down into the directory root
-	.then( fileList => {
+	.then( ( fileList ) => {
 		// Create an array of functions that each remove a directory in the root of
 		// this project which could block the success of the `mv` command below
 		const removeDirectories = fileList
 			.filter( file => PROBABLY_A_DIRECTORY_RE.test( file ) )
-			.map( dir => {
+			.map( ( dir ) => {
 				// Ignore errors b/c they will usually be nothing more than a warning
 				// that a file we tried to delete didn't exist to begin with
 				return () => runCommand( `rm -rf ${dir}` ).catch( err => console.log( err ) );
@@ -183,8 +182,8 @@ runCommand( 'rm -rf docs-tmp' )
 		return runInSequence( removeDirectories ).then( () => fileList );
 	} )
 	// Copy files over
-	.then( fileList => {
-		const copyFiles = fileList.map( file => {
+	.then( ( fileList ) => {
+		const copyFiles = fileList.map( ( file ) => {
 			return () => runCommand( `mv docs-tmp/${file} ./${file}` );
 		} );
 		return runInSequence( copyFiles ).then( () => fileList );
@@ -196,10 +195,10 @@ runCommand( 'rm -rf docs-tmp' )
 	// have not changed but a new .zip is generated with the same contents, Git
 	// will still regard it as an updated file and too many of those could bloat
 	// the repo. Easier to exclude it for docs-only updates.
-	.then( () => new Promise( ( resolve, reject ) => {
+	.then( () => new Promise( ( resolve ) => {
 		console.log( '\nHas the wpapi.zip bundle changed since last deploy? (If unsure, answer "Yes")' );
 
-		return promptYN().then( result => {
+		return promptYN().then( ( result ) => {
 			if ( result ) {
 				console.log( 'Including updated wpapi.zip in build...' );
 				resolve();
@@ -215,7 +214,7 @@ runCommand( 'rm -rf docs-tmp' )
 	.then( () => new Promise( ( resolve, reject ) => {
 		console.log( '\nDocumentation staged for commit. Proceed with commit & push?' );
 
-		return promptYN().then( result => {
+		return promptYN().then( ( result ) => {
 			if ( result ) {
 				console.log( '\nConfirmed, committing & pushing docs branch...' );
 				resolve();

lib/data/.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+	'rules': {
+		'no-console': [ 'off' ],
+	},
+};

lib/data/update-default-routes-json.js

@@ -1,8 +1,3 @@
-#!/bin/sh
-':' //; exec "$(command -v nodejs || command -v node)" "$0" "$@"
-// ^^^ Lovely polyglot script to permit usage via node _or_ via bash: see
-// http://unix.stackexchange.com/questions/65235/universal-node-js-shebang
-
 /**
  * To avoid requiring that auto-discovery be utilized every time the API client
  * is initialized, this library ships with a built-in route definition from a
@@ -65,7 +60,6 @@
  * application's directory. The name of the output file can be customized with
  * the `--file` option.
  */
-/* eslint-disable no-console */
 'use strict';
 
 var agent = require( 'superagent' );

webpack.config.js

@@ -17,7 +17,10 @@ module.exports = {
 
 	module: {
 		loaders: [
-			{ test: /\.json$/, loader: 'json-loader' },
+			{
+				test: /\.json$/,
+				loader: 'json-loader',
+			},
 		],
 	},
 };