From cdce639b9564ac064cc6bd4fc598148149c5cc47 Mon Sep 17 00:00:00 2001 From: Martin Hochel Date: Thu, 17 Mar 2022 15:16:23 +0100 Subject: [PATCH] docs(eslint-plugin): update docs --- packages/eslint-plugin/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 4feecd7fe5264..71aac12a6f9d5 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -6,11 +6,12 @@ Usage: in your [ESLint config file](https://eslint.org/docs/user-guide/configuring), add `{ "extends": ["plugin:@fluentui/"] }` or `{ "extends": ["plugin:@fluentui/eslint-plugin/"] }` (the two are equivalent). -- `react`: For `@fluentui/react` and related packages - - `react--legacy`: Like `react` but requiring an `I` prefix for interfaces - - `node`: Like `react` but for packages which run in a Node environment (not the browser) - - `node--legacy`: Like `node` but requiring an `I` prefix for interfaces +- `react`: react specific configuration for fluentui vNext +- `node`: node specific configuration for fluentui vNext +- `react--legacy`: react specific configuration for fluentui v7,8 +- `node--legacy`: node specific configuration for fluentui v7,8 - `react-northstar`: For `@fluentui/react-northstar` and related packages +- `imports`: auto import statements sorting configuration Helpers for customizing configuration are exported under a `configHelpers` object.