@gitlab/eslint-plugin

> This package contains eslint rules developed for GitLab and shared eslint config to be used in all
> javascript projects across GitLab.

It encapsulates our coding standards and is based primarily upon
eslint-config-airbnb-base
and eslint-plugin-vue with the expectation that code
formatting is handled separately by prettier.

Generally we should use upstream rules that are defined in eslint or eslint-plugin-vue. If one
of these packages lacks a rule, we can create it here in order to enforce it, and try to get it
upstream later.

Documentation

- Available rules
- Installation and Usage
- Creation & Development of rules

Eslint 9 migration

The TS portion of this plugin has been migrated to eslint v9 and can be used as const gitlabPlugin = require('@gitlab/eslint-plugin/eslint9');. You still add the @gitlab/eslint-plugin as a dependency.

Add these overrides to your project's package.json:

``json
"overrides": {
"@gitlab/eslint-plugin": {
"@typescript-eslint/eslint-plugin": "^8.38.0",
"@typescript-eslint/parser": "^8.38.0"
}
}
``

(replace the versions with what your main project uses)

Contribution guidelines

Please refer to
gitlab's CONTRIBUTING.md for
details on our guidelines.