Merge pull request #72 from kadamwhite/update-coding-standards

Switch to @wordpress/eslint-plugin/recommended standards

Author: kadamwhite

.eslintrc

@@ -0,0 +1,11 @@
+{
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "extends": "plugin:@wordpress/eslint-plugin/recommended",
+    "rules": {
+        "one-var": ["error", "never"],
+        "prefer-arrow-callback": ["error"]
+    }
+}

.eslintrc.json

@@ -1,19 +1,18 @@
-var grunt = require( 'grunt' );
+const grunt = require( 'grunt' );
 
 /**
  * Replaces file names in the passed filePath with the file names in the fileMappings.
  *
- * @param filePath The path to the file where the filenames should be replaced.
- * @param fileMappings The file names to replace and the file names they should be replaced with.
+ * @param {string} filePath The path to the file where the filenames should be replaced.
+ * @param {Object} fileMappings The file names to replace and the file names they should be replaced with.
  *
- * @returns {void}
+ * @return {void}
  */
 function mapOldToNewFilePath( filePath, fileMappings ) {
-	var body = grunt.file.read( filePath ),
-		newBody,
-		oldPath;
+	const body = grunt.file.read( filePath );
+	let newBody;
+	let oldPath;
 	for ( oldPath in fileMappings ) {
-
 		// Ensure only own properties are looped over.
 		if ( ! fileMappings.hasOwnProperty( oldPath ) ) {
 			continue;

lib/map_old_to_new_file_path.js

@@ -1,22 +1,21 @@
-var grunt = require( 'grunt' ),
-	_ = require( 'underscore' );
+const _ = require( 'underscore' );
 
 _.str = _.str = require( 'underscore.string' );
 _.mixin( _.str.exports() );
 
 module.exports = {
-	isAb: function( diff ) {
-		var ab = false;
+	isAb( diff ) {
+		let ab = false;
 		try {
 			diff = diff.split( '\n' );
-			_.each( diff, function( line ) {
+			_.each( diff, ( line ) => {
 				if ( _.startsWith( line, 'diff --git a/' ) ) {
 					throw true;
 				}
 				if ( _.startsWith( line, 'Index: trunk/wp-' ) ) {
 					throw true;
 				}
-			});
+			} );
 		} catch ( e ) {
 			ab = e;
 		}
@@ -25,83 +24,81 @@ module.exports = {
 	},
 
 	/**
-		Check to see if we should apply the diff from the src dir
-
-		@returns bool true if we should go into src to apply the diff
-	*/
-	moveToSrc: function( diff ) {
-		var src = false,
-			wpDashExceptions = [
-				'.editorconfig',
-				'.gitignore',
-				'.jshintrc',
-				'.travis.yml',
-				'Gruntfile.js',
-				'package.json',
-				'phpunit.xml.dist',
-				'wp-cli.yml',
-				'wp-config-sample.php',
-				'wp-tests-config-sample.php'
-			],
-			noWpDashExceptions = [
-				'index.php',
-				'license.txt',
-				'readme.html',
-				'xmlrpc.php'
-			];
+	 * Check to see if we should apply the diff from the src dir
+	 *
+	 * @param {string} diff A string diff
+	 * @return {boolean} true if we should go into src to apply the diff
+	 */
+	moveToSrc( diff ) {
+		let src = false;
+		const wpDashExceptions = [
+			'.editorconfig',
+			'.gitignore',
+			'.jshintrc',
+			'.travis.yml',
+			'Gruntfile.js',
+			'package.json',
+			'phpunit.xml.dist',
+			'wp-cli.yml',
+			'wp-config-sample.php',
+			'wp-tests-config-sample.php',
+		];
+		const noWpDashExceptions = [
+			'index.php',
+			'license.txt',
+			'readme.html',
+			'xmlrpc.php',
+		];
 
 		try {
 			diff = diff.split( '\n' );
-			_.each( diff, function( line ) {
-
+			_.each( diff, ( line ) => {
 				// these are often the first line
-				if ( _.startsWith( line, 'Index: src/'       ) ||
-					_.startsWith( line, 'Index: tests/'      ) ||
-					_.startsWith( line, 'Index: tools/'      ) ||
-					_.startsWith( line, 'diff --git src'     ) ||
-					_.startsWith( line, 'diff --git test'    ) ||
-					_.startsWith( line, 'diff --git tools'   ) ||
-					_.startsWith( line, 'diff --git a/src'   ) ||
-					_.startsWith( line, 'diff --git a/test'  ) ||
+				if ( _.startsWith( line, 'Index: src/' ) ||
+					_.startsWith( line, 'Index: tests/' ) ||
+					_.startsWith( line, 'Index: tools/' ) ||
+					_.startsWith( line, 'diff --git src' ) ||
+					_.startsWith( line, 'diff --git test' ) ||
+					_.startsWith( line, 'diff --git tools' ) ||
+					_.startsWith( line, 'diff --git a/src' ) ||
+					_.startsWith( line, 'diff --git a/test' ) ||
 					_.startsWith( line, 'diff --git a/tools' )
 
 				) {
 					throw false;
 				}
 
-				_.each( wpDashExceptions, function( exception ) {
-					if ( _.startsWith( line, 'Index: ' + exception      ) ||
-						_.startsWith( line, 'diff --git ' + exception   ) ||
+				_.each( wpDashExceptions, ( exception ) => {
+					if ( _.startsWith( line, 'Index: ' + exception ) ||
+						_.startsWith( line, 'diff --git ' + exception ) ||
 						_.startsWith( line, 'diff --git a/' + exception )
 					) {
 						throw false;
 					}
-				});
+				} );
 
-				_.each( noWpDashExceptions, function( exception ) {
-					if ( _.startsWith( line, 'Index: ' + exception      ) ||
-						_.startsWith( line, 'diff --git ' + exception   ) ||
+				_.each( noWpDashExceptions, ( exception ) => {
+					if ( _.startsWith( line, 'Index: ' + exception ) ||
+						_.startsWith( line, 'diff --git ' + exception ) ||
 						_.startsWith( line, 'diff --git a/' + exception )
 					) {
 						throw true;
 					}
-				});
+				} );
 
-				if ( _.startsWith( line, 'Index: wp-'      ) ||
+				if ( _.startsWith( line, 'Index: wp-' ) ||
 					_.startsWith( line, 'Index: trunk/wp-' ) ||
-					_.startsWith( line, 'diff --git wp-'   ) ||
+					_.startsWith( line, 'diff --git wp-' ) ||
 					_.startsWith( line, 'diff --git a/wp-' )
 				) {
 					throw true;
 				}
-
-			});
+			} );
 			throw true;
 		} catch ( l ) {
 			src = l;
 		}
 		return src;
-	}
-
+	},
 
 };

lib/patch.js

@@ -1,30 +1,28 @@
-var _ = require( 'underscore' );
+const _ = require( 'underscore' );
 
 _.str = _.str = require( 'underscore.string' );
 _.mixin( _.str.exports() );
 
 module.exports = {
-	patchAttachments: function( html ) {
+	patchAttachments( html ) {
 		return html.match( /<dt>\s*<a\s+href="([^"]+?)(diff|patch)"\s+title="View attachment">([^<]+)/g );
 	},
-	urlsFromAttachmentList: function( html ) {
+	urlsFromAttachmentList( html ) {
 		return html.match( /href="([^"]+)"/ );
 	},
-	longMatches: function( html ) {
+	longMatches( html ) {
 		return html.match( /<dt([\s|\S]*?)dt>/g );
 	},
-	possiblePatches: function( longMatches ) {
-		return _.compact( _.map( longMatches, function( match ) {
+	possiblePatches( longMatches ) {
+		return _.compact( _.map( longMatches, ( match ) => {
 			if ( match.match( /(patch|diff)"/ ) ) {
 				return _.clean( _.trim( _( match ).stripTags().replace( /\n/g, ' ' ) ) );
-			} else {
-				return false;
 			}
-		}) );
+			return false;
+		} ) );
 	},
-	localFileClean: function( file ) {
+	localFileClean( file ) {
 		return file.replace( '?', '' ).replace( /\s/g, '' );
-	}
-
+	},
 
 };

lib/regex.js

@@ -1,12 +1,12 @@
-var url = require( 'url' ),
-	grunt = require( 'grunt' );
+const url = require( 'url' );
+const grunt = require( 'grunt' );
 
 module.exports = {
-	convertToRaw: function( parsedUrl, options ) {
+	convertToRaw( parsedUrl ) {
 		grunt.log.debug( 'convertToRaw: ' + JSON.stringify( parsedUrl ) );
 		parsedUrl.pathname = parsedUrl.pathname.replace( /attachment/, 'raw-attachment' );
 		grunt.log.debug( 'converted_from_raw: ' + url.format( parsedUrl ) );
 		return url.format( parsedUrl );
-	}
+	},
 
 };

lib/trac.js

@@ -24,7 +24,7 @@
     "test": "jest",
     "test:coverage": "jest --coverage",
     "test:watch": "jest --watch",
-    "lint": "eslint . --ignore-path coverage",
+    "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   },
   "jest": {
@@ -33,8 +33,8 @@
     ]
   },
   "devDependencies": {
-    "eslint": "^4.17.0",
-    "eslint-config-wordpress": "^2.0.0",
+    "@wordpress/eslint-plugin": "^2.0.0",
+    "eslint": "^5.15.1",
     "jest": "^24.5.0"
   },
   "dependencies": {