Skip to content

Commit

Permalink
Update docs for latest plugin versions, convert new tseslint related-…
Browse files Browse the repository at this point in the history
…getter-setter-pairs rule to warning
  • Loading branch information
matejchalk committed Jan 17, 2025
1 parent 5b7e66e commit f92a1e6
Show file tree
Hide file tree
Showing 12 changed files with 559 additions and 976 deletions.
4 changes: 2 additions & 2 deletions docs/angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ Config for **Angular** projects.

4. Refer to [step 3 in TypeScript config's setup docs](./typescript.md#🏗️-setup) for how to set up tsconfig properly.

## 📏 Rules (425)
## 📏 Rules (439)

**345** rules are included from [`typescript` config](./typescript.md#📏-rules-345). For brevity, only the **80** additional rules are listed in this document.
**359** rules are included from [`typescript` config](./typescript.md#📏-rules-359). For brevity, only the **80** additional rules are listed in this document.

> 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).<br>💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).<br>🧪🚫 Disabled for [test files](../README.md#🧪-test-overrides).<br>🧪⚠️ Severity lessened to warning for [test files](../README.md#🧪-test-overrides).
Expand Down
4 changes: 2 additions & 2 deletions docs/graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ Config for **GraphQL servers** implemented in Node.js.
);
```

## 📏 Rules (317)
## 📏 Rules (329)

**294** rules are included from [`node` config](./node.md#📏-rules-294). For brevity, only the **23** additional rules are listed in this document.
**306** rules are included from [`node` config](./node.md#📏-rules-306). For brevity, only the **23** additional rules are listed in this document.

> 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).<br>💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).<br>🧪🚫 Disabled for [test files](../README.md#🧪-test-overrides).<br>🧪⚠️ Severity lessened to warning for [test files](../README.md#🧪-test-overrides).

Expand Down
234 changes: 123 additions & 111 deletions docs/javascript.md

Large diffs are not rendered by default.

94 changes: 47 additions & 47 deletions docs/jest.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/ngrx.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ Config for **Angular** projects using **NgRx** library.

4. Refer to [step 3 in TypeScript config's setup docs](./typescript.md#🏗️-setup) for how to set up tsconfig properly.

## 📏 Rules (455)
## 📏 Rules (469)

**425** rules are included from [`angular` config](./angular.md#📏-rules-425). For brevity, only the **30** additional rules are listed in this document.
**439** rules are included from [`angular` config](./angular.md#📏-rules-439). For brevity, only the **30** additional rules are listed in this document.

> 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).<br>💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).<br>🧪🚫 Disabled for [test files](../README.md#🧪-test-overrides).<br>🧪⚠️ Severity lessened to warning for [test files](../README.md#🧪-test-overrides).
Expand Down
4 changes: 2 additions & 2 deletions docs/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ Config for **Node.js** projects.
For more information, refer to [`eslint-plugin-n` docs](https://github.com/eslint-community/eslint-plugin-n?tab=readme-ov-file#configured-nodejs-version-range).
## 📏 Rules (294)
## 📏 Rules (306)
**290** rules are included from [`javascript` config](./javascript.md#📏-rules-290). For brevity, only the **4** additional rules are listed in this document.
**302** rules are included from [`javascript` config](./javascript.md#📏-rules-302). For brevity, only the **4** additional rules are listed in this document.
> 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).<br>💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).<br>🧪🚫 Disabled for [test files](../README.md#🧪-test-overrides).<br>🧪⚠️ Severity lessened to warning for [test files](../README.md#🧪-test-overrides).
Expand Down
4 changes: 2 additions & 2 deletions docs/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Config for **React** projects.
export default tseslint.config(...react);
```

## 📏 Rules (391)
## 📏 Rules (403)

**290** rules are included from [`javascript` config](./javascript.md#📏-rules-290). For brevity, only the **101** additional rules are listed in this document.
**302** rules are included from [`javascript` config](./javascript.md#📏-rules-302). For brevity, only the **101** additional rules are listed in this document.

> 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).<br>💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).<br>🧪🚫 Disabled for [test files](../README.md#🧪-test-overrides).<br>🧪⚠️ Severity lessened to warning for [test files](../README.md#🧪-test-overrides).
Expand Down
2 changes: 1 addition & 1 deletion docs/storybook.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Config for projects using **Storybook** for UI components.
| [![storybook](./icons/material/storybook.png)](https://github.com/storybookjs/eslint-plugin-storybook#readme) | [default-exports](https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/default-exports.md)<br />Story files should have a default export | | 🔧, 💡 | |
| [![storybook](./icons/material/storybook.png)](https://github.com/storybookjs/eslint-plugin-storybook#readme) | [no-uninstalled-addons](https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-uninstalled-addons.md)<br />This rule identifies storybook addons that are invalid because they are either not installed or contain a typo in their name. | | | |
| [![storybook](./icons/material/storybook.png)](https://github.com/storybookjs/eslint-plugin-storybook#readme) | [story-exports](https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/story-exports.md)<br />A story file must contain at least one story export | | | |
| [![storybook](./icons/material/storybook.png)](https://github.com/storybookjs/eslint-plugin-storybook#readme) | [use-storybook-expect](https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/use-storybook-expect.md)<br />Use expect from `@storybook/test` or `@storybook/jest` | | 🔧, 💡 | |
| [![storybook](./icons/material/storybook.png)](https://github.com/storybookjs/eslint-plugin-storybook#readme) | [use-storybook-expect](https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/use-storybook-expect.md)<br />Use expect from `@storybook/test` or `@storybook/jest` | | 🔧 | |
| [![storybook](./icons/material/storybook.png)](https://github.com/storybookjs/eslint-plugin-storybook#readme) | [use-storybook-testing-library](https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/use-storybook-testing-library.md)<br />Do not use testing-library directly on stories | | 🔧, 💡 | |

### ⚠️ Warnings (4)
Expand Down
Loading

0 comments on commit f92a1e6

Please sign in to comment.