@gitlab/eslint-plugin

@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

Requirements

• ESLint, configured with flat config (eslint.config.js)
• Node.js

Every config this package exports is a flat config array:

const gitlab = require('@gitlab/eslint-plugin');

module.exports = [...gitlab.configs.default];

The eslintrc configs (extends: ['plugin:@gitlab/default']) were removed in this major release. See Installation and Usage for the migration.

Using the typescript config additionally requires @typescript-eslint/parser, @typescript-eslint/eslint-plugin and typescript in your own project. They are optional peer dependencies, so your project controls their versions — the overrides workaround this README used to document is no longer needed.

Contribution guidelines

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