docs: add more badges, remove unexpected escaped line breaks

JounQin · JounQin · commit b780f638c96a · 2022-08-12T20:25:28.000+08:00
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Introduction
 
-`eslint-plugin-svelte` is [ESLint] plugin for [Svelte].\
-It provides many unique check rules by using the template AST.\
+`eslint-plugin-svelte` is [ESLint] plugin for [Svelte].
+It provides many unique check rules by using the template AST.
 You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-svelte/playground/).
 
 [![NPM license](https://img.shields.io/npm/l/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
@@ -13,9 +13,15 @@ You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-sve
 [![NPM downloads](https://img.shields.io/npm/dt/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![Build Status](https://github.com/ota-meshi/eslint-plugin-svelte/workflows/CI/badge.svg?branch=main)](https://github.com/ota-meshi/eslint-plugin-svelte/actions?query=workflow%3ACI)
 
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ota-meshi/eslint-plugin-svelte.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ota-meshi/eslint-plugin-svelte/context:javascript)
+[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fota-meshi%2Feslint-plugin-svelte%2Fmain%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
+[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/atlassian/changesets)
+
 ## :name_badge: What is this plugin?
 
-[ESLint] plugin for [Svelte].\
+[ESLint] plugin for [Svelte].
 It provides many unique check rules using the AST generated by [svelte-eslint-parser].
 
 ### ❓ Why?
@@ -183,7 +189,7 @@ See also <https://github.com/ota-meshi/svelte-eslint-parser#readme>.
 
 You can change the behavior of this plugin with some settings.
 
-- `ignoreWarnings` (optional) ... Specifies an array of rules that ignore reports in the template.\
+- `ignoreWarnings` (optional) ... Specifies an array of rules that ignore reports in the template.
   For example, set rules on the template that cannot avoid false positives.
 - `compileOptions` (optional) ... Specifies options for Svelte compile. Effects rules that use Svelte compile. The target rules are [svelte/valid-compile](https://ota-meshi.github.io/eslint-plugin-svelte/rules/valid-compile/) and [svelte/no-unused-svelte-ignore](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-unused-svelte-ignore/). **Note that it has no effect on ESLint's custom parser**.
   - `postcss` (optional) ... Specifies options related to PostCSS. You can disable the PostCSS process by specifying `false`.
@@ -246,8 +252,8 @@ Example **.vscode/settings.json**:
 
 <!--RULES_SECTION_START-->
 
-:wrench: Indicates that the rule is fixable, and using `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the reported problems.\
-:bulb: Indicates that some problems reported by the rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
+:wrench: Indicates that the rule is fixable, and using `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the reported problems.
+:bulb: Indicates that some problems reported by the rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 :star: Indicates that the rule is included in the `plugin:svelte/recommended` config.
 
 <!--RULES_TABLE_START-->
@@ -352,14 +358,14 @@ Please use GitHub's Issues/PRs.
 
 ### Test the Rule
 
-Rule testing almost always uses fixtures.\
-For example, for an `indent` rule, the `.ts` file that runs the test is `tests/src/rules/indent.ts` and the fixture is in `tests/fixtures/rules/indent`.\
+Rule testing almost always uses fixtures.
+For example, for an `indent` rule, the `.ts` file that runs the test is `tests/src/rules/indent.ts` and the fixture is in `tests/fixtures/rules/indent`.
 The fixture directory has an `invalid` directory and a `valid` directory.
 
 - The `invalid` directory contains test cases where the rule reports problems.
 - The `valid` directory contains test cases where the rule does not report a problem.
 
-The fixture input file should be named `*-input.svelte`. It is automatically collected and tested.\
+The fixture input file should be named `*-input.svelte`. It is automatically collected and tested.
 If your test requires configuration, you need to add a json file with the configuration.
 
 - If you want to apply a configuration to `my-test-input.svelte`, add `my-test-config.json`.
@@ -377,7 +383,7 @@ yarn test -g indent
 
 Take <https://stackoverflow.com/questions/10832031/how-to-run-a-single-test-with-mocha> as reference for details.
 
-If you want to test only `my-test-input.svelte`, add `my-test-config.json` and save `{"only": true}`.\
+If you want to test only `my-test-input.svelte`, add `my-test-config.json` and save `{"only": true}`.
 (Note that `{"only": true}` must be removed before making a pull request.)
 
 ### Working With Rules
diff --git a/docs/README.md b/docs/README.md
@@ -4,22 +4,22 @@ title: "eslint-plugin-svelte"
 
 # Introduction
 
-`eslint-plugin-svelte` is [ESLint] plugin for [Svelte].\
-It provides many unique check rules by using the template AST.\
+`eslint-plugin-svelte` is [ESLint] plugin for [Svelte].
+It provides many unique check rules by using the template AST.
 You can check on the [Online DEMO](./playground.md).
 
 [![NPM license](https://img.shields.io/npm/l/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
 [![NPM version](https://img.shields.io/npm/v/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
-[![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads\&colorB=green\&suffix=/day\&query=$.downloads\&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-svelte\&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-svelte)
+[![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads&colorB=green&suffix=/day&query=$.downloads&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-svelte&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![NPM downloads](https://img.shields.io/npm/dw/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![NPM downloads](https://img.shields.io/npm/dm/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![NPM downloads](https://img.shields.io/npm/dy/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![NPM downloads](https://img.shields.io/npm/dt/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![Build Status](https://github.com/ota-meshi/eslint-plugin-svelte/workflows/CI/badge.svg?branch=main)](https://github.com/ota-meshi/eslint-plugin-svelte/actions?query=workflow%3ACI)
 
-## :name\_badge: What is this plugin?
+## :name_badge: What is this plugin?
 
-[ESLint] plugin for [Svelte].\
+[ESLint] plugin for [Svelte].
 It provides many unique check rules using the AST generated by [svelte-eslint-parser].
 
 ### ❓ Why?
@@ -39,7 +39,7 @@ The [svelte-eslint-parser] and the `eslint-plugin-svelte` can not be used with t
 
 See [User Guide](./user-guide.md).
 
-## :white\_check\_mark: Rules
+## :white_check_mark: Rules
 
 See [Available Rules](./rules.md).
 
diff --git a/docs/migration.md b/docs/migration.md
@@ -10,19 +10,19 @@ If you want the previous behavior, replace it with [eslint-plugin-svelte3].
 
 ## From `@ota-meshi/eslint-plugin-svelte`
 
-`@ota-meshi/eslint-plugin-svelte` has been renamed to `eslint-plugin-svelte`.\
+`@ota-meshi/eslint-plugin-svelte` has been renamed to `eslint-plugin-svelte`.
 Therefore, you need to replace the package name, and the presets, rules, and settings specified in the configuration.
 
-- `package.json`\
+- `package.json`
   Replace the package name.
 
   ```diff
   -  "@ota-meshi/eslint-plugin-svelte": "^0.X.X"
   +  "eslint-plugin-svelte": "^X.X.X"
   ```
 
-- `.eslintrc.*`\
-  Replace `@ota-meshi/svelte` with `svelte` as a string.\
+- `.eslintrc.*`
+  Replace `@ota-meshi/svelte` with `svelte` as a string.
   Examples:
 
   - Presets
diff --git a/docs/rules/no-extra-reactive-curlies.md b/docs/rules/no-extra-reactive-curlies.md
@@ -42,7 +42,7 @@ Nothing.
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].\
+This rule was taken from [@tivac/eslint-plugin-svelte].
 This rule is compatible with `@tivac/svelte/reactive-curlies` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/
diff --git a/docs/rules/no-inner-declarations.md b/docs/rules/no-inner-declarations.md
@@ -16,7 +16,7 @@ since: "v0.0.8"
 
 This rule requires that function declarations and, optionally, variable declarations be in the root of a program or the body of a function.
 
-This rule extends the base ESLint's [no-inner-declarations] rule. The AST generated by [svelte-eslint-parser] will false positives in [no-inner-declarations] rule because the root node of the script is not the `Program`.\
+This rule extends the base ESLint's [no-inner-declarations] rule. The AST generated by [svelte-eslint-parser] will false positives in [no-inner-declarations] rule because the root node of the script is not the `Program`.
 This rule supports [svelte-eslint-parser]'s AST.
 
 [svelte-eslint-parser]: https://github.com/ota-meshi/svelte-eslint-parser
diff --git a/docs/rules/no-not-function-handler.md b/docs/rules/no-not-function-handler.md
@@ -14,7 +14,7 @@ since: "v0.5.0"
 
 ## :book: Rule Details
 
-This rule reports where you used not function value in event handlers.\
+This rule reports where you used not function value in event handlers.
 If you use a non-function value for the event handler, it event handler will not be called. It's almost always a mistake. You may have written a lot of unnecessary curly braces.
 
 <ESLintCodeBlock>
diff --git a/docs/rules/no-object-in-text-mustaches.md b/docs/rules/no-object-in-text-mustaches.md
@@ -14,7 +14,7 @@ since: "v0.5.0"
 
 ## :book: Rule Details
 
-This rule disallows the use of objects in text mustache interpolation.\
+This rule disallows the use of objects in text mustache interpolation.
 When you use an object for text interpolation, it is drawn as `[object Object]`. It's almost always a mistake. You may have written a lot of unnecessary curly braces.
 
 <ESLintCodeBlock>
diff --git a/docs/rules/no-reactive-functions.md b/docs/rules/no-reactive-functions.md
@@ -25,12 +25,20 @@ This rule reports whenever a function is defined in a reactive statement. This i
   /* eslint svelte/no-reactive-functions: "error" */
 
   /* ✓ GOOD */
-  const arrowFn = () => { /* ... */ }
-  const func = function() { /* ... */ }
-  
+  const arrowFn = () => {
+    /* ... */
+  }
+  const func = function () {
+    /* ... */
+  }
+
   /* ✗ BAD */
-  $: arrowFn = () => { /* ... */ }
-  $: func = function() { /* ... */ }
+  $: arrowFn = () => {
+    /* ... */
+  }
+  $: func = function () {
+    /* ... */
+  }
 </script>
 ```
 
@@ -42,7 +50,7 @@ Nothing
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].\
+This rule was taken from [@tivac/eslint-plugin-svelte].
 This rule is compatible with `@tivac/svelte/reactive-functions` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/
diff --git a/docs/rules/no-reactive-literals.md b/docs/rules/no-reactive-literals.md
@@ -39,7 +39,7 @@ Nothing.
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].\
+This rule was taken from [@tivac/eslint-plugin-svelte].
 This rule is compatible with `@tivac/svelte/reactive-literals` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/
diff --git a/docs/rules/require-stores-init.md b/docs/rules/require-stores-init.md
@@ -42,7 +42,7 @@ Nothing.
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].\
+This rule was taken from [@tivac/eslint-plugin-svelte].
 This rule is compatible with `@tivac/svelte/stores-initial-value` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/
diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -140,7 +140,7 @@ See also <https://github.com/ota-meshi/svelte-eslint-parser#readme>.
 
 You can change the behavior of this plugin with some settings.
 
-- `ignoreWarnings` (optional) ... Specifies an array of rules that ignore reports in the template.\
+- `ignoreWarnings` (optional) ... Specifies an array of rules that ignore reports in the template.
   For example, set rules on the template that cannot avoid false positives.
 - `compileOptions` (optional) ... Specifies options for Svelte compile. Effects rules that use Svelte compile. The target rules are [svelte/valid-compile](./rules/valid-compile.md) and [svelte/no-unused-svelte-ignore](./rules/no-unused-svelte-ignore.md). **Note that it has no effect on ESLint's custom parser**.
   - `postcss` (optional) ... Specifies options related to PostCSS. You can disable the PostCSS process by specifying `false`.
