eslint: Update to eslint-config-wikimedia 0.16.0

* valid-jsdoc replaced with jsdoc plugin
* New /selenium config

Change-Id: I471eebac0312cb25c539c3f6a3ecfc7cfd4ed8d6

.eslintrc.json

@@ -13,5 +13,16 @@
 		"max-len": "off",
 		"mediawiki/valid-package-file-require": "off",
 		"no-jquery/no-global-selector": "off"
+	},
+	"settings": {
+		"jsdoc": {
+			"tagNamePreference": {
+				"this": "context",
+				"context": "context",
+				"alias": "alternateClassName",
+				"alternateClassName": "alternateClassName",
+				"typedef": "type"
+			}
+		}
 	}
 }

Gruntfile.js

@@ -20,7 +20,8 @@ module.exports = function ( grunt ) {
 		eslint: {
 			options: {
 				extensions: [ '.js', '.json', '.vue' ],
-				cache: true
+				cache: true,
+				fix: grunt.option( 'fix' )
 			},
 			all: '.'
 		},

maintenance/mediawiki.Title/generateJsToUpperCaseList.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const chars = [];
 
 for ( let i = 0; i <= 0x10ffff; i++ ) {

package.json

@@ -22,12 +22,12 @@
     "@wdio/sauce-service": "6.1.9",
     "@wdio/sync": "6.1.8",
     "api-testing": "1.0.3",
-    "eslint-config-wikimedia": "0.15.3",
+    "eslint-config-wikimedia": "0.16.0",
     "grunt": "1.1.0",
     "grunt-banana-checker": "0.9.0",
     "grunt-contrib-copy": "1.0.0",
     "grunt-contrib-watch": "1.1.0",
-    "grunt-eslint": "22.0.0",
+    "grunt-eslint": "23.0.0",
     "grunt-karma": "4.0.0",
     "grunt-stylelint": "0.15.0",
     "grunt-svgmin": "5.0.0",

resources/src/jquery/jquery.confirmable.js

@@ -12,7 +12,6 @@
 		return data;
 	};
 
-	// eslint-disable-next-line valid-jsdoc
 	/**
 	 * Enable inline confirmation for given clickable element (like `<a />` or `<button />`).
 	 *

resources/src/mediawiki.ForeignApi.core.js

@@ -50,7 +50,7 @@
 		this.apiUrl = String( url );
 		this.anonymous = options && options.anonymous;
 
-		options = $.extend( /* deep=*/ true,
+		options = $.extend( /* deep= */ true,
 			{
 				ajax: {
 					url: this.apiUrl,

resources/src/mediawiki.Title/Title.js

@@ -968,13 +968,19 @@ Title.prototype = {
 };
 
 /**
- * @alias #getPrefixedDb
+ * Alias of mw.Title#getPrefixedDb
+ *
+ * TODO: Use @-alias when we switch to JSDoc
+ *
  * @method
  */
 Title.prototype.toString = Title.prototype.getPrefixedDb;
 
 /**
- * @alias #getPrefixedText
+ * Alias of mw.Title#getPrefixedText
+ *
+ * TODO: Use @-alias when we switch to JSDoc
+ *
  * @method
  */
 Title.prototype.toText = Title.prototype.getPrefixedText;

resources/src/mediawiki.page.ready/checkboxHack.js

@@ -108,16 +108,20 @@
 
 /**
  * Checkbox hack listener state.
- * @type {Object} CheckboxHackListeners
- * @property {EventListenerOrEventListenerObject} [onUpdateAriaExpandedOnInput]
- * @property {EventListenerOrEventListenerObject} [onToggleOnClick]
- * @property {EventListenerOrEventListenerObject} [onDismissOnClickOutside]
- * @property {EventListenerOrEventListenerObject} [onDismissOnFocusLoss]
+ *
+ * TODO: Change to @-typedef when we switch to JSDoc
+ *
+ * @class {Object} CheckboxHackListeners
+ * @property {Function} [onUpdateAriaExpandedOnInput]
+ * @property {Function} [onToggleOnClick]
+ * @property {Function} [onDismissOnClickOutside]
+ * @property {Function} [onDismissOnFocusLoss]
  * @ignore
  */
 
 /**
  * Revise the aria-expanded state to match the checked state.
+ *
  * @param {HTMLInputElement} checkbox
  * @return {void}
  * @ignore
@@ -129,6 +133,7 @@ function updateAriaExpanded( checkbox ) {
 /**
  * Returns true if the Event's target is an inclusive descendant of any the checkbox hack's
  * constituents (checkbox, button, or target), and false otherwise.
+ *
  * @param {HTMLInputElement} checkbox
  * @param {HTMLElement} button
  * @param {Node} target
@@ -146,6 +151,7 @@ function containsEventTarget( checkbox, button, target, event ) {
 
 /**
  * Dismiss the target when event is outside the checkbox, button, and target.
+ *
  * @param {HTMLInputElement} checkbox
  * @param {HTMLElement} button
  * @param {Node} target
@@ -162,6 +168,7 @@ function dismissIfExternalEventTarget( checkbox, button, target, event ) {
 
 /**
  * Update the `aria-expanded` attribute based on checkbox state (target visibility) changes.
+ *
  * @param {HTMLInputElement} checkbox
  * @return {CheckboxHackListeners}
  * @ignore
@@ -175,6 +182,7 @@ function bindUpdateAriaExpandedOnInput( checkbox ) {
 
 /**
  * Manually change the checkbox state to avoid a focus change when using a pointing device.
+ *
  * @param {HTMLInputElement} checkbox
  * @param {HTMLElement} button
  * @return {CheckboxHackListeners}
@@ -195,6 +203,7 @@ function bindToggleOnClick( checkbox, button ) {
 /**
  * Dismiss the target when clicking elsewhere and update the `aria-expanded` attribute based on
  * checkbox state (target visibility).
+ *
  * @param {Window} window
  * @param {HTMLInputElement} checkbox
  * @param {HTMLElement} button
@@ -211,6 +220,7 @@ function bindDismissOnClickOutside( window, checkbox, button, target ) {
 /**
  * Dismiss the target when focusing elsewhere and update the `aria-expanded` attribute based on
  * checkbox state (target visibility).
+ *
  * @param {Window} window
  * @param {HTMLInputElement} checkbox
  * @param {HTMLElement} button

resources/src/mediawiki.rcfilters/dm/FilterGroup.js

@@ -384,21 +384,23 @@ FilterGroup.prototype.hasWhatsThis = function () {
  * Get the conflicts associated with the entire group.
  *
  * Conflict object is set up by filter name keys and conflict
- * definition. For example:
- * [
- *     {
- *         filterName: {
- *             filter: filterName,
- *             group: group1
+ * definition.
+ *
+ *     @example
+ *     [
+ *         {
+ *             filterName: {
+ *                 filter: filterName,
+ *                 group: group1
+ *             }
+ *         },
+ *         {
+ *             filterName2: {
+ *                 filter: filterName2,
+ *                 group: group2
+ *             }
  *         }
- *     },
- *     {
- *         filterName2: {
- *             filter: filterName2,
- *             group: group2
- *         }
- *     }
- * ]
+ *     ]
  *
  * @return {Object} Conflict definition
  */

resources/src/mediawiki.util/util.js

@@ -534,6 +534,7 @@ util = {
 	 * Parse the URL of an image uploaded to MediaWiki, or a thumbnail for such an image,
 	 * and return the image name, thumbnail size and a template that can be used to resize
 	 * the image.
+	 *
 	 * @param {string} url URL to parse (URL-encoded)
 	 * @return {Object|null} URL data, or null if the URL is not a valid MediaWiki
 	 *   image/thumbnail URL.

resources/src/mediawiki.widgets.datetime/CalendarWidget.js

@@ -202,7 +202,6 @@
 		return this.selected;
 	};
 
-	// eslint-disable-next-line valid-jsdoc
 	/**
 	 * Set the selected dates
 	 *
@@ -253,7 +252,6 @@
 		return this.focusedDate;
 	};
 
-	// eslint-disable-next-line valid-jsdoc
 	/**
 	 * Set the currently-focused date
 	 *

resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js

@@ -125,7 +125,6 @@
 		return this.local;
 	};
 
-	// eslint-disable-next-line valid-jsdoc
 	/**
 	 * Toggle whether dates are in local time or UTC
 	 *

resources/src/startup/mediawiki.js

@@ -50,7 +50,7 @@
 		// <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set>
 		/**
 		 * @private
-		 * @class
+		 * @class StringSet
 		 */
 		StringSet = window.Set || function () {
 			var set = Object.create( null );
@@ -491,7 +491,7 @@
 			 *
 			 * See #implement and #execute for exact details on support for script, style and messages.
 			 *
-			 * Format:
+			 *     @example Format:
 			 *
 			 *     {
 			 *         'moduleName': {
@@ -565,7 +565,7 @@
 				 * Typically when a job is created for a module, the job's dependencies contain
 				 * both the required module and all its recursive dependencies.
 				 *
-				 * Format:
+				 *     @example Format:
 				 *
 				 *     {
 				 *         'dependencies': [ module names ],
@@ -1847,6 +1847,7 @@
 				 *
 				 * The #work() method will use this information to split up requests by source.
 				 *
+				 *     @example
 				 *     mw.loader.addSource( { mediawikiwiki: 'https://www.mediawiki.org/w/load.php' } );
 				 *
 				 * @private

tests/api-testing/.eslintrc.json

@@ -1,15 +1,10 @@
 {
 	"extends": [
-		"wikimedia/server",
-		"wikimedia/node",
-		"wikimedia/language/es2017"
+		"wikimedia/server"
 	],
 	"env": {
 		"mocha": true
 	},
-	"parserOptions": {
-		"ecmaVersion": 2018
-	},
 	"rules": {
 		"camelcase": "off",
 		"require-atomic-updates": "off"

tests/api-testing/REST/Creation.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, REST, utils } = require( 'api-testing' );
 const supertest = require( 'supertest' );
 

tests/api-testing/REST/PageHTMLBare.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, REST, utils } = require( 'api-testing' );
 
 describe( 'Page HTML Bare', () => {

tests/api-testing/REST/PageHistory.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, REST, utils } = require( 'api-testing' );
 
 describe( 'Page History', () => {

tests/api-testing/REST/PageSource.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, REST, utils } = require( 'api-testing' );
 
 describe( 'Page Source', () => {

tests/api-testing/REST/Revision.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, REST, utils } = require( 'api-testing' );
 
 describe( 'Revision', () => {

tests/api-testing/REST/Search.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, REST, utils } = require( 'api-testing' );
 
 describe( 'Search', () => {

tests/api-testing/REST/Update.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, REST, utils } = require( 'api-testing' );
 
 describe( 'PUT /page/{title}', () => {

tests/api-testing/action/Autopatrolling.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { assert, action, utils } = require( 'api-testing' );
 
 describe( 'Testing default autopatrolling rights', function () {

tests/api-testing/action/Backlinks.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Backlinks', function () {

tests/api-testing/action/Categories.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { assert, action, utils } = require( 'api-testing' );
 
 describe( 'Categories', function testCategories() {

tests/api-testing/action/Delete.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The delete/undelete action', function testDeleteAction() {

tests/api-testing/action/DiffCompare.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Diff Compare with Variables', function () {

tests/api-testing/action/Edit.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The edit action', function testEditAction() {

tests/api-testing/action/Links.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Links', function testLinks() {

tests/api-testing/action/ListUsers.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Listing Users', function () {

tests/api-testing/action/Move.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Move action', function () {

tests/api-testing/action/NewTalkNotification.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert } = require( 'api-testing' );
 
 describe( 'Testing a new talk page notification', function () {

tests/api-testing/action/PageProtection.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Test page protection levels and effectiveness', function () {

tests/api-testing/action/Parse.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The parse action', function () {

tests/api-testing/action/Patrolling.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The patrol action', function testEditPatrolling() {

tests/api-testing/action/Preferences.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert } = require( 'api-testing' );
 
 describe( "Changing a user's preferences", function () {

tests/api-testing/action/PrefixSearch.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Prefix Search', function () {

tests/api-testing/action/RecentChanges.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Recent Changes', function () {

tests/api-testing/action/ReparseDependentPages.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Reparse of dependent pages', function () {

tests/api-testing/action/Revision.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Testing Revisions', function () {

tests/api-testing/action/Rollback.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The rollback action', function testEditRollback() {

tests/api-testing/action/SiteStats.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( "Testing site statistics' edits value", function () {

tests/api-testing/action/Undo.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'Testing undo functionality', function () {

tests/api-testing/action/UserBlock.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The block/unblock action', function testBlockingAUser() {

tests/api-testing/action/UserContribs.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The usercontribs list query', function testUserContribsListQuery() {

tests/api-testing/action/UserInfo.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( "Changing a user's `editfont` option", function getUserOptions() {

tests/api-testing/action/Watchlist.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { action, assert, utils } = require( 'api-testing' );
 
 describe( 'The watchlist', function testWatch() {

tests/selenium/.eslintrc.json

@@ -1,19 +1,9 @@
 {
 	"root": true,
 	"extends": [
-		"wikimedia",
-		"wikimedia/node",
-		"wikimedia/language/es2017",
-		"wikimedia/jquery"
+		"wikimedia/selenium"
 	],
-	"env": {
-		"mocha": true
-	},
 	"globals": {
-		"browser": "readonly",
 		"mw": "readonly"
-	},
-	"rules": {
-		"no-jquery/no-global-selector": "off"
 	}
 }

tests/selenium/pageobjects/createaccount.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class CreateAccountPage extends Page {

tests/selenium/pageobjects/delete.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class DeletePage extends Page {

tests/selenium/pageobjects/edit.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class EditPage extends Page {

tests/selenium/pageobjects/history.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 const Util = require( 'wdio-mediawiki/Util' );
 

tests/selenium/pageobjects/preferences.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class PreferencesPage extends Page {

tests/selenium/pageobjects/recentchanges.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class RecentChangesPage extends Page {

tests/selenium/pageobjects/restore.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class RestorePage extends Page {

tests/selenium/pageobjects/undo.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class UndoPage extends Page {

tests/selenium/pageobjects/watchable.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class WatchablePage extends Page {

tests/selenium/pageobjects/watchlist.page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( 'wdio-mediawiki/Page' );
 
 class WatchlistPage extends Page {

tests/selenium/specs/page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const assert = require( 'assert' );
 const Api = require( 'wdio-mediawiki/Api' );
 const DeletePage = require( '../pageobjects/delete.page' );

tests/selenium/specs/rollback.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const assert = require( 'assert' );
 const HistoryPage = require( '../pageobjects/history.page' );
 const Api = require( 'wdio-mediawiki/Api' );

tests/selenium/specs/specialrecentchanges.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const assert = require( 'assert' );
 const Api = require( 'wdio-mediawiki/Api' );
 const RecentChangesPage = require( '../pageobjects/recentchanges.page' );

tests/selenium/specs/specialwatchlist.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const assert = require( 'assert' );
 const Api = require( 'wdio-mediawiki/Api' );
 const WatchlistPage = require( '../pageobjects/watchlist.page' );

tests/selenium/specs/user.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const assert = require( 'assert' );
 const CreateAccountPage = require( '../pageobjects/createaccount.page' );
 const PreferencesPage = require( '../pageobjects/preferences.page' );

tests/selenium/wdio-mediawiki/Api.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const MWBot = require( 'mwbot' );
 
 module.exports = {

tests/selenium/wdio-mediawiki/BlankPage.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( './Page' );
 
 class BlankPage extends Page {

tests/selenium/wdio-mediawiki/LoginPage.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const Page = require( './Page' );
 
 class LoginPage extends Page {

tests/selenium/wdio-mediawiki/Page.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const querystring = require( 'querystring' );
 
 /**

tests/selenium/wdio-mediawiki/RunJobs.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const MWBot = require( 'mwbot' );
 const Page = require( './Page' );
 const MAINPAGE_REQUESTS_MAX_RUNS = 10; // (arbitrary) safe-guard against endless execution

tests/selenium/wdio-mediawiki/Util.js

@@ -1,3 +1,5 @@
+'use strict';
+
 module.exports = {
 	getTestString( prefix = '' ) {
 		return prefix + Math.random().toString() + '-Iñtërnâtiônàlizætiøn';

tests/selenium/wdio-mediawiki/index.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const fs = require( 'fs' );
 
 module.exports = {

tests/selenium/wdio-mediawiki/specs/BlankPage.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const assert = require( 'assert' );
 const BlankPage = require( './../BlankPage' );
 

tests/selenium/wdio.conf.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const fs = require( 'fs' );
 const path = require( 'path' );
 const logPath = process.env.LOG_DIR || path.join( __dirname, '/log' );
@@ -108,6 +110,7 @@ exports.config = {
 	// =====
 	/**
 	 * Executed before a Mocha test starts.
+	 *
 	 * @param {Object} test Mocha Test object
 	 */
 	beforeTest: function ( test ) {