@graphql-eslint/eslint-plugin 3.0.0-alpha-069461d.0 → 3.0.0-alpha-698204a.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/README.md +19 -8
  2. package/configs/base.d.ts +5 -0
  3. package/configs/index.d.ts +59 -91
  4. package/configs/operations-all.d.ts +19 -0
  5. package/configs/{recommended.d.ts → operations-recommended.d.ts} +11 -30
  6. package/configs/schema-all.d.ts +23 -0
  7. package/configs/schema-recommended.d.ts +44 -0
  8. package/docs/README.md +9 -17
  9. package/docs/deprecated-rules.md +21 -0
  10. package/docs/rules/alphabetize.md +1 -1
  11. package/docs/rules/description-style.md +4 -2
  12. package/docs/rules/executable-definitions.md +2 -2
  13. package/docs/rules/fields-on-correct-type.md +2 -2
  14. package/docs/rules/fragments-on-composite-type.md +2 -2
  15. package/docs/rules/input-name.md +1 -1
  16. package/docs/rules/known-argument-names.md +2 -2
  17. package/docs/rules/known-directives.md +2 -2
  18. package/docs/rules/known-fragment-names.md +2 -2
  19. package/docs/rules/known-type-names.md +2 -2
  20. package/docs/rules/lone-anonymous-operation.md +2 -2
  21. package/docs/rules/lone-schema-definition.md +2 -2
  22. package/docs/rules/match-document-filename.md +6 -4
  23. package/docs/rules/naming-convention.md +26 -27
  24. package/docs/rules/no-anonymous-operations.md +2 -2
  25. package/docs/rules/no-case-insensitive-enum-values-duplicates.md +2 -2
  26. package/docs/rules/no-deprecated.md +3 -1
  27. package/docs/rules/{avoid-duplicate-fields.md → no-duplicate-fields.md} +10 -8
  28. package/docs/rules/no-fragment-cycles.md +2 -2
  29. package/docs/rules/no-hashtag-description.md +3 -1
  30. package/docs/rules/no-root-type.md +7 -1
  31. package/docs/rules/{avoid-scalar-result-type-on-mutation.md → no-scalar-result-type-on-mutation.md} +7 -7
  32. package/docs/rules/no-typename-prefix.md +37 -0
  33. package/docs/rules/no-undefined-variables.md +2 -2
  34. package/docs/rules/no-unreachable-types.md +3 -1
  35. package/docs/rules/no-unused-fields.md +1 -1
  36. package/docs/rules/no-unused-fragments.md +2 -2
  37. package/docs/rules/no-unused-variables.md +2 -2
  38. package/docs/rules/one-field-subscriptions.md +2 -2
  39. package/docs/rules/overlapping-fields-can-be-merged.md +2 -2
  40. package/docs/rules/possible-fragment-spread.md +2 -2
  41. package/docs/rules/possible-type-extension.md +2 -2
  42. package/docs/rules/provided-required-arguments.md +2 -2
  43. package/docs/rules/require-deprecation-date.md +1 -1
  44. package/docs/rules/require-deprecation-reason.md +2 -2
  45. package/docs/rules/require-description.md +36 -7
  46. package/docs/rules/require-field-of-type-query-in-mutation-result.md +1 -1
  47. package/docs/rules/require-id-when-available.md +3 -1
  48. package/docs/rules/scalar-leafs.md +2 -2
  49. package/docs/rules/selection-set-depth.md +9 -2
  50. package/docs/rules/strict-id-in-types.md +16 -10
  51. package/docs/rules/unique-argument-names.md +2 -2
  52. package/docs/rules/unique-directive-names-per-location.md +2 -2
  53. package/docs/rules/unique-directive-names.md +2 -2
  54. package/docs/rules/unique-enum-value-names.md +2 -2
  55. package/docs/rules/unique-field-definition-names.md +2 -2
  56. package/docs/rules/unique-fragment-name.md +1 -1
  57. package/docs/rules/unique-input-field-names.md +2 -2
  58. package/docs/rules/unique-operation-name.md +1 -1
  59. package/docs/rules/unique-operation-types.md +2 -2
  60. package/docs/rules/unique-type-names.md +2 -2
  61. package/docs/rules/unique-variable-names.md +2 -2
  62. package/docs/rules/value-literals-of-correct-type.md +2 -2
  63. package/docs/rules/variables-are-input-types.md +2 -2
  64. package/docs/rules/variables-in-allowed-position.md +2 -2
  65. package/index.js +566 -599
  66. package/index.mjs +567 -600
  67. package/package.json +1 -1
  68. package/rules/alphabetize.d.ts +8 -10
  69. package/rules/description-style.d.ts +4 -6
  70. package/rules/index.d.ts +18 -8
  71. package/rules/input-name.d.ts +1 -1
  72. package/rules/match-document-filename.d.ts +8 -10
  73. package/rules/naming-convention.d.ts +1 -1
  74. package/rules/{avoid-duplicate-fields.d.ts → no-duplicate-fields.d.ts} +0 -0
  75. package/rules/{avoid-scalar-result-type-on-mutation.d.ts → no-scalar-result-type-on-mutation.d.ts} +0 -0
  76. package/rules/{avoid-typename-prefix.d.ts → no-typename-prefix.d.ts} +0 -0
  77. package/rules/require-description.d.ts +10 -6
  78. package/rules/require-id-when-available.d.ts +3 -3
  79. package/rules/selection-set-depth.d.ts +3 -3
  80. package/rules/strict-id-in-types.d.ts +6 -8
  81. package/types.d.ts +9 -5
  82. package/utils.d.ts +1 -1
  83. package/configs/all.d.ts +0 -99
  84. package/docs/rules/avoid-operation-name-prefix.md +0 -50
  85. package/docs/rules/avoid-typename-prefix.md +0 -37
  86. package/docs/rules/no-operation-name-suffix.md +0 -38
  87. package/rules/avoid-operation-name-prefix.d.ts +0 -9
  88. package/rules/no-operation-name-suffix.d.ts +0 -3
package/docs/rules/selection-set-depth.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # `selection-set-depth`
2
2
 
3
- - Category: `Best Practices`
3
+ ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
+
5
+ - Category: `Operations`
4
6
  - Rule name: `@graphql-eslint/selection-set-depth`
5
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
6
8
  - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
@@ -55,12 +57,17 @@ query deep2 {
55
57
 
56
58
  The schema defines the following properties:
57
59
 
58
- ### `maxDepth` (number)
60
+ ### `maxDepth` (number, required)
59
61
 
60
62
  ### `ignore` (array)
61
63
 
62
64
  The object is an array with all elements of the type `string`.
63
65
 
66
+ Additional restrictions:
67
+
68
+ * Minimum items: `1`
69
+ * Unique items: `true`
70
+
64
71
  ## Resources
65
72
 
66
73
  - [Rule source](../../packages/plugin/src/rules/selection-set-depth.ts)
package/docs/rules/strict-id-in-types.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `strict-id-in-types`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Best Practices`
5
+ - Category: `Schema`
6
6
  - Rule name: `@graphql-eslint/strict-id-in-types`
7
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
@@ -76,6 +76,10 @@ Default:
76
76
  ]
77
77
  ```
78
78
 
79
+ Additional restrictions:
80
+
81
+ * Unique items: `true`
82
+
79
83
  ### `acceptedIdTypes` (array)
80
84
 
81
85
  The object is an array with all elements of the type `string`.
@@ -88,6 +92,10 @@ Default:
88
92
  ]
89
93
  ```
90
94
 
95
+ Additional restrictions:
96
+
97
+ * Unique items: `true`
98
+
91
99
  ### `exceptions` (object)
92
100
 
93
101
  Properties of the `exceptions` object:
@@ -98,11 +106,10 @@ This is used to exclude types with names that match one of the specified values.
98
106
 
99
107
  The object is an array with all elements of the type `string`.
100
108
 
101
- Default:
109
+ Additional restrictions:
102
110
 
103
- ```json
104
- []
105
- ```
111
+ * Minimum items: `1`
112
+ * Unique items: `true`
106
113
 
107
114
  #### `suffixes` (array)
108
115
 
@@ -110,11 +117,10 @@ This is used to exclude types with names with suffixes that match one of the spe
110
117
 
111
118
  The object is an array with all elements of the type `string`.
112
119
 
113
- Default:
120
+ Additional restrictions:
114
121
 
115
- ```json
116
- []
117
- ```
122
+ * Minimum items: `1`
123
+ * Unique items: `true`
118
124
 
119
125
  ## Resources
120
126
 
package/docs/rules/unique-argument-names.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-argument-names`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Operations`
6
6
  - Rule name: `@graphql-eslint/unique-argument-names`
7
7
  - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-directive-names-per-location.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-directive-names-per-location`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and `"plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Schema & Operations`
6
6
  - Rule name: `@graphql-eslint/unique-directive-names-per-location`
7
7
  - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-directive-names.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-directive-names`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Schema`
6
6
  - Rule name: `@graphql-eslint/unique-directive-names`
7
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-enum-value-names.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-enum-value-names`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Schema`
6
6
  - Rule name: `@graphql-eslint/unique-enum-value-names`
7
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-field-definition-names.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-field-definition-names`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Schema`
6
6
  - Rule name: `@graphql-eslint/unique-field-definition-names`
7
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-fragment-name.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # `unique-fragment-name`
2
2
 
3
- - Category: `Best Practices`
3
+ - Category: `Operations`
4
4
  - Rule name: `@graphql-eslint/unique-fragment-name`
5
5
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
6
6
  - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-input-field-names.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-input-field-names`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Operations`
6
6
  - Rule name: `@graphql-eslint/unique-input-field-names`
7
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-operation-name.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # `unique-operation-name`
2
2
 
3
- - Category: `Best Practices`
3
+ - Category: `Operations`
4
4
  - Rule name: `@graphql-eslint/unique-operation-name`
5
5
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
6
6
  - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-operation-types.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-operation-types`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Schema`
6
6
  - Rule name: `@graphql-eslint/unique-operation-types`
7
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-type-names.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-type-names`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Schema`
6
6
  - Rule name: `@graphql-eslint/unique-type-names`
7
7
  - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/unique-variable-names.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `unique-variable-names`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Operations`
6
6
  - Rule name: `@graphql-eslint/unique-variable-names`
7
7
  - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/value-literals-of-correct-type.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `value-literals-of-correct-type`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Operations`
6
6
  - Rule name: `@graphql-eslint/value-literals-of-correct-type`
7
7
  - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/variables-are-input-types.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `variables-are-input-types`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Operations`
6
6
  - Rule name: `@graphql-eslint/variables-are-input-types`
7
7
  - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
package/docs/rules/variables-in-allowed-position.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # `variables-in-allowed-position`
2
2
 
3
- ✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
3
+ ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
4
 
5
- - Category: `Validation`
5
+ - Category: `Operations`
6
6
  - Rule name: `@graphql-eslint/variables-in-allowed-position`
7
7
  - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
8
  - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)