docs: improve plugin usage examples

azat-io · Jun 4, 2023 · a10370c · a10370c
1 parent f0993e3
commit a10370c
Show file tree

Hide file tree

Showing 13 changed files with 15 additions and 5 deletions.
diff --git a/docs/rules/sort-array-includes.md b/docs/rules/sort-array-includes.md
@@ -114,6 +114,7 @@ When `true` enforce spread elements in array to be last.
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-array-includes": [
       "error",

diff --git a/docs/rules/sort-classes.md b/docs/rules/sort-classes.md
@@ -181,6 +181,7 @@ If you use [one of the configs](/configs/) exported by this plugin, you get the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-classes": [
       "error",

diff --git a/docs/rules/sort-enums.md b/docs/rules/sort-enums.md
@@ -101,6 +101,7 @@ Only affects alphabetical and natural sorting. When `true` the rule ignores the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-enums": [
       "error",

diff --git a/docs/rules/sort-imports.md b/docs/rules/sort-imports.md
@@ -267,6 +267,7 @@ If your project is written in TypeScript, you can read `tsconfig.json` and use `
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-imports": [
       "error",

diff --git a/docs/rules/sort-interfaces.md b/docs/rules/sort-interfaces.md
@@ -118,6 +118,7 @@ The [minimatch](https://github.com/isaacs/minimatch) library is used for pattern
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-interfaces": [
       "error",

diff --git a/docs/rules/sort-jsx-props.md b/docs/rules/sort-jsx-props.md
@@ -151,6 +151,7 @@ You can set a list of property names that will always go at the beginning of the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-jsx-props": [
       "error",

diff --git a/docs/rules/sort-map-elements.md b/docs/rules/sort-map-elements.md
@@ -105,6 +105,7 @@ Only affects alphabetical and natural sorting. When `true` the rule ignores the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-map-elements": [
       "error",

diff --git a/docs/rules/sort-named-exports.md b/docs/rules/sort-named-exports.md
@@ -105,6 +105,7 @@ Only affects alphabetical and natural sorting. When `true` the rule ignores the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-named-exports": [
       "error",

diff --git a/docs/rules/sort-named-imports.md b/docs/rules/sort-named-imports.md
@@ -109,6 +109,7 @@ Only affects alphabetical and natural sorting. When `true` the rule ignores the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-named-imports": [
       "error",

diff --git a/docs/rules/sort-object-types.md b/docs/rules/sort-object-types.md
@@ -101,6 +101,7 @@ Only affects alphabetical and natural sorting. When `true` the rule ignores the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-object-types": [
       "error",

diff --git a/docs/rules/sort-objects.md b/docs/rules/sort-objects.md
@@ -110,6 +110,7 @@ You can set a list of key names that will always go at the beginning of the obje
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-objects": [
       "error",

diff --git a/docs/rules/sort-union-types.md b/docs/rules/sort-union-types.md
@@ -105,6 +105,7 @@ Only affects alphabetical and natural sorting. When `true` the rule ignores the
 ```json
 // .eslintrc
 {
+  "plugins": ["perfectionist"],
   "rules": {
     "perfectionist/sort-union-types": [
       "error",

diff --git a/readme.md b/readme.md
@@ -55,12 +55,11 @@ Add `eslint-plugin-perfectionist` to the plugins section of the ESLint configura
 {
   "plugins": ["perfectionist"],
   "rules": {
-    "perfectionist/sort-array-includes": [
+    "perfectionist/sort-objects": [
       "error",
       {
         "type": "line-length",
-        "order": "desc",
-        "spread-last": true
+        "order": "desc"
       }
     ]
   }
@@ -78,12 +77,11 @@ export default [
       perfectionist,
     },
     rules: {
-      'perfectionist/sort-array-includes': [
+      'perfectionist/sort-objects': [
         'error',
         {
           type: 'line-length',
           order: 'desc',
-          'spread-last': true,
         },
       ],
     },