wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-13 17:56:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Popups/.eslintrc.json

47 lines
876 B
JSON
Raw Normal View History

Remove jshint/jscs, add eslint and stylelint ...with the wikimedia presets. For automatically fixing most of the JS lint problems run grunt eslint:fix Some rules of stylelint were disabled given they cause problems with existing popups code (like no id selectors for example). Change-Id: I2153047c3ddbea50572dd329989088bb20787515
2016-12-16 11:11:54 +00:00
{
Hygiene: limit ESLint inheritance The project ESLint configuration unintentionally inherited unwanted configuration from MediaWiki, which allows global jQuery usage. Cap the project's ESLint hierarchy at the project root. Change-Id: I5177d306feface7fcce0867c624bbcf9e74f19fc
2018-10-05 16:24:24 +00:00
"root": true,
Upgrade elint-config-wikimedia (drop eslint-plugin-qunit) The following upgrade was made: eslint-config-wikimedia | 0.8.1 | 0.9.0 The upgrade of eslint-config-wikimedia removes the need of eslint-plugin-qunit as a peerDependency because it is now a hard dependency [1] so it was removed in our package.json. It appears the biggest change in the upgrade was the use of separate profiles [2]. Given this, our root .eslintrc.json was updated to extend from 'wikimedia/client'. Several test files were flagged by the upgraded linter and were fixed in this patch. Additionally, our build file was flagged for having too many statements on one line. This rule was turned off in .eslintrc.es5.json [1] https://github.com/wikimedia/eslint-config-wikimedia/blob/master/package.json#L48 [2] https://github.com/wikimedia/eslint-config-wikimedia/blob/master/CHANGELOG.md#090--2018-11-19 Bug: T209314 Change-Id: I29db72e77f04a327bc9c2b558c6d53849287bb80
2018-12-13 03:09:26 +00:00
"extends": "wikimedia/client",
Use EcmaScript modules instead of common.js modules Why: Because they are the approved standard by TC39 and Ecma for JavaScript modules. Changes: * Wrap mw-node-qunit in run.js to register babel to transpile modules for node v6 * Change all sources in src/ to use ES modules * Change constants.js to be able to run without jQuery.bracketedDevicePixelRatio given ES modules are hoisted to the top by spec so we can't patch globals before importing it * Change all tests in tests/node-qunit/ to use ES modules * Drop usage of mock-require given ES modules are easy to stub with sinon Additional changes: * Rename tests/node-qunit/renderer.js to renderer.test.js to follow the convention of all the other files * Make npm run test:node run only .test.js test files so that it doesn't run the stubs.js or run.js file. Bug: T171951 Change-Id: I17a0b76041d5e2fd18e2d54950d9d7c0db99a941
2017-07-28 17:32:46 +00:00
"parserOptions": {
Explicitly set ecmaVersion for eslint Before, because of the use of sourceType: "module", ecmaVersion would be assumed to be ES2015, but we write ES5 here at the moment. This enables linting against ES2015 features like let and const. See https://gerrit.wikimedia.org/r/#/c/374789/ for failing POC. Change-Id: Id1d147866c37de3794213378a5e8a08af6f796a1
2017-08-30 11:47:49 +00:00
"sourceType": "module",
Hygiene: bump ESLint to ES6 and lint more files - Bump the ESLint configuration ECMAScript 2015 given that we use Babel and have a safeguard to verify build products are ES5. - Lint more files including all tests and the Webpack and Grunt configs. Change-Id: I099cbe009eda2349ddc051976ace0d9f6c55fa30
2018-05-01 19:17:08 +00:00
"ecmaVersion": "6"
Use EcmaScript modules instead of common.js modules Why: Because they are the approved standard by TC39 and Ecma for JavaScript modules. Changes: * Wrap mw-node-qunit in run.js to register babel to transpile modules for node v6 * Change all sources in src/ to use ES modules * Change constants.js to be able to run without jQuery.bracketedDevicePixelRatio given ES modules are hoisted to the top by spec so we can't patch globals before importing it * Change all tests in tests/node-qunit/ to use ES modules * Drop usage of mock-require given ES modules are easy to stub with sinon Additional changes: * Rename tests/node-qunit/renderer.js to renderer.test.js to follow the convention of all the other files * Make npm run test:node run only .test.js test files so that it doesn't run the stubs.js or run.js file. Bug: T171951 Change-Id: I17a0b76041d5e2fd18e2d54950d9d7c0db99a941
2017-07-28 17:32:46 +00:00
},
Remove jshint/jscs, add eslint and stylelint ...with the wikimedia presets. For automatically fixing most of the JS lint problems run grunt eslint:fix Some rules of stylelint were disabled given they cause problems with existing popups code (like no id selectors for example). Change-Id: I2153047c3ddbea50572dd329989088bb20787515
2016-12-16 11:11:54 +00:00
"env": {
"browser": true,
"jquery": true,
build: Update linters Bug: T202739 Change-Id: Ie3f68977598f46f7e12b216f8381b2e9dc6d83ad
2018-09-11 11:53:15 +00:00
"commonjs": true
Remove jshint/jscs, add eslint and stylelint ...with the wikimedia presets. For automatically fixing most of the JS lint problems run grunt eslint:fix Some rules of stylelint were disabled given they cause problems with existing popups code (like no id selectors for example). Change-Id: I2153047c3ddbea50572dd329989088bb20787515
2016-12-16 11:11:54 +00:00
},
"globals": {
"mediaWiki": false,
"OO": false,
"moment": false,
"Redux": false,
"ReduxThunk": false
},
"rules": {
Upgrade eslint-config-wikimedia * Force arrow-parens * Disable no-prototype-builtins for time being * Drop unnecessary maxlen rule Change-Id: Iceb0fe47354a5753202d2c6ad9e1a9c76791f744
2018-07-06 15:41:19 +00:00
"no-prototype-builtins": 0,
Hygiene: restrict use of $.each and fix offenders Bug: T190142 Change-Id: I5da7a4a1ffe14647ec70b10b3a7ab9b935c5ca84
2018-03-20 18:03:13 +00:00
"no-restricted-properties": [2,
{
"object": "$",
"property": "each",
"message": "Please use Array.forEach"
}
],
Enforce eslinting for jsdoc Let's improve our documentation by linting it and ensuring it is complete and matches guidelines This fixes offenders Change-Id: I7c829b375705e763085cf731e9a77cc14339af67
2018-07-09 16:56:45 +00:00
"valid-jsdoc": ["error", {
"requireParamDescription": false,
"requireReturnDescription": false,
"preferType": {
"Boolean": "boolean",
"Number": "number",
"object": "Object",
"String": "string"
}
}],
Hygiene: use consistent ESLint severity syntax Bug: T165036 Change-Id: I43a500fceb8179d30240dbec8ed56f8d4c7551e9
2018-03-19 19:44:14 +00:00
"dot-notation": [ 2, { "allowKeywords": true } ],
Limit line length to 80 characters Enforce it with eslint. Ignore: * Comment lines with eslint disable directives * QUnit test lines as they contain long subjects (QUnit.* (only, test, module, skip, etc) * Strings, since long strings are used extensively in tests * Ignore template literals for similar reasons * Regex literals as they may be too long, but can't be easily split in several lines * Long urls See bug for more general proposal for eslint-wikimedia-config. Bug: T185295 Change-Id: I3aacaf46e61a4d96547c513073e179ef997deb09
2018-01-18 18:48:16 +00:00
"no-use-before-define": 0,
Hygiene: replace var with let and const eslint \ --cache \ --max-warnings 0 \ --report-unused-disable-directives \ --fix \ src tests Change-Id: I051275126ae7fa9affd16c2504017c0584f2d9c7
2018-03-15 16:30:11 +00:00
"no-var": 2,
Hygiene: favor const Bug: T165036 Change-Id: I17d374eaac6627ca6a8ba178862b2a9cff2538c0
2018-03-19 19:39:41 +00:00
"prefer-const": 1,
Hygiene: favor string templates over concatenation Update the ESLint config to favor ES6 strings where variables or string concatenation is used and fix *all* offenders automatically via: eslint \ --cache \ --max-warnings 0 \ --report-unused-disable-directives \ --fix \ src tests Change-Id: I1a9345162348e5ded21d541e7a2ce251ea72ab5a
2018-03-20 17:01:18 +00:00
"prefer-template": 1,
Upgrade eslint-config-wikimedia * Force arrow-parens * Disable no-prototype-builtins for time being * Drop unnecessary maxlen rule Change-Id: Iceb0fe47354a5753202d2c6ad9e1a9c76791f744
2018-07-06 15:41:19 +00:00
"one-var": 0
Remove jshint/jscs, add eslint and stylelint ...with the wikimedia presets. For automatically fixing most of the JS lint problems run grunt eslint:fix Some rules of stylelint were disabled given they cause problems with existing popups code (like no id selectors for example). Change-Id: I2153047c3ddbea50572dd329989088bb20787515
2016-12-16 11:11:54 +00:00
}
}
Reference in a new issue Copy permalink