Skip to content

Commit

Permalink
docs: remove troubleshooting block
Browse files Browse the repository at this point in the history
  • Loading branch information
azat-io committed Jul 21, 2024
1 parent 4df7fb8 commit dfdead4
Showing 1 changed file with 0 additions and 82 deletions.
82 changes: 0 additions & 82 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,88 +179,6 @@ On the whole, yes. We are very careful to make sure that the work of the plugin

I love Prettier. However, this is not his area of responsibility. Prettier is used for formatting, and ESLint is also used for styling. For example, changing the order of imports can affect how the code works (console.log calls, fetch, style loading). Prettier should not change the AST. There is a cool article about this: ["The Blurry Line Between Formatting and Style"](https://blog.joshuakgoldberg.com/the-blurry-line-between-formatting-and-style) by **@joshuakgoldberg**.

## Troubleshooting

There are rules of ESLint and other ESLint plugins that may conflict with the rules of ESLint Plugin Perfectionist. We strongly recommend that you [disable rules](https://eslint.org/docs/latest/use/configure/rules#using-configuration-files-1) with similar functionality.

I recommend that you read the [documentation](https://perfectionist.dev) before using any rules.

<details>
<summary>Possible conflicts</summary>

**perfectionist/sort-imports:**

```json
{
"rules": {
"import/order": "off",
"sort-imports": "off"
}
}
```

**perfectionist/sort-interfaces:**

```json
{
"rules": {
"@typescript-eslint/adjacent-overload-signatures": "off"
}
}
```

**perfectionist/sort-jsx-props:**

```json
{
"rules": {
"react/jsx-sort-props": "off"
}
}
```

**perfectionist/sort-named-imports:**

```json
{
"rules": {
"sort-imports": "off"
}
}
```

**perfectionist/sort-object-types:**

```json
{
"rules": {
"@typescript-eslint/adjacent-overload-signatures": "off"
}
}
```

**perfectionist/sort-objects:**

```json
{
"rules": {
"sort-keys": "off"
}
}
```

**perfectionist/sort-union-types:**

```json
{
"rules": {
"@typescript-eslint/sort-type-constituents": "off"
}
}
```

</details>

## Versioning Policy

This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
Expand Down

0 comments on commit dfdead4

Please sign in to comment.