Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
language Release 0.9.0 (#118) Nov 20, 2018
test jquery: Add `jquery/no-animate` rule (#147) Dec 17, 2018
.eslintrc.json
.gitignore
.travis.yml
CHANGELOG.md
client.json
common.json
jquery.json
license
package-lock.json
package.json Replace invalid-results.json files with --report-unused-disable-direc… Dec 14, 2018
qunit.json
readme.md
server.json Refactor code to split into multiple profiles (#109) Nov 19, 2018

readme.md

Build Status

Wikimedia ESLint config

Installation

npm install --save-dev eslint-config-wikimedia

Then, configure ESLint with one or more .eslintrc.json files as appropriate.

Example configurations

Bellow are some potential recommended uses:

A typical front-end project

This profile allows ES5 code and browser native functions. It will complain about ES6+ code and language features.

.eslintrc.json:

{
	"extends": "wikimedia/client"
}

jQuery

This profile adds the jQuery $ global, and additional rules preventing the use of jQuery features that have ES5 alternatives. .eslintrc.json:

{
	"extends": [
		"wikimedia/client",
		"wikimedia/jquery"
	]
}

Adding a QUnit test suite

You can extend the above profile by also adding a second .eslintrc.json file in your tests directory:

tests/qunit/.eslintrc.json:

{
	"extends": [
		"wikimedia/qunit",
		"../../.eslintrc.json"
	]
}

A typical Node project

This profile allows ES6 code and node native functions (i.e., Node 6.x). It will complain about ES2015+ code and language features.

.eslintrc.json:

{
	"extends": "wikimedia/server"
}

A basic project

Please note that the basic project configuration does not specify any language or environmental defaults, and is unlikely to be suitable. However, if you wish to target clients with ES3 language support, or earlier versions of Node, this is a good place from which to start.

.eslintrc.json:

{
	"extends": "wikimedia"
}

Proposing changes

Major changes should be discussed on mediawiki.org or on the Wikitech mailing list beforehand.

Semver policy

Same approach as in ESLint, see https://github.com/eslint/eslint#user-content-semantic-versioning-policy.