elastic / elastic/eui

[ESLint] Move internal rules to eslint plugin

Open
#9,244 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
6.4k
Forks
911
Avg merge
2d 11h
Merged PRs (30d)
65

Description

The purpose of this issue is to move our internally defined ESLint rules to our ESLint plugin. The goal is for consumers to be able to reuse useful warnings, e.g. `css_logical_properties`.

These rules are defined in: `packages/eui/scripts/eslint-plugin`

## Acceptance criteria

- all internally defined rules are moved to `packages/eslint-plugin`:
- `packages/eui/scripts/eslint-plugin/css_logical_properties.js` (in recommended)
- `packages/eui/scripts/eslint-plugin/forward_ref_display_name.js`
- `packages/eui/scripts/eslint-plugin/i18n.js`
- `packages/eui/scripts/eslint-plugin/rel.js` (in recommended)
- `packages/eui/scripts/eslint-plugin/require_cypress_references.js`
- `packages/eui/scripts/eslint-plugin/require_license_header.js`
- only define rules in recommended if they make sense to be reused by consumers,
- rules like `i18n` and `rel` are renamed for clarity, the name should suggest the rule,
- if needed, rules are broken down into smaller ones,
- changes are tested in Kibana.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.