@graphql-eslint/eslint-plugin 4.0.0-alpha-20220821140530-e968cfc → 4.0.0-alpha-20230810155929-e89edf7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (346) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +14 -252
  3. package/cjs/cache.d.ts +12 -0
  4. package/cjs/cache.js +53 -0
  5. package/cjs/configs/index.d.ts +174 -0
  6. package/cjs/configs/index.js +40 -0
  7. package/cjs/configs/operations-all.d.ts +23 -0
  8. package/cjs/configs/operations-all.js +28 -0
  9. package/cjs/configs/operations-recommended.d.ts +54 -0
  10. package/{configs/operations-recommended.json → cjs/configs/operations-recommended.js} +19 -15
  11. package/cjs/configs/schema-all.d.ts +24 -0
  12. package/cjs/configs/schema-all.js +24 -0
  13. package/cjs/configs/schema-recommended.d.ts +67 -0
  14. package/cjs/configs/schema-recommended.js +68 -0
  15. package/cjs/configs/schema-relay.d.ts +12 -0
  16. package/{configs/relay.json → cjs/configs/schema-relay.js} +6 -4
  17. package/cjs/documents.d.ts +6 -0
  18. package/cjs/documents.js +66 -0
  19. package/cjs/estree-converter/converter.d.ts +8 -0
  20. package/cjs/estree-converter/converter.js +70 -0
  21. package/cjs/estree-converter/index.d.ts +8 -0
  22. package/cjs/estree-converter/index.js +23 -0
  23. package/cjs/estree-converter/types.d.ts +42 -0
  24. package/cjs/estree-converter/types.js +14 -0
  25. package/cjs/estree-converter/utils.d.ts +17 -0
  26. package/cjs/estree-converter/utils.js +105 -0
  27. package/cjs/flat-configs.d.ts +307 -0
  28. package/cjs/flat-configs.js +55 -0
  29. package/cjs/graphql-config.d.ts +14 -0
  30. package/cjs/graphql-config.js +65 -0
  31. package/cjs/index.d.ts +28 -0
  32. package/cjs/index.js +41 -0
  33. package/cjs/parser.d.ts +13 -0
  34. package/cjs/parser.js +96 -0
  35. package/cjs/processor.d.ts +13 -0
  36. package/cjs/processor.js +95 -0
  37. package/cjs/rules/alphabetize.d.ts +74 -0
  38. package/cjs/rules/alphabetize.js +323 -0
  39. package/cjs/rules/description-style.d.ts +29 -0
  40. package/cjs/rules/description-style.js +102 -0
  41. package/cjs/rules/graphql-js-validation.d.ts +13 -0
  42. package/cjs/rules/graphql-js-validation.js +595 -0
  43. package/cjs/rules/index.d.ts +127 -0
  44. package/cjs/rules/index.js +62 -0
  45. package/cjs/rules/input-name.d.ts +44 -0
  46. package/cjs/rules/input-name.js +154 -0
  47. package/cjs/rules/lone-executable-definition.d.ts +35 -0
  48. package/cjs/rules/lone-executable-definition.js +105 -0
  49. package/cjs/rules/match-document-filename.d.ts +81 -0
  50. package/cjs/rules/match-document-filename.js +251 -0
  51. package/cjs/rules/naming-convention.d.ts +108 -0
  52. package/cjs/rules/naming-convention.js +416 -0
  53. package/cjs/rules/no-anonymous-operations.d.ts +13 -0
  54. package/cjs/rules/no-anonymous-operations.js +91 -0
  55. package/cjs/rules/no-deprecated.d.ts +13 -0
  56. package/cjs/rules/no-deprecated.js +143 -0
  57. package/cjs/rules/no-duplicate-fields.d.ts +13 -0
  58. package/cjs/rules/no-duplicate-fields.js +136 -0
  59. package/cjs/rules/no-hashtag-description.d.ts +14 -0
  60. package/cjs/rules/no-hashtag-description.js +127 -0
  61. package/cjs/rules/no-one-place-fragments.d.ts +13 -0
  62. package/cjs/rules/no-one-place-fragments.js +101 -0
  63. package/cjs/rules/no-root-type.d.ts +34 -0
  64. package/cjs/rules/no-root-type.js +103 -0
  65. package/cjs/rules/no-scalar-result-type-on-mutation.d.ts +13 -0
  66. package/cjs/rules/no-scalar-result-type-on-mutation.js +88 -0
  67. package/cjs/rules/no-typename-prefix.d.ts +13 -0
  68. package/cjs/rules/no-typename-prefix.js +91 -0
  69. package/cjs/rules/no-unreachable-types.d.ts +13 -0
  70. package/cjs/rules/no-unreachable-types.js +177 -0
  71. package/cjs/rules/no-unused-fields.d.ts +13 -0
  72. package/cjs/rules/no-unused-fields.js +132 -0
  73. package/cjs/rules/relay-arguments.d.ts +30 -0
  74. package/cjs/rules/relay-arguments.js +126 -0
  75. package/cjs/rules/relay-connection-types.d.ts +14 -0
  76. package/cjs/rules/relay-connection-types.js +111 -0
  77. package/cjs/rules/relay-edge-types.d.ts +40 -0
  78. package/cjs/rules/relay-edge-types.js +161 -0
  79. package/cjs/rules/relay-page-info.d.ts +13 -0
  80. package/cjs/rules/relay-page-info.js +98 -0
  81. package/cjs/rules/require-deprecation-date.d.ts +27 -0
  82. package/cjs/rules/require-deprecation-date.js +148 -0
  83. package/cjs/rules/require-deprecation-reason.d.ts +13 -0
  84. package/cjs/rules/require-deprecation-reason.js +85 -0
  85. package/cjs/rules/require-description.d.ts +24 -0
  86. package/cjs/rules/require-description.js +179 -0
  87. package/cjs/rules/require-field-of-type-query-in-mutation-result.d.ts +13 -0
  88. package/cjs/rules/require-field-of-type-query-in-mutation-result.js +87 -0
  89. package/cjs/rules/require-import-fragment.d.ts +13 -0
  90. package/cjs/rules/require-import-fragment.js +148 -0
  91. package/cjs/rules/require-nullable-fields-with-oneof.d.ts +13 -0
  92. package/cjs/rules/require-nullable-fields-with-oneof.js +81 -0
  93. package/cjs/rules/require-nullable-result-in-root.d.ts +13 -0
  94. package/cjs/rules/require-nullable-result-in-root.js +99 -0
  95. package/cjs/rules/require-selections.d.ts +45 -0
  96. package/cjs/rules/require-selections.js +198 -0
  97. package/cjs/rules/require-type-pattern-with-oneof.d.ts +13 -0
  98. package/cjs/rules/require-type-pattern-with-oneof.js +83 -0
  99. package/cjs/rules/selection-set-depth.d.ts +37 -0
  100. package/cjs/rules/selection-set-depth.js +159 -0
  101. package/cjs/rules/strict-id-in-types.d.ts +66 -0
  102. package/cjs/rules/strict-id-in-types.js +168 -0
  103. package/cjs/rules/unique-enum-value-names.d.ts +13 -0
  104. package/cjs/rules/unique-enum-value-names.js +91 -0
  105. package/cjs/rules/unique-fragment-name.d.ts +14 -0
  106. package/cjs/rules/unique-fragment-name.js +106 -0
  107. package/cjs/rules/unique-operation-name.d.ts +13 -0
  108. package/cjs/rules/unique-operation-name.js +93 -0
  109. package/cjs/schema.d.ts +13 -0
  110. package/cjs/schema.js +52 -0
  111. package/{sibling-operations.d.ts → cjs/siblings.d.ts} +9 -6
  112. package/cjs/siblings.js +96 -0
  113. package/cjs/types.d.ts +75 -0
  114. package/cjs/types.js +14 -0
  115. package/cjs/utils.d.ts +45 -0
  116. package/cjs/utils.js +188 -0
  117. package/esm/cache.d.mts +12 -0
  118. package/esm/cache.js +25 -0
  119. package/esm/chunk-U3TKCM4X.js +8 -0
  120. package/esm/configs/index.d.mts +174 -0
  121. package/esm/configs/index.js +16 -0
  122. package/esm/configs/operations-all.d.mts +23 -0
  123. package/esm/configs/operations-all.js +35 -0
  124. package/esm/configs/operations-recommended.d.mts +54 -0
  125. package/esm/configs/operations-recommended.js +61 -0
  126. package/esm/configs/schema-all.d.mts +24 -0
  127. package/esm/configs/schema-all.js +31 -0
  128. package/esm/configs/schema-recommended.d.mts +67 -0
  129. package/esm/configs/schema-recommended.js +75 -0
  130. package/esm/configs/schema-relay.d.mts +12 -0
  131. package/esm/configs/schema-relay.js +18 -0
  132. package/esm/documents.d.mts +6 -0
  133. package/esm/documents.js +41 -0
  134. package/esm/estree-converter/converter.d.mts +8 -0
  135. package/esm/estree-converter/converter.js +56 -0
  136. package/esm/estree-converter/index.d.mts +8 -0
  137. package/esm/estree-converter/index.js +3 -0
  138. package/esm/estree-converter/types.d.mts +42 -0
  139. package/esm/estree-converter/types.js +0 -0
  140. package/esm/estree-converter/utils.d.mts +17 -0
  141. package/esm/estree-converter/utils.js +87 -0
  142. package/esm/flat-configs.d.mts +307 -0
  143. package/esm/flat-configs.js +36 -0
  144. package/esm/graphql-config.d.mts +14 -0
  145. package/esm/graphql-config.js +39 -0
  146. package/esm/index.d.mts +28 -0
  147. package/esm/index.js +18 -0
  148. package/esm/package.json +1 -0
  149. package/esm/parser.d.mts +13 -0
  150. package/esm/parser.js +76 -0
  151. package/esm/processor.d.mts +13 -0
  152. package/esm/processor.js +81 -0
  153. package/esm/rules/alphabetize.d.mts +74 -0
  154. package/esm/rules/alphabetize.js +299 -0
  155. package/esm/rules/description-style.d.mts +29 -0
  156. package/esm/rules/description-style.js +82 -0
  157. package/esm/rules/graphql-js-validation.d.mts +13 -0
  158. package/esm/rules/graphql-js-validation.js +618 -0
  159. package/esm/rules/index.d.mts +127 -0
  160. package/esm/rules/index.js +76 -0
  161. package/esm/rules/input-name.d.mts +44 -0
  162. package/esm/rules/input-name.js +136 -0
  163. package/esm/rules/lone-executable-definition.d.mts +35 -0
  164. package/esm/rules/lone-executable-definition.js +86 -0
  165. package/esm/rules/match-document-filename.d.mts +81 -0
  166. package/esm/rules/match-document-filename.js +237 -0
  167. package/esm/rules/naming-convention.d.mts +108 -0
  168. package/esm/rules/naming-convention.js +403 -0
  169. package/esm/rules/no-anonymous-operations.d.mts +13 -0
  170. package/esm/rules/no-anonymous-operations.js +72 -0
  171. package/esm/rules/no-deprecated.d.mts +13 -0
  172. package/esm/rules/no-deprecated.js +124 -0
  173. package/esm/rules/no-duplicate-fields.d.mts +13 -0
  174. package/esm/rules/no-duplicate-fields.js +116 -0
  175. package/esm/rules/no-hashtag-description.d.mts +14 -0
  176. package/esm/rules/no-hashtag-description.js +107 -0
  177. package/esm/rules/no-one-place-fragments.d.mts +13 -0
  178. package/esm/rules/no-one-place-fragments.js +83 -0
  179. package/esm/rules/no-root-type.d.mts +34 -0
  180. package/esm/rules/no-root-type.js +83 -0
  181. package/esm/rules/no-scalar-result-type-on-mutation.d.mts +13 -0
  182. package/esm/rules/no-scalar-result-type-on-mutation.js +69 -0
  183. package/esm/rules/no-typename-prefix.d.mts +13 -0
  184. package/esm/rules/no-typename-prefix.js +71 -0
  185. package/esm/rules/no-unreachable-types.d.mts +13 -0
  186. package/esm/rules/no-unreachable-types.js +156 -0
  187. package/esm/rules/no-unused-fields.d.mts +13 -0
  188. package/esm/rules/no-unused-fields.js +113 -0
  189. package/esm/rules/relay-arguments.d.mts +30 -0
  190. package/esm/rules/relay-arguments.js +107 -0
  191. package/esm/rules/relay-connection-types.d.mts +14 -0
  192. package/esm/rules/relay-connection-types.js +90 -0
  193. package/esm/rules/relay-edge-types.d.mts +40 -0
  194. package/esm/rules/relay-edge-types.js +148 -0
  195. package/esm/rules/relay-page-info.d.mts +13 -0
  196. package/esm/rules/relay-page-info.js +80 -0
  197. package/esm/rules/require-deprecation-date.d.mts +27 -0
  198. package/esm/rules/require-deprecation-date.js +129 -0
  199. package/esm/rules/require-deprecation-reason.d.mts +13 -0
  200. package/esm/rules/require-deprecation-reason.js +66 -0
  201. package/esm/rules/require-description.d.mts +24 -0
  202. package/esm/rules/require-description.js +165 -0
  203. package/esm/rules/require-field-of-type-query-in-mutation-result.d.mts +13 -0
  204. package/esm/rules/require-field-of-type-query-in-mutation-result.js +68 -0
  205. package/esm/rules/require-import-fragment.d.mts +13 -0
  206. package/esm/rules/require-import-fragment.js +121 -0
  207. package/esm/rules/require-nullable-fields-with-oneof.d.mts +13 -0
  208. package/esm/rules/require-nullable-fields-with-oneof.js +62 -0
  209. package/esm/rules/require-nullable-result-in-root.d.mts +13 -0
  210. package/esm/rules/require-nullable-result-in-root.js +80 -0
  211. package/esm/rules/require-selections.d.mts +45 -0
  212. package/esm/rules/require-selections.js +194 -0
  213. package/esm/rules/require-type-pattern-with-oneof.d.mts +13 -0
  214. package/esm/rules/require-type-pattern-with-oneof.js +63 -0
  215. package/esm/rules/selection-set-depth.d.mts +37 -0
  216. package/esm/rules/selection-set-depth.js +133 -0
  217. package/esm/rules/strict-id-in-types.d.mts +66 -0
  218. package/esm/rules/strict-id-in-types.js +155 -0
  219. package/esm/rules/unique-enum-value-names.d.mts +13 -0
  220. package/esm/rules/unique-enum-value-names.js +72 -0
  221. package/esm/rules/unique-fragment-name.d.mts +14 -0
  222. package/esm/rules/unique-fragment-name.js +87 -0
  223. package/esm/rules/unique-operation-name.d.mts +13 -0
  224. package/esm/rules/unique-operation-name.js +73 -0
  225. package/esm/schema.d.mts +13 -0
  226. package/esm/schema.js +27 -0
  227. package/esm/siblings.d.mts +24 -0
  228. package/esm/siblings.js +80 -0
  229. package/esm/types.d.mts +75 -0
  230. package/esm/types.js +0 -0
  231. package/esm/utils.d.mts +45 -0
  232. package/esm/utils.js +144 -0
  233. package/index.browser.mjs +5323 -0
  234. package/package.json +43 -35
  235. package/configs/base.json +0 -4
  236. package/configs/operations-all.json +0 -24
  237. package/configs/schema-all.json +0 -26
  238. package/configs/schema-recommended.json +0 -49
  239. package/docs/README.md +0 -75
  240. package/docs/custom-rules.md +0 -148
  241. package/docs/deprecated-rules.md +0 -21
  242. package/docs/parser-options.md +0 -85
  243. package/docs/parser.md +0 -49
  244. package/docs/rules/alphabetize.md +0 -178
  245. package/docs/rules/description-style.md +0 -54
  246. package/docs/rules/executable-definitions.md +0 -17
  247. package/docs/rules/fields-on-correct-type.md +0 -17
  248. package/docs/rules/fragments-on-composite-type.md +0 -17
  249. package/docs/rules/input-name.md +0 -76
  250. package/docs/rules/known-argument-names.md +0 -17
  251. package/docs/rules/known-directives.md +0 -44
  252. package/docs/rules/known-fragment-names.md +0 -69
  253. package/docs/rules/known-type-names.md +0 -17
  254. package/docs/rules/lone-anonymous-operation.md +0 -17
  255. package/docs/rules/lone-schema-definition.md +0 -17
  256. package/docs/rules/match-document-filename.md +0 -156
  257. package/docs/rules/naming-convention.md +0 -300
  258. package/docs/rules/no-anonymous-operations.md +0 -39
  259. package/docs/rules/no-case-insensitive-enum-values-duplicates.md +0 -43
  260. package/docs/rules/no-deprecated.md +0 -85
  261. package/docs/rules/no-duplicate-fields.md +0 -65
  262. package/docs/rules/no-fragment-cycles.md +0 -17
  263. package/docs/rules/no-hashtag-description.md +0 -59
  264. package/docs/rules/no-root-type.md +0 -53
  265. package/docs/rules/no-scalar-result-type-on-mutation.md +0 -37
  266. package/docs/rules/no-typename-prefix.md +0 -39
  267. package/docs/rules/no-undefined-variables.md +0 -17
  268. package/docs/rules/no-unreachable-types.md +0 -49
  269. package/docs/rules/no-unused-fields.md +0 -62
  270. package/docs/rules/no-unused-fragments.md +0 -17
  271. package/docs/rules/no-unused-variables.md +0 -17
  272. package/docs/rules/one-field-subscriptions.md +0 -17
  273. package/docs/rules/overlapping-fields-can-be-merged.md +0 -17
  274. package/docs/rules/possible-fragment-spread.md +0 -17
  275. package/docs/rules/possible-type-extension.md +0 -15
  276. package/docs/rules/provided-required-arguments.md +0 -17
  277. package/docs/rules/relay-arguments.md +0 -57
  278. package/docs/rules/relay-connection-types.md +0 -42
  279. package/docs/rules/relay-edge-types.md +0 -56
  280. package/docs/rules/relay-page-info.md +0 -32
  281. package/docs/rules/require-deprecation-date.md +0 -56
  282. package/docs/rules/require-deprecation-reason.md +0 -47
  283. package/docs/rules/require-description.md +0 -115
  284. package/docs/rules/require-field-of-type-query-in-mutation-result.md +0 -47
  285. package/docs/rules/require-id-when-available.md +0 -88
  286. package/docs/rules/scalar-leafs.md +0 -17
  287. package/docs/rules/selection-set-depth.md +0 -76
  288. package/docs/rules/strict-id-in-types.md +0 -130
  289. package/docs/rules/unique-argument-names.md +0 -17
  290. package/docs/rules/unique-directive-names-per-location.md +0 -17
  291. package/docs/rules/unique-directive-names.md +0 -17
  292. package/docs/rules/unique-enum-value-names.md +0 -15
  293. package/docs/rules/unique-field-definition-names.md +0 -17
  294. package/docs/rules/unique-fragment-name.md +0 -51
  295. package/docs/rules/unique-input-field-names.md +0 -17
  296. package/docs/rules/unique-operation-name.md +0 -55
  297. package/docs/rules/unique-operation-types.md +0 -17
  298. package/docs/rules/unique-type-names.md +0 -17
  299. package/docs/rules/unique-variable-names.md +0 -17
  300. package/docs/rules/value-literals-of-correct-type.md +0 -17
  301. package/docs/rules/variables-are-input-types.md +0 -17
  302. package/docs/rules/variables-in-allowed-position.md +0 -17
  303. package/estree-converter/converter.d.ts +0 -3
  304. package/estree-converter/index.d.ts +0 -3
  305. package/estree-converter/types.d.ts +0 -40
  306. package/estree-converter/utils.d.ts +0 -13
  307. package/graphql-config.d.ts +0 -3
  308. package/index.d.ts +0 -16
  309. package/index.js +0 -4653
  310. package/index.mjs +0 -4641
  311. package/parser.d.ts +0 -2
  312. package/processor.d.ts +0 -7
  313. package/rules/alphabetize.d.ts +0 -16
  314. package/rules/description-style.d.ts +0 -6
  315. package/rules/graphql-js-validation.d.ts +0 -2
  316. package/rules/index.d.ts +0 -41
  317. package/rules/input-name.d.ts +0 -9
  318. package/rules/match-document-filename.d.ts +0 -18
  319. package/rules/naming-convention.d.ts +0 -37
  320. package/rules/no-anonymous-operations.d.ts +0 -3
  321. package/rules/no-case-insensitive-enum-values-duplicates.d.ts +0 -3
  322. package/rules/no-deprecated.d.ts +0 -3
  323. package/rules/no-duplicate-fields.d.ts +0 -3
  324. package/rules/no-hashtag-description.d.ts +0 -3
  325. package/rules/no-root-type.d.ts +0 -7
  326. package/rules/no-scalar-result-type-on-mutation.d.ts +0 -3
  327. package/rules/no-typename-prefix.d.ts +0 -3
  328. package/rules/no-unreachable-types.d.ts +0 -3
  329. package/rules/no-unused-fields.d.ts +0 -3
  330. package/rules/relay-arguments.d.ts +0 -6
  331. package/rules/relay-connection-types.d.ts +0 -5
  332. package/rules/relay-edge-types.d.ts +0 -8
  333. package/rules/relay-page-info.d.ts +0 -3
  334. package/rules/require-deprecation-date.d.ts +0 -5
  335. package/rules/require-deprecation-reason.d.ts +0 -3
  336. package/rules/require-description.d.ts +0 -11
  337. package/rules/require-field-of-type-query-in-mutation-result.d.ts +0 -3
  338. package/rules/require-id-when-available.d.ts +0 -6
  339. package/rules/selection-set-depth.d.ts +0 -7
  340. package/rules/strict-id-in-types.d.ts +0 -11
  341. package/rules/unique-fragment-name.d.ts +0 -6
  342. package/rules/unique-operation-name.d.ts +0 -3
  343. package/schema.d.ts +0 -3
  344. package/testkit.d.ts +0 -27
  345. package/types.d.ts +0 -79
  346. package/utils.d.ts +0 -39
@@ -1,56 +0,0 @@
1
- # `require-deprecation-date`
2
-
3
- 💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
4
-
5
- - Category: `Schema`
6
- - Rule name: `@graphql-eslint/require-deprecation-date`
7
- - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.
11
-
12
- ## Usage Examples
13
-
14
- ### Incorrect
15
-
16
- ```graphql
17
- # eslint @graphql-eslint/require-deprecation-date: 'error'
18
-
19
- type User {
20
- firstname: String @deprecated
21
- firstName: String
22
- }
23
- ```
24
-
25
- ### Incorrect
26
-
27
- ```graphql
28
- # eslint @graphql-eslint/require-deprecation-date: 'error'
29
-
30
- type User {
31
- firstname: String @deprecated(reason: "Use 'firstName' instead")
32
- firstName: String
33
- }
34
- ```
35
-
36
- ### Correct
37
-
38
- ```graphql
39
- # eslint @graphql-eslint/require-deprecation-date: 'error'
40
-
41
- type User {
42
- firstname: String @deprecated(reason: "Use 'firstName' instead", deletionDate: "25/12/2022")
43
- firstName: String
44
- }
45
- ```
46
-
47
- ## Config Schema
48
-
49
- The schema defines the following properties:
50
-
51
- ### `argumentName` (string)
52
-
53
- ## Resources
54
-
55
- - [Rule source](../../packages/plugin/src/rules/require-deprecation-date.ts)
56
- - [Test source](../../packages/plugin/tests/require-deprecation-date.spec.ts)
@@ -1,47 +0,0 @@
1
- # `require-deprecation-reason`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Schema`
6
- - Rule name: `@graphql-eslint/require-deprecation-reason`
7
- - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- Require all deprecation directives to specify a reason.
11
-
12
- ## Usage Examples
13
-
14
- ### Incorrect
15
-
16
- ```graphql
17
- # eslint @graphql-eslint/require-deprecation-reason: 'error'
18
-
19
- type MyType {
20
- name: String @deprecated
21
- }
22
- ```
23
-
24
- ### Incorrect
25
-
26
- ```graphql
27
- # eslint @graphql-eslint/require-deprecation-reason: 'error'
28
-
29
- type MyType {
30
- name: String @deprecated(reason: "")
31
- }
32
- ```
33
-
34
- ### Correct
35
-
36
- ```graphql
37
- # eslint @graphql-eslint/require-deprecation-reason: 'error'
38
-
39
- type MyType {
40
- name: String @deprecated(reason: "no longer relevant, please use fullName field")
41
- }
42
- ```
43
-
44
- ## Resources
45
-
46
- - [Rule source](../../packages/plugin/src/rules/require-deprecation-reason.ts)
47
- - [Test source](../../packages/plugin/tests/require-deprecation-reason.spec.ts)
@@ -1,115 +0,0 @@
1
- # `require-description`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Schema`
6
- - Rule name: `@graphql-eslint/require-description`
7
- - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- Enforce descriptions in type definitions and operations.
11
-
12
- ## Usage Examples
13
-
14
- ### Incorrect
15
-
16
- ```graphql
17
- # eslint @graphql-eslint/require-description: ['error', { types: true, FieldDefinition: true }]
18
-
19
- type someTypeName {
20
- name: String
21
- }
22
- ```
23
-
24
- ### Correct
25
-
26
- ```graphql
27
- # eslint @graphql-eslint/require-description: ['error', { types: true, FieldDefinition: true }]
28
-
29
- """
30
- Some type description
31
- """
32
- type someTypeName {
33
- """
34
- Name description
35
- """
36
- name: String
37
- }
38
- ```
39
-
40
- ### Correct
41
-
42
- ```graphql
43
- # eslint @graphql-eslint/require-description: ['error', { OperationDefinition: true }]
44
-
45
- # Create a new user
46
- mutation createUser {
47
- # ...
48
- }
49
- ```
50
-
51
- ## Config Schema
52
-
53
- The schema defines the following properties:
54
-
55
- ### `types` (boolean)
56
-
57
- Includes:
58
-
59
- - `ObjectTypeDefinition`
60
- - `InterfaceTypeDefinition`
61
- - `EnumTypeDefinition`
62
- - `ScalarTypeDefinition`
63
- - `InputObjectTypeDefinition`
64
- - `UnionTypeDefinition`
65
-
66
- ### `DirectiveDefinition` (boolean)
67
-
68
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#DirectiveDefinition).
69
-
70
- ### `EnumTypeDefinition` (boolean)
71
-
72
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#EnumTypeDefinition).
73
-
74
- ### `EnumValueDefinition` (boolean)
75
-
76
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#EnumValueDefinition).
77
-
78
- ### `FieldDefinition` (boolean)
79
-
80
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#FieldDefinition).
81
-
82
- ### `InputObjectTypeDefinition` (boolean)
83
-
84
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#InputObjectTypeDefinition).
85
-
86
- ### `InputValueDefinition` (boolean)
87
-
88
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#InputValueDefinition).
89
-
90
- ### `InterfaceTypeDefinition` (boolean)
91
-
92
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#InterfaceTypeDefinition).
93
-
94
- ### `ObjectTypeDefinition` (boolean)
95
-
96
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ObjectTypeDefinition).
97
-
98
- ### `OperationDefinition` (boolean)
99
-
100
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
101
-
102
- > You must use only comment syntax `#` and not description syntax `"""` or `"`.
103
-
104
- ### `ScalarTypeDefinition` (boolean)
105
-
106
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ScalarTypeDefinition).
107
-
108
- ### `UnionTypeDefinition` (boolean)
109
-
110
- Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#UnionTypeDefinition).
111
-
112
- ## Resources
113
-
114
- - [Rule source](../../packages/plugin/src/rules/require-description.ts)
115
- - [Test source](../../packages/plugin/tests/require-description.spec.ts)
@@ -1,47 +0,0 @@
1
- # `require-field-of-type-query-in-mutation-result`
2
-
3
- - Category: `Schema`
4
- - Rule name: `@graphql-eslint/require-field-of-type-query-in-mutation-result`
5
- - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
6
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
7
-
8
- Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.
9
- > Currently, no errors are reported for result type `union`, `interface` and `scalar`.
10
-
11
- ## Usage Examples
12
-
13
- ### Incorrect
14
-
15
- ```graphql
16
- # eslint @graphql-eslint/require-field-of-type-query-in-mutation-result: 'error'
17
-
18
- type User { ... }
19
-
20
- type Mutation {
21
- createUser: User!
22
- }
23
- ```
24
-
25
- ### Correct
26
-
27
- ```graphql
28
- # eslint @graphql-eslint/require-field-of-type-query-in-mutation-result: 'error'
29
-
30
- type User { ... }
31
-
32
- type Query { ... }
33
-
34
- type CreateUserPayload {
35
- user: User!
36
- query: Query!
37
- }
38
-
39
- type Mutation {
40
- createUser: CreateUserPayload!
41
- }
42
- ```
43
-
44
- ## Resources
45
-
46
- - [Rule source](../../packages/plugin/src/rules/require-field-of-type-query-in-mutation-result.ts)
47
- - [Test source](../../packages/plugin/tests/require-field-of-type-query-in-mutation-result.spec.ts)
@@ -1,88 +0,0 @@
1
- # `require-id-when-available`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
-
5
- 💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
6
-
7
- - Category: `Operations`
8
- - Rule name: `@graphql-eslint/require-id-when-available`
9
- - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
10
- - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
11
-
12
- Enforce selecting specific fields when they are available on the GraphQL type.
13
-
14
- ## Usage Examples
15
-
16
- ### Incorrect
17
-
18
- ```graphql
19
- # eslint @graphql-eslint/require-id-when-available: 'error'
20
-
21
- # In your schema
22
- type User {
23
- id: ID!
24
- name: String!
25
- }
26
-
27
- # Query
28
- query {
29
- user {
30
- name
31
- }
32
- }
33
- ```
34
-
35
- ### Correct
36
-
37
- ```graphql
38
- # eslint @graphql-eslint/require-id-when-available: 'error'
39
-
40
- # In your schema
41
- type User {
42
- id: ID!
43
- name: String!
44
- }
45
-
46
- # Query
47
- query {
48
- user {
49
- id
50
- name
51
- }
52
- }
53
-
54
- # Selecting `id` with an alias is also valid
55
- query {
56
- user {
57
- id: name
58
- }
59
- }
60
- ```
61
-
62
- ## Config Schema
63
-
64
- The schema defines the following properties:
65
-
66
- ### `fieldName`
67
-
68
- The object must be one of the following types:
69
-
70
- * `asString`
71
- * `asArray`
72
-
73
- Default: `"id"`
74
-
75
- ---
76
-
77
- # Sub Schemas
78
-
79
- The schema defines the following additional types:
80
-
81
- ## `asString` (string)
82
-
83
- ## `asArray` (array)
84
-
85
- ## Resources
86
-
87
- - [Rule source](../../packages/plugin/src/rules/require-id-when-available.ts)
88
- - [Test source](../../packages/plugin/tests/require-id-when-available.spec.ts)
@@ -1,17 +0,0 @@
1
- # `scalar-leafs`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Operations`
6
- - Rule name: `@graphql-eslint/scalar-leafs`
7
- - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.
11
-
12
- > This rule is a wrapper around a `graphql-js` validation function.
13
-
14
- ## Resources
15
-
16
- - [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ScalarLeafsRule.ts)
17
- - [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/ScalarLeafsRule-test.ts)
@@ -1,76 +0,0 @@
1
- # `selection-set-depth`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
-
5
- 💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
6
-
7
- - Category: `Operations`
8
- - Rule name: `@graphql-eslint/selection-set-depth`
9
- - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
10
- - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
11
-
12
- Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).
13
-
14
- ## Usage Examples
15
-
16
- ### Incorrect
17
-
18
- ```graphql
19
- # eslint @graphql-eslint/selection-set-depth: ['error', { maxDepth: 1 }]
20
-
21
- query deep2 {
22
- viewer { # Level 0
23
- albums { # Level 1
24
- title # Level 2
25
- }
26
- }
27
- }
28
- ```
29
-
30
- ### Correct
31
-
32
- ```graphql
33
- # eslint @graphql-eslint/selection-set-depth: ['error', { maxDepth: 4 }]
34
-
35
- query deep2 {
36
- viewer { # Level 0
37
- albums { # Level 1
38
- title # Level 2
39
- }
40
- }
41
- }
42
- ```
43
-
44
- ### Correct (ignored field)
45
-
46
- ```graphql
47
- # eslint @graphql-eslint/selection-set-depth: ['error', { maxDepth: 1, ignore: ['albums'] }]
48
-
49
- query deep2 {
50
- viewer { # Level 0
51
- albums { # Level 1
52
- title # Level 2
53
- }
54
- }
55
- }
56
- ```
57
-
58
- ## Config Schema
59
-
60
- The schema defines the following properties:
61
-
62
- ### `maxDepth` (number, required)
63
-
64
- ### `ignore` (array)
65
-
66
- The object is an array with all elements of the type `string`.
67
-
68
- Additional restrictions:
69
-
70
- * Minimum items: `1`
71
- * Unique items: `true`
72
-
73
- ## Resources
74
-
75
- - [Rule source](../../packages/plugin/src/rules/selection-set-depth.ts)
76
- - [Test source](../../packages/plugin/tests/selection-set-depth.spec.ts)
@@ -1,130 +0,0 @@
1
- # `strict-id-in-types`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Schema`
6
- - Rule name: `@graphql-eslint/strict-id-in-types`
7
- - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- Requires output types to have one unique identifier unless they do not have a logical one. Exceptions can be used to ignore output types that do not have unique identifiers.
11
-
12
- ## Usage Examples
13
-
14
- ### Incorrect
15
-
16
- ```graphql
17
- # eslint @graphql-eslint/strict-id-in-types: ['error', { acceptedIdNames: ['id', '_id'], acceptedIdTypes: ['ID'], exceptions: { suffixes: ['Payload'] } }]
18
-
19
- # Incorrect field name
20
- type InvalidFieldName {
21
- key: ID!
22
- }
23
-
24
- # Incorrect field type
25
- type InvalidFieldType {
26
- id: String!
27
- }
28
-
29
- # Incorrect exception suffix
30
- type InvalidSuffixResult {
31
- data: String!
32
- }
33
-
34
- # Too many unique identifiers. Must only contain one.
35
- type InvalidFieldName {
36
- id: ID!
37
- _id: ID!
38
- }
39
- ```
40
-
41
- ### Correct
42
-
43
- ```graphql
44
- # eslint @graphql-eslint/strict-id-in-types: ['error', { acceptedIdNames: ['id', '_id'], acceptedIdTypes: ['ID'], exceptions: { types: ['Error'], suffixes: ['Payload'] } }]
45
-
46
- type User {
47
- id: ID!
48
- }
49
-
50
- type Post {
51
- _id: ID!
52
- }
53
-
54
- type CreateUserPayload {
55
- data: String!
56
- }
57
-
58
- type Error {
59
- message: String!
60
- }
61
- ```
62
-
63
- ## Config Schema
64
-
65
- The schema defines the following properties:
66
-
67
- ### `acceptedIdNames` (array)
68
-
69
- The object is an array with all elements of the type `string`.
70
-
71
- Default:
72
-
73
- ```json
74
- [
75
- "id"
76
- ]
77
- ```
78
-
79
- Additional restrictions:
80
-
81
- * Minimum items: `1`
82
- * Unique items: `true`
83
-
84
- ### `acceptedIdTypes` (array)
85
-
86
- The object is an array with all elements of the type `string`.
87
-
88
- Default:
89
-
90
- ```json
91
- [
92
- "ID"
93
- ]
94
- ```
95
-
96
- Additional restrictions:
97
-
98
- * Minimum items: `1`
99
- * Unique items: `true`
100
-
101
- ### `exceptions` (object)
102
-
103
- Properties of the `exceptions` object:
104
-
105
- #### `types` (array)
106
-
107
- This is used to exclude types with names that match one of the specified values.
108
-
109
- The object is an array with all elements of the type `string`.
110
-
111
- Additional restrictions:
112
-
113
- * Minimum items: `1`
114
- * Unique items: `true`
115
-
116
- #### `suffixes` (array)
117
-
118
- This is used to exclude types with names with suffixes that match one of the specified values.
119
-
120
- The object is an array with all elements of the type `string`.
121
-
122
- Additional restrictions:
123
-
124
- * Minimum items: `1`
125
- * Unique items: `true`
126
-
127
- ## Resources
128
-
129
- - [Rule source](../../packages/plugin/src/rules/strict-id-in-types.ts)
130
- - [Test source](../../packages/plugin/tests/strict-id-in-types.spec.ts)
@@ -1,17 +0,0 @@
1
- # `unique-argument-names`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Operations`
6
- - Rule name: `@graphql-eslint/unique-argument-names`
7
- - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- A GraphQL field or directive is only valid if all supplied arguments are uniquely named.
11
-
12
- > This rule is a wrapper around a `graphql-js` validation function.
13
-
14
- ## Resources
15
-
16
- - [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueArgumentNamesRule.ts)
17
- - [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueArgumentNamesRule-test.ts)
@@ -1,17 +0,0 @@
1
- # `unique-directive-names-per-location`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and `"plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Schema & Operations`
6
- - Rule name: `@graphql-eslint/unique-directive-names-per-location`
7
- - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- A GraphQL document is only valid if all non-repeatable directives at a given location are uniquely named.
11
-
12
- > This rule is a wrapper around a `graphql-js` validation function.
13
-
14
- ## Resources
15
-
16
- - [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueDirectivesPerLocationRule.ts)
17
- - [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueDirectivesPerLocationRule-test.ts)
@@ -1,17 +0,0 @@
1
- # `unique-directive-names`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Schema`
6
- - Rule name: `@graphql-eslint/unique-directive-names`
7
- - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- A GraphQL document is only valid if all defined directives have unique names.
11
-
12
- > This rule is a wrapper around a `graphql-js` validation function.
13
-
14
- ## Resources
15
-
16
- - [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueDirectiveNamesRule.ts)
17
- - [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueDirectiveNamesRule-test.ts)
@@ -1,15 +0,0 @@
1
- # `unique-enum-value-names`
2
-
3
- - Category: `Schema`
4
- - Rule name: `@graphql-eslint/unique-enum-value-names`
5
- - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
6
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
7
-
8
- A GraphQL enum type is only valid if all its values are uniquely named.
9
-
10
- > This rule is a wrapper around a `graphql-js` validation function.
11
-
12
- ## Resources
13
-
14
- - [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueEnumValueNamesRule.ts)
15
- - [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueEnumValueNamesRule-test.ts)
@@ -1,17 +0,0 @@
1
- # `unique-field-definition-names`
2
-
3
- ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
4
-
5
- - Category: `Schema`
6
- - Rule name: `@graphql-eslint/unique-field-definition-names`
7
- - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
8
- - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
9
-
10
- A GraphQL complex type is only valid if all its fields are uniquely named.
11
-
12
- > This rule is a wrapper around a `graphql-js` validation function.
13
-
14
- ## Resources
15
-
16
- - [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueFieldDefinitionNamesRule.ts)
17
- - [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueFieldDefinitionNamesRule-test.ts)