Build: Switch from JSHint & JSCS to ESLint

Fixes gh-438 Closes gh-442
jquery · May 29, 2019 · 62061d04f137fb49419255433eaa9d28608016fd · 62061d0
1 parent 7d92424
commit 62061d04f137fb49419255433eaa9d28608016fd
diff --git a/.editorconfig b/.editorconfig
@@ -4,8 +4,12 @@
 root = true
 
 [*]
+indent_style = tab
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
-indent_style = tab
+
+[package.json]
+indent_style = space
+indent_size = 2
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,7 @@
+external
+node_modules
+*.min.js
+# Ignore everything in dist folder except for eslint config
+dist/**
+!dist/sizzle.js
+build/**
diff --git a/.eslintrc-browser.json b/.eslintrc-browser.json
@@ -0,0 +1,29 @@
+{
+	"root": true,
+
+	"extends": "jquery",
+
+	"parserOptions": {
+		"ecmaVersion": 3
+	},
+
+	// The browser env is not enabled on purpose so that code takes
+	// all browser-only globals from window instead of assuming
+	// they're available as globals. This makes it possible to use
+	// jQuery with tools like jsdom which provide a custom window
+	// implementation.
+	"env": {
+		"node": true
+	},
+
+	"globals": {
+		"window": true,
+		"jQuery": true,
+		"define": true,
+		"module": true
+	},
+
+	"rules": {
+		"dot-notation": "off"
+	}
+}
diff --git a/.eslintrc-node.json b/.eslintrc-node.json
@@ -0,0 +1,14 @@
+{
+	"root": true,
+
+	"extends": "jquery",
+
+	"parserOptions": {
+		"ecmaVersion": 2017
+	},
+
+	"env": {
+		"es6": true,
+		"node": true
+	}
+}
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+	"extends": ".eslintrc-node.json"
+}
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@
 .DS_Store
 node_modules
 bower_components
+.idea/
diff --git a/.jscsrc b/.jscsrc
diff --git a/.jshintrc b/.jshintrc
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -20,7 +20,7 @@ module.exports = function( grunt ) {
 		files = {
 			source: "src/sizzle.js",
 			speed: "speed/speed.js",
-			tests: "test/unit/*.js",
+			tests: "test/{data,unit}/*.js",
 			karma: "test/karma/*.js",
 			grunt: [ "Gruntfile.js", "tasks/*" ]
 		};
@@ -45,13 +45,13 @@ module.exports = function( grunt ) {
 
 			// Real Safari 6.1 and 7.0 are not available
 			"bs_safari-6.0", "bs_safari-8.0", "bs_safari-9.1", "bs_safari-10.1",
-			"bs_safari-11.1", "bs_safari-12.0",
+			"bs_safari-11.1", "bs_safari-12.0"
 		];
 
 		browsers.ios = [
 			"bs_ios-5.1", "bs_ios-6.0", "bs_ios-7.0", "bs_ios-8.3", "bs_ios-9.3", "bs_ios-10.3",
 
-			 "bs_ios-11.4", "bs_ios-12.1",
+			"bs_ios-11.4", "bs_ios-12.1"
 		];
 		browsers.android = [
 			"bs_android-4.0", "bs_android-4.1", "bs_android-4.2",
@@ -69,7 +69,7 @@ module.exports = function( grunt ) {
 	}
 
 	// Project configuration
-	grunt.initConfig({
+	grunt.initConfig( {
 		pkg: grunt.file.readJSON( "package.json" ),
 		dateString: new Date().toISOString().replace( /\..*Z/, "" ),
 		compile: {
@@ -133,42 +133,33 @@ module.exports = function( grunt ) {
 
 					"requirejs/require.js": "requirejs/require.js",
 					"requirejs-domready/domReady.js": "requirejs-domready/domReady.js",
-					"requirejs-text/text.js": "requirejs-text/text.js",
+					"requirejs-text/text.js": "requirejs-text/text.js"
 				}
 			}
 		},
-		jshint: {
+		eslint: {
 			options: {
-				jshintrc: true
+
+				// See https://github.com/sindresorhus/grunt-eslint/issues/119
+				quiet: true
 			},
-			all: {
+
+			dist: {
+				src: "dist/sizzle.js"
+			},
+			dev: {
 				src: [ files.source, files.grunt, files.karma, files.speed, files.tests ]
-			}
-		},
-		jscs: {
-			src: {
-				options: {
-					requireDotNotation: null
-				},
-				src: [ files.source ]
 			},
 			grunt: {
-				options: {
-					requireCamelCaseOrUpperCaseIdentifiers: null
-				},
-				src: [ files.grunt ]
+				src: files.grunt
+			},
+			speed: {
+				src: [ files.speed ]
 			},
-			speed: [ files.speed ],
 			tests: {
-				options: {
-					maximumLineLength: null
-				},
 				src: [ files.tests ]
 			},
 			karma: {
-				options: {
-					requireCamelCaseOrUpperCaseIdentifiers: null
-				},
 				src: [ files.karma ]
 			}
 		},
@@ -256,15 +247,15 @@ module.exports = function( grunt ) {
 			],
 			tasks: [ "build", "karma:watch:run" ]
 		}
-	});
+	} );
 
 	// Integrate Sizzle specific tasks
 	grunt.loadTasks( "tasks" );
 
 	// Load dev dependencies
 	require( "load-grunt-tasks" )( grunt );
 
-	grunt.registerTask( "lint", [ "jsonlint", "jshint", "jscs" ] );
+	grunt.registerTask( "lint", [ "jsonlint", "eslint:dev", "eslint:dist" ] );
 	grunt.registerTask( "start", [ "karma:watch:start", "watch" ] );
 
 	// Execute tests all browsers in sequential way,
@@ -282,7 +273,13 @@ module.exports = function( grunt ) {
 	] : "karma:phantom" );
 
 	grunt.registerTask( "build", [ "lint", "compile", "uglify", "dist", "ensure_ascii" ] );
-	grunt.registerTask( "default", [ "build", "tests", "compare_size" ] );
+	grunt.registerTask( "default", [
+		"eslint:dev",
+		"build",
+		"tests",
+		"compare_size",
+		"eslint:dist"
+	] );
 
 	grunt.registerTask( "bower", "bowercopy" );
 };
diff --git a/dist/.eslintrc.json b/dist/.eslintrc.json
@@ -0,0 +1,12 @@
+{
+	"root": true,
+
+	"extends": "../.eslintrc-browser.json",
+	"rules": {
+		// That is okay for the built version
+		"no-multiple-empty-lines": "off",
+
+		// Too many violations.
+		"no-nested-ternary": "off"
+	}
+}