From 42b6fc81339ee301298a3505c88feaafb59d352c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=94=AF=E7=84=B6?= Date: Tue, 12 Oct 2021 16:35:52 +0800 Subject: [PATCH 1/2] Docs: add toc in readme --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e5865c98..43f5698b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,19 @@ An ESLint plugin for linting ESLint plugins. Rules written in CJS, ESM, and TypeScript are all supported. -## Installation + +* [Installation](#Installation) +* [Usage](#Usage) +* [Supported Rules](#SupportedRules) +* [Supported Presets](#SupportedPresets) + + + + +## Installation You'll first need to install [ESLint](https://eslint.org): @@ -16,7 +28,7 @@ Next, install `eslint-plugin-eslint-plugin`: npm install eslint-plugin-eslint-plugin --save-dev ``` -## Usage +## Usage Add `eslint-plugin` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix: @@ -38,7 +50,7 @@ Then configure the rules you want to use under the rules section. } ``` -## Supported Rules +## Supported Rules * ✔️ if the rule belongs to the `recommended` configuration * 🛠 if some problems reported by the rule are automatically fixable by the `--fix` [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option @@ -73,7 +85,7 @@ Name | ✔️ | 🛠 | 💡 | Description [test-case-shorthand-strings](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-shorthand-strings.md) | | 🛠 | | enforce consistent usage of shorthand strings for test cases with no options -## Supported Presets +## Supported Presets | | Name | Description | |:--|:-----|:------------| From 1f6a12a241e60fc4ac7dbd3d67a8f7dd222dc315 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=94=AF=E7=84=B6?= Date: Tue, 12 Oct 2021 16:41:07 +0800 Subject: [PATCH 2/2] chore: disable no-inline-html --- .markdownlint.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.markdownlint.json b/.markdownlint.json index aec8fd53..299afd7c 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,3 +1,4 @@ { - "line-length": false + "line-length": false, + "no-inline-html": false }