eslint-config-wikimedia/mediawiki/common.js

ESLint config following Wikimedia code conventions.

'use strict';

const commonRules = require( '../common' );
const browsers = require( 'browserslist-config-wikimedia/modern' );

/* eslint-disable quote-props, quotes */
const config = {
	"globals": {
		"mw": "readonly",
		"OO": "readonly",
		"require": "readonly",
		"module": "readonly",
		"exports": "writable"
	},
	"plugins": [
		"mediawiki",
		"compat"
	],
	"extends": [ "plugin:mediawiki/common" ],
	"rules": {
		"compat/compat": [
			"error",
			browsers.join( ',' )
		]
	},
	"parserOptions": {
		"sourceType": "commonjs"
	},
	"overrides": [
		{
			"files": [ "**/*.vue" ],
			"extends": [ "plugin:mediawiki/vue" ],
			"rules": {
				"vue/html-self-closing": [ "error", {
					"html": {
						"void": "never",
						"normal": "never",
						"component": "never"
					}
				} ],
				"vue/component-name-in-template-casing": [ "error", "kebab-case" ],
				"vue/no-child-content": [ "error", {
					"additionalDirectives": [ "i18n-html" ]
				} ]
			}
		}
	]
};

// Extend max-len.ignorePattern
config.rules[ 'max-len' ] = commonRules.rules[ 'max-len' ];
config.rules[ 'max-len' ][ 1 ].ignorePattern =
	'(' +
		config.rules[ 'max-len' ][ 1 ].ignorePattern +
		'|' +
		'[\\s]*(//|<!--) *\\* ?[\\S]+$' +
	')';
// Duplicate JSON override from common rules to prevent max-len rule here taking precedent
const jsonOverride = commonRules.overrides.find( ( override ) => override.parser === 'eslint-plugin-json-es' );
// Adjust path, keep in sync with common.json
jsonOverride.extends = '../json';
config.overrides.push( jsonOverride );

module.exports = config;