README.md

eslint-plugin-mediawiki

MediaWiki-specific linting rules, for use in MediaWiki core and extensions.

Usage

If you are developing in MediaWiki you should be using eslint-config-wikimedia which includes this plugin.

Add mediawiki to the plugins section of your .eslintrc configuration file, then enable the required rules.

{
  "plugins": [
    "mediawiki"
  ],
  "rules": {
    "mediawiki/msg-doc": "error"
  }
}

There are two shared configs: vue which contains all Vue-related rules, and common which includes all other rules.

{
  "plugins": [
    "mediawiki"
  ],
  "extends": [
    "plugin:mediawiki/common"
  ],
  "overrides": [
    {
      "files": [ "**/*.vue" ],
      "extends": [
        "plugin:mediawiki/vue"
      ]
    }
  ]
}

Rules

• mediawiki/class-doc
• mediawiki/msg-doc
• mediawiki/no-extended-unicode-identifiers
• mediawiki/no-nodelist-unsupported-methods
• mediawiki/no-vue-dynamic-i18n
• mediawiki/valid-package-file-require
• mediawiki/vue-exports-component-directive

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.