@graphql-eslint/eslint-plugin 4.0.0-alpha-20220821140530-e968cfc → 4.0.0-alpha-20230801163310-8bc4340
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.
- package/LICENSE +21 -0
- package/README.md +13 -253
- package/cjs/cache.d.ts +12 -0
- package/cjs/cache.js +62 -0
- package/cjs/configs/index.d.ts +148 -0
- package/cjs/configs/index.js +49 -0
- package/cjs/configs/operations-all.d.ts +22 -0
- package/cjs/configs/operations-all.js +27 -0
- package/cjs/configs/operations-recommended.d.ts +52 -0
- package/{configs/operations-recommended.json → cjs/configs/operations-recommended.js} +16 -14
- package/cjs/configs/relay.d.ts +12 -0
- package/{configs/relay.json → cjs/configs/relay.js} +6 -4
- package/cjs/configs/schema-all.d.ts +19 -0
- package/cjs/configs/schema-all.js +21 -0
- package/cjs/configs/schema-recommended.d.ts +49 -0
- package/{configs/schema-recommended.json → cjs/configs/schema-recommended.js} +19 -20
- package/cjs/documents.d.ts +6 -0
- package/cjs/documents.js +81 -0
- package/cjs/estree-converter/converter.d.ts +8 -0
- package/cjs/estree-converter/converter.js +83 -0
- package/cjs/estree-converter/index.d.ts +8 -0
- package/cjs/estree-converter/index.js +26 -0
- package/cjs/estree-converter/types.d.ts +42 -0
- package/cjs/estree-converter/types.js +16 -0
- package/cjs/estree-converter/utils.d.ts +18 -0
- package/cjs/estree-converter/utils.js +135 -0
- package/cjs/flat-configs.d.ts +260 -0
- package/cjs/flat-configs.js +60 -0
- package/cjs/graphql-config.d.ts +13 -0
- package/cjs/graphql-config.js +86 -0
- package/cjs/index.d.ts +22 -0
- package/cjs/index.js +49 -0
- package/cjs/parser.d.ts +12 -0
- package/cjs/parser.js +103 -0
- package/cjs/processor.d.ts +9 -0
- package/cjs/processor.js +127 -0
- package/cjs/rules/alphabetize.d.ts +84 -0
- package/cjs/rules/alphabetize.js +395 -0
- package/cjs/rules/description-style.d.ts +28 -0
- package/cjs/rules/description-style.js +109 -0
- package/cjs/rules/graphql-js-validation.d.ts +12 -0
- package/cjs/rules/graphql-js-validation.js +669 -0
- package/cjs/rules/index.d.ts +125 -0
- package/cjs/rules/index.js +99 -0
- package/cjs/rules/input-name.d.ts +43 -0
- package/cjs/rules/input-name.js +170 -0
- package/cjs/rules/lone-executable-definition.d.ts +34 -0
- package/cjs/rules/lone-executable-definition.js +119 -0
- package/cjs/rules/match-document-filename.d.ts +80 -0
- package/cjs/rules/match-document-filename.js +282 -0
- package/cjs/rules/naming-convention.d.ts +107 -0
- package/cjs/rules/naming-convention.js +434 -0
- package/cjs/rules/no-anonymous-operations.d.ts +12 -0
- package/cjs/rules/no-anonymous-operations.js +98 -0
- package/cjs/rules/no-case-insensitive-enum-values-duplicates.d.ts +12 -0
- package/cjs/rules/no-case-insensitive-enum-values-duplicates.js +96 -0
- package/cjs/rules/no-deprecated.d.ts +12 -0
- package/cjs/rules/no-deprecated.js +157 -0
- package/cjs/rules/no-duplicate-fields.d.ts +12 -0
- package/cjs/rules/no-duplicate-fields.js +146 -0
- package/cjs/rules/no-hashtag-description.d.ts +13 -0
- package/cjs/rules/no-hashtag-description.js +140 -0
- package/cjs/rules/no-one-place-fragments.d.ts +12 -0
- package/cjs/rules/no-one-place-fragments.js +113 -0
- package/cjs/rules/no-root-type.d.ts +33 -0
- package/cjs/rules/no-root-type.js +113 -0
- package/cjs/rules/no-scalar-result-type-on-mutation.d.ts +12 -0
- package/cjs/rules/no-scalar-result-type-on-mutation.js +100 -0
- package/cjs/rules/no-typename-prefix.d.ts +12 -0
- package/cjs/rules/no-typename-prefix.js +98 -0
- package/cjs/rules/no-unreachable-types.d.ts +12 -0
- package/cjs/rules/no-unreachable-types.js +199 -0
- package/cjs/rules/no-unused-fields.d.ts +12 -0
- package/cjs/rules/no-unused-fields.js +157 -0
- package/cjs/rules/relay-arguments.d.ts +29 -0
- package/cjs/rules/relay-arguments.js +149 -0
- package/cjs/rules/relay-connection-types.d.ts +13 -0
- package/cjs/rules/relay-connection-types.js +142 -0
- package/cjs/rules/relay-edge-types.d.ts +39 -0
- package/cjs/rules/relay-edge-types.js +212 -0
- package/cjs/rules/relay-page-info.d.ts +12 -0
- package/cjs/rules/relay-page-info.js +121 -0
- package/cjs/rules/require-deprecation-date.d.ts +26 -0
- package/cjs/rules/require-deprecation-date.js +164 -0
- package/cjs/rules/require-deprecation-reason.d.ts +12 -0
- package/cjs/rules/require-deprecation-reason.js +93 -0
- package/cjs/rules/require-description.d.ts +23 -0
- package/cjs/rules/require-description.js +205 -0
- package/cjs/rules/require-field-of-type-query-in-mutation-result.d.ts +12 -0
- package/cjs/rules/require-field-of-type-query-in-mutation-result.js +102 -0
- package/cjs/rules/require-id-when-available.d.ts +44 -0
- package/cjs/rules/require-id-when-available.js +241 -0
- package/cjs/rules/require-import-fragment.d.ts +12 -0
- package/cjs/rules/require-import-fragment.js +166 -0
- package/cjs/rules/require-nullable-fields-with-oneof.d.ts +12 -0
- package/cjs/rules/require-nullable-fields-with-oneof.js +92 -0
- package/cjs/rules/require-nullable-result-in-root.d.ts +12 -0
- package/cjs/rules/require-nullable-result-in-root.js +109 -0
- package/cjs/rules/require-type-pattern-with-oneof.d.ts +12 -0
- package/cjs/rules/require-type-pattern-with-oneof.js +91 -0
- package/cjs/rules/selection-set-depth.d.ts +36 -0
- package/cjs/rules/selection-set-depth.js +175 -0
- package/cjs/rules/strict-id-in-types.d.ts +65 -0
- package/cjs/rules/strict-id-in-types.js +186 -0
- package/cjs/rules/unique-fragment-name.d.ts +13 -0
- package/cjs/rules/unique-fragment-name.js +118 -0
- package/cjs/rules/unique-operation-name.d.ts +12 -0
- package/cjs/rules/unique-operation-name.js +95 -0
- package/cjs/schema.d.ts +12 -0
- package/cjs/schema.js +65 -0
- package/cjs/siblings.d.ts +8 -0
- package/cjs/siblings.js +136 -0
- package/cjs/types-8d5f4ae0.d.ts +107 -0
- package/cjs/types.d.ts +8 -0
- package/cjs/types.js +16 -0
- package/cjs/utils.d.ts +44 -0
- package/cjs/utils.js +205 -0
- package/esm/cache.d.mts +12 -0
- package/esm/cache.js +29 -0
- package/esm/chunk-BMTV3EA2.js +8 -0
- package/esm/configs/index.d.mts +148 -0
- package/esm/configs/index.js +16 -0
- package/esm/configs/operations-all.d.mts +22 -0
- package/esm/configs/operations-all.js +34 -0
- package/esm/configs/operations-recommended.d.mts +52 -0
- package/esm/configs/operations-recommended.js +59 -0
- package/esm/configs/relay.d.mts +12 -0
- package/esm/configs/relay.js +18 -0
- package/esm/configs/schema-all.d.mts +19 -0
- package/esm/configs/schema-all.js +28 -0
- package/esm/configs/schema-recommended.d.mts +49 -0
- package/esm/configs/schema-recommended.js +55 -0
- package/esm/documents.d.mts +6 -0
- package/esm/documents.js +48 -0
- package/esm/estree-converter/converter.d.mts +8 -0
- package/esm/estree-converter/converter.js +65 -0
- package/esm/estree-converter/index.d.mts +8 -0
- package/esm/estree-converter/index.js +3 -0
- package/esm/estree-converter/types.d.mts +42 -0
- package/esm/estree-converter/types.js +0 -0
- package/esm/estree-converter/utils.d.mts +18 -0
- package/esm/estree-converter/utils.js +114 -0
- package/esm/flat-configs.d.mts +260 -0
- package/esm/flat-configs.js +37 -0
- package/esm/graphql-config.d.mts +13 -0
- package/esm/graphql-config.js +55 -0
- package/esm/index.d.mts +22 -0
- package/esm/index.js +18 -0
- package/esm/package.json +1 -0
- package/esm/parser.d.mts +12 -0
- package/esm/parser.js +70 -0
- package/esm/processor.d.mts +9 -0
- package/esm/processor.js +106 -0
- package/esm/rules/alphabetize.d.mts +84 -0
- package/esm/rules/alphabetize.js +364 -0
- package/esm/rules/description-style.d.mts +28 -0
- package/esm/rules/description-style.js +86 -0
- package/esm/rules/graphql-js-validation.d.mts +12 -0
- package/esm/rules/graphql-js-validation.js +658 -0
- package/esm/rules/index.d.mts +125 -0
- package/esm/rules/index.js +76 -0
- package/esm/rules/input-name.d.mts +43 -0
- package/esm/rules/input-name.js +149 -0
- package/esm/rules/lone-executable-definition.d.mts +34 -0
- package/esm/rules/lone-executable-definition.js +96 -0
- package/esm/rules/match-document-filename.d.mts +80 -0
- package/esm/rules/match-document-filename.js +263 -0
- package/esm/rules/naming-convention.d.mts +107 -0
- package/esm/rules/naming-convention.js +417 -0
- package/esm/rules/no-anonymous-operations.d.mts +12 -0
- package/esm/rules/no-anonymous-operations.js +75 -0
- package/esm/rules/no-case-insensitive-enum-values-duplicates.d.mts +12 -0
- package/esm/rules/no-case-insensitive-enum-values-duplicates.js +73 -0
- package/esm/rules/no-deprecated.d.mts +12 -0
- package/esm/rules/no-deprecated.js +134 -0
- package/esm/rules/no-duplicate-fields.d.mts +12 -0
- package/esm/rules/no-duplicate-fields.js +123 -0
- package/esm/rules/no-hashtag-description.d.mts +13 -0
- package/esm/rules/no-hashtag-description.js +116 -0
- package/esm/rules/no-one-place-fragments.d.mts +12 -0
- package/esm/rules/no-one-place-fragments.js +90 -0
- package/esm/rules/no-root-type.d.mts +33 -0
- package/esm/rules/no-root-type.js +90 -0
- package/esm/rules/no-scalar-result-type-on-mutation.d.mts +12 -0
- package/esm/rules/no-scalar-result-type-on-mutation.js +77 -0
- package/esm/rules/no-typename-prefix.d.mts +12 -0
- package/esm/rules/no-typename-prefix.js +75 -0
- package/esm/rules/no-unreachable-types.d.mts +12 -0
- package/esm/rules/no-unreachable-types.js +171 -0
- package/esm/rules/no-unused-fields.d.mts +12 -0
- package/esm/rules/no-unused-fields.js +134 -0
- package/esm/rules/relay-arguments.d.mts +29 -0
- package/esm/rules/relay-arguments.js +126 -0
- package/esm/rules/relay-connection-types.d.mts +13 -0
- package/esm/rules/relay-connection-types.js +118 -0
- package/esm/rules/relay-edge-types.d.mts +39 -0
- package/esm/rules/relay-edge-types.js +194 -0
- package/esm/rules/relay-page-info.d.mts +12 -0
- package/esm/rules/relay-page-info.js +98 -0
- package/esm/rules/require-deprecation-date.d.mts +26 -0
- package/esm/rules/require-deprecation-date.js +141 -0
- package/esm/rules/require-deprecation-reason.d.mts +12 -0
- package/esm/rules/require-deprecation-reason.js +70 -0
- package/esm/rules/require-description.d.mts +23 -0
- package/esm/rules/require-description.js +186 -0
- package/esm/rules/require-field-of-type-query-in-mutation-result.d.mts +12 -0
- package/esm/rules/require-field-of-type-query-in-mutation-result.js +79 -0
- package/esm/rules/require-id-when-available.d.mts +44 -0
- package/esm/rules/require-id-when-available.js +231 -0
- package/esm/rules/require-import-fragment.d.mts +12 -0
- package/esm/rules/require-import-fragment.js +133 -0
- package/esm/rules/require-nullable-fields-with-oneof.d.mts +12 -0
- package/esm/rules/require-nullable-fields-with-oneof.js +69 -0
- package/esm/rules/require-nullable-result-in-root.d.mts +12 -0
- package/esm/rules/require-nullable-result-in-root.js +86 -0
- package/esm/rules/require-type-pattern-with-oneof.d.mts +12 -0
- package/esm/rules/require-type-pattern-with-oneof.js +68 -0
- package/esm/rules/selection-set-depth.d.mts +36 -0
- package/esm/rules/selection-set-depth.js +142 -0
- package/esm/rules/strict-id-in-types.d.mts +65 -0
- package/esm/rules/strict-id-in-types.js +169 -0
- package/esm/rules/unique-fragment-name.d.mts +13 -0
- package/esm/rules/unique-fragment-name.js +94 -0
- package/esm/rules/unique-operation-name.d.mts +12 -0
- package/esm/rules/unique-operation-name.js +72 -0
- package/esm/schema.d.mts +12 -0
- package/esm/schema.js +32 -0
- package/esm/siblings.d.mts +8 -0
- package/esm/siblings.js +116 -0
- package/esm/types-ace77d86.d.ts +107 -0
- package/esm/types.d.mts +8 -0
- package/esm/types.js +0 -0
- package/esm/utils.d.mts +44 -0
- package/esm/utils.js +155 -0
- package/package.json +47 -34
- package/configs/base.json +0 -4
- package/configs/operations-all.json +0 -24
- package/configs/schema-all.json +0 -26
- package/docs/README.md +0 -75
- package/docs/custom-rules.md +0 -148
- package/docs/deprecated-rules.md +0 -21
- package/docs/parser-options.md +0 -85
- package/docs/parser.md +0 -49
- package/docs/rules/alphabetize.md +0 -178
- package/docs/rules/description-style.md +0 -54
- package/docs/rules/executable-definitions.md +0 -17
- package/docs/rules/fields-on-correct-type.md +0 -17
- package/docs/rules/fragments-on-composite-type.md +0 -17
- package/docs/rules/input-name.md +0 -76
- package/docs/rules/known-argument-names.md +0 -17
- package/docs/rules/known-directives.md +0 -44
- package/docs/rules/known-fragment-names.md +0 -69
- package/docs/rules/known-type-names.md +0 -17
- package/docs/rules/lone-anonymous-operation.md +0 -17
- package/docs/rules/lone-schema-definition.md +0 -17
- package/docs/rules/match-document-filename.md +0 -156
- package/docs/rules/naming-convention.md +0 -300
- package/docs/rules/no-anonymous-operations.md +0 -39
- package/docs/rules/no-case-insensitive-enum-values-duplicates.md +0 -43
- package/docs/rules/no-deprecated.md +0 -85
- package/docs/rules/no-duplicate-fields.md +0 -65
- package/docs/rules/no-fragment-cycles.md +0 -17
- package/docs/rules/no-hashtag-description.md +0 -59
- package/docs/rules/no-root-type.md +0 -53
- package/docs/rules/no-scalar-result-type-on-mutation.md +0 -37
- package/docs/rules/no-typename-prefix.md +0 -39
- package/docs/rules/no-undefined-variables.md +0 -17
- package/docs/rules/no-unreachable-types.md +0 -49
- package/docs/rules/no-unused-fields.md +0 -62
- package/docs/rules/no-unused-fragments.md +0 -17
- package/docs/rules/no-unused-variables.md +0 -17
- package/docs/rules/one-field-subscriptions.md +0 -17
- package/docs/rules/overlapping-fields-can-be-merged.md +0 -17
- package/docs/rules/possible-fragment-spread.md +0 -17
- package/docs/rules/possible-type-extension.md +0 -15
- package/docs/rules/provided-required-arguments.md +0 -17
- package/docs/rules/relay-arguments.md +0 -57
- package/docs/rules/relay-connection-types.md +0 -42
- package/docs/rules/relay-edge-types.md +0 -56
- package/docs/rules/relay-page-info.md +0 -32
- package/docs/rules/require-deprecation-date.md +0 -56
- package/docs/rules/require-deprecation-reason.md +0 -47
- package/docs/rules/require-description.md +0 -115
- package/docs/rules/require-field-of-type-query-in-mutation-result.md +0 -47
- package/docs/rules/require-id-when-available.md +0 -88
- package/docs/rules/scalar-leafs.md +0 -17
- package/docs/rules/selection-set-depth.md +0 -76
- package/docs/rules/strict-id-in-types.md +0 -130
- package/docs/rules/unique-argument-names.md +0 -17
- package/docs/rules/unique-directive-names-per-location.md +0 -17
- package/docs/rules/unique-directive-names.md +0 -17
- package/docs/rules/unique-enum-value-names.md +0 -15
- package/docs/rules/unique-field-definition-names.md +0 -17
- package/docs/rules/unique-fragment-name.md +0 -51
- package/docs/rules/unique-input-field-names.md +0 -17
- package/docs/rules/unique-operation-name.md +0 -55
- package/docs/rules/unique-operation-types.md +0 -17
- package/docs/rules/unique-type-names.md +0 -17
- package/docs/rules/unique-variable-names.md +0 -17
- package/docs/rules/value-literals-of-correct-type.md +0 -17
- package/docs/rules/variables-are-input-types.md +0 -17
- package/docs/rules/variables-in-allowed-position.md +0 -17
- package/estree-converter/converter.d.ts +0 -3
- package/estree-converter/index.d.ts +0 -3
- package/estree-converter/types.d.ts +0 -40
- package/estree-converter/utils.d.ts +0 -13
- package/graphql-config.d.ts +0 -3
- package/index.d.ts +0 -16
- package/index.js +0 -4653
- package/index.mjs +0 -4641
- package/parser.d.ts +0 -2
- package/processor.d.ts +0 -7
- package/rules/alphabetize.d.ts +0 -16
- package/rules/description-style.d.ts +0 -6
- package/rules/graphql-js-validation.d.ts +0 -2
- package/rules/index.d.ts +0 -41
- package/rules/input-name.d.ts +0 -9
- package/rules/match-document-filename.d.ts +0 -18
- package/rules/naming-convention.d.ts +0 -37
- package/rules/no-anonymous-operations.d.ts +0 -3
- package/rules/no-case-insensitive-enum-values-duplicates.d.ts +0 -3
- package/rules/no-deprecated.d.ts +0 -3
- package/rules/no-duplicate-fields.d.ts +0 -3
- package/rules/no-hashtag-description.d.ts +0 -3
- package/rules/no-root-type.d.ts +0 -7
- package/rules/no-scalar-result-type-on-mutation.d.ts +0 -3
- package/rules/no-typename-prefix.d.ts +0 -3
- package/rules/no-unreachable-types.d.ts +0 -3
- package/rules/no-unused-fields.d.ts +0 -3
- package/rules/relay-arguments.d.ts +0 -6
- package/rules/relay-connection-types.d.ts +0 -5
- package/rules/relay-edge-types.d.ts +0 -8
- package/rules/relay-page-info.d.ts +0 -3
- package/rules/require-deprecation-date.d.ts +0 -5
- package/rules/require-deprecation-reason.d.ts +0 -3
- package/rules/require-description.d.ts +0 -11
- package/rules/require-field-of-type-query-in-mutation-result.d.ts +0 -3
- package/rules/require-id-when-available.d.ts +0 -6
- package/rules/selection-set-depth.d.ts +0 -7
- package/rules/strict-id-in-types.d.ts +0 -11
- package/rules/unique-fragment-name.d.ts +0 -6
- package/rules/unique-operation-name.d.ts +0 -3
- package/schema.d.ts +0 -3
- package/sibling-operations.d.ts +0 -21
- package/testkit.d.ts +0 -27
- package/types.d.ts +0 -79
- package/utils.d.ts +0 -39
@@ -0,0 +1,118 @@
|
|
1
|
+
import "../chunk-BMTV3EA2.js";
|
2
|
+
import { Kind } from "graphql";
|
3
|
+
const MUST_BE_OBJECT_TYPE = "MUST_BE_OBJECT_TYPE";
|
4
|
+
const MUST_CONTAIN_FIELD_EDGES = "MUST_CONTAIN_FIELD_EDGES";
|
5
|
+
const MUST_CONTAIN_FIELD_PAGE_INFO = "MUST_CONTAIN_FIELD_PAGE_INFO";
|
6
|
+
const MUST_HAVE_CONNECTION_SUFFIX = "MUST_HAVE_CONNECTION_SUFFIX";
|
7
|
+
const EDGES_FIELD_MUST_RETURN_LIST_TYPE = "EDGES_FIELD_MUST_RETURN_LIST_TYPE";
|
8
|
+
const PAGE_INFO_FIELD_MUST_RETURN_NON_NULL_TYPE = "PAGE_INFO_FIELD_MUST_RETURN_NON_NULL_TYPE";
|
9
|
+
const NON_OBJECT_TYPES = [
|
10
|
+
Kind.SCALAR_TYPE_DEFINITION,
|
11
|
+
Kind.UNION_TYPE_DEFINITION,
|
12
|
+
Kind.UNION_TYPE_EXTENSION,
|
13
|
+
Kind.INPUT_OBJECT_TYPE_DEFINITION,
|
14
|
+
Kind.INPUT_OBJECT_TYPE_EXTENSION,
|
15
|
+
Kind.ENUM_TYPE_DEFINITION,
|
16
|
+
Kind.ENUM_TYPE_EXTENSION,
|
17
|
+
Kind.INTERFACE_TYPE_DEFINITION,
|
18
|
+
Kind.INTERFACE_TYPE_EXTENSION
|
19
|
+
];
|
20
|
+
const notConnectionTypesSelector = `:matches(${NON_OBJECT_TYPES})[name.value=/Connection$/] > .name`;
|
21
|
+
const hasEdgesField = (node) => {
|
22
|
+
var _a;
|
23
|
+
return (_a = node.fields) == null ? void 0 : _a.some((field) => field.name.value === "edges");
|
24
|
+
};
|
25
|
+
const hasPageInfoField = (node) => {
|
26
|
+
var _a;
|
27
|
+
return (_a = node.fields) == null ? void 0 : _a.some((field) => field.name.value === "pageInfo");
|
28
|
+
};
|
29
|
+
const rule = {
|
30
|
+
meta: {
|
31
|
+
type: "problem",
|
32
|
+
docs: {
|
33
|
+
category: "Schema",
|
34
|
+
description: [
|
35
|
+
"Set of rules to follow Relay specification for Connection types.",
|
36
|
+
"",
|
37
|
+
'- Any type whose name ends in "Connection" is considered by spec to be a `Connection type`',
|
38
|
+
"- Connection type must be an Object type",
|
39
|
+
"- Connection type must contain a field `edges` that return a list type that wraps an edge type",
|
40
|
+
"- Connection type must contain a field `pageInfo` that return a non-null `PageInfo` Object type"
|
41
|
+
].join("\n"),
|
42
|
+
url: "https://the-guild.dev/graphql/eslint/rules/relay-connection-types",
|
43
|
+
isDisabledForAllConfig: true,
|
44
|
+
examples: [
|
45
|
+
{
|
46
|
+
title: "Incorrect",
|
47
|
+
code: (
|
48
|
+
/* GraphQL */
|
49
|
+
`
|
50
|
+
type UserPayload { # should be an Object type with \`Connection\` suffix
|
51
|
+
edges: UserEdge! # should return a list type
|
52
|
+
pageInfo: PageInfo # should return a non-null \`PageInfo\` Object type
|
53
|
+
}
|
54
|
+
`
|
55
|
+
)
|
56
|
+
},
|
57
|
+
{
|
58
|
+
title: "Correct",
|
59
|
+
code: (
|
60
|
+
/* GraphQL */
|
61
|
+
`
|
62
|
+
type UserConnection {
|
63
|
+
edges: [UserEdge]
|
64
|
+
pageInfo: PageInfo!
|
65
|
+
}
|
66
|
+
`
|
67
|
+
)
|
68
|
+
}
|
69
|
+
]
|
70
|
+
},
|
71
|
+
messages: {
|
72
|
+
// Connection types
|
73
|
+
[MUST_BE_OBJECT_TYPE]: "Connection type must be an Object type.",
|
74
|
+
[MUST_HAVE_CONNECTION_SUFFIX]: "Connection type must have `Connection` suffix.",
|
75
|
+
[MUST_CONTAIN_FIELD_EDGES]: "Connection type must contain a field `edges` that return a list type.",
|
76
|
+
[MUST_CONTAIN_FIELD_PAGE_INFO]: "Connection type must contain a field `pageInfo` that return a non-null `PageInfo` Object type.",
|
77
|
+
[EDGES_FIELD_MUST_RETURN_LIST_TYPE]: "`edges` field must return a list type.",
|
78
|
+
[PAGE_INFO_FIELD_MUST_RETURN_NON_NULL_TYPE]: "`pageInfo` field must return a non-null `PageInfo` Object type."
|
79
|
+
},
|
80
|
+
schema: []
|
81
|
+
},
|
82
|
+
create(context) {
|
83
|
+
return {
|
84
|
+
[notConnectionTypesSelector](node) {
|
85
|
+
context.report({ node, messageId: MUST_BE_OBJECT_TYPE });
|
86
|
+
},
|
87
|
+
":matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value!=/Connection$/]"(node) {
|
88
|
+
if (hasEdgesField(node) && hasPageInfoField(node)) {
|
89
|
+
context.report({ node: node.name, messageId: MUST_HAVE_CONNECTION_SUFFIX });
|
90
|
+
}
|
91
|
+
},
|
92
|
+
":matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/Connection$/]"(node) {
|
93
|
+
if (!hasEdgesField(node)) {
|
94
|
+
context.report({ node: node.name, messageId: MUST_CONTAIN_FIELD_EDGES });
|
95
|
+
}
|
96
|
+
if (!hasPageInfoField(node)) {
|
97
|
+
context.report({ node: node.name, messageId: MUST_CONTAIN_FIELD_PAGE_INFO });
|
98
|
+
}
|
99
|
+
},
|
100
|
+
":matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/Connection$/] > FieldDefinition[name.value=edges] > .gqlType"(node) {
|
101
|
+
const isListType = node.kind === Kind.LIST_TYPE || node.kind === Kind.NON_NULL_TYPE && node.gqlType.kind === Kind.LIST_TYPE;
|
102
|
+
if (!isListType) {
|
103
|
+
context.report({ node, messageId: EDGES_FIELD_MUST_RETURN_LIST_TYPE });
|
104
|
+
}
|
105
|
+
},
|
106
|
+
":matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/Connection$/] > FieldDefinition[name.value=pageInfo] > .gqlType"(node) {
|
107
|
+
const isNonNullPageInfoType = node.kind === Kind.NON_NULL_TYPE && node.gqlType.kind === Kind.NAMED_TYPE && node.gqlType.name.value === "PageInfo";
|
108
|
+
if (!isNonNullPageInfoType) {
|
109
|
+
context.report({ node, messageId: PAGE_INFO_FIELD_MUST_RETURN_NON_NULL_TYPE });
|
110
|
+
}
|
111
|
+
}
|
112
|
+
};
|
113
|
+
}
|
114
|
+
};
|
115
|
+
export {
|
116
|
+
NON_OBJECT_TYPES,
|
117
|
+
rule
|
118
|
+
};
|
@@ -0,0 +1,39 @@
|
|
1
|
+
import { FromSchema } from 'json-schema-to-ts';
|
2
|
+
import { f as GraphQLESLintRule } from '../types-ace77d86.js';
|
3
|
+
import '@graphql-tools/utils';
|
4
|
+
import 'eslint';
|
5
|
+
import 'estree';
|
6
|
+
import 'graphql';
|
7
|
+
import 'graphql-config';
|
8
|
+
import '../estree-converter/types.mjs';
|
9
|
+
|
10
|
+
declare const schema: {
|
11
|
+
readonly type: "array";
|
12
|
+
readonly maxItems: 1;
|
13
|
+
readonly items: {
|
14
|
+
readonly type: "object";
|
15
|
+
readonly additionalProperties: false;
|
16
|
+
readonly minProperties: 1;
|
17
|
+
readonly properties: {
|
18
|
+
readonly withEdgeSuffix: {
|
19
|
+
readonly type: "boolean";
|
20
|
+
readonly default: true;
|
21
|
+
readonly description: "Edge type name must end in \"Edge\".";
|
22
|
+
};
|
23
|
+
readonly shouldImplementNode: {
|
24
|
+
readonly type: "boolean";
|
25
|
+
readonly default: true;
|
26
|
+
readonly description: "Edge type's field `node` must implement `Node` interface.";
|
27
|
+
};
|
28
|
+
readonly listTypeCanWrapOnlyEdgeType: {
|
29
|
+
readonly type: "boolean";
|
30
|
+
readonly default: true;
|
31
|
+
readonly description: "A list type should only wrap an edge type.";
|
32
|
+
};
|
33
|
+
};
|
34
|
+
};
|
35
|
+
};
|
36
|
+
type RuleOptions = FromSchema<typeof schema>;
|
37
|
+
declare const rule: GraphQLESLintRule<RuleOptions, true>;
|
38
|
+
|
39
|
+
export { RuleOptions, rule };
|
@@ -0,0 +1,194 @@
|
|
1
|
+
import "../chunk-BMTV3EA2.js";
|
2
|
+
import { getDocumentNodeFromSchema } from "@graphql-tools/utils";
|
3
|
+
import {
|
4
|
+
isObjectType,
|
5
|
+
isScalarType,
|
6
|
+
Kind,
|
7
|
+
visit
|
8
|
+
} from "graphql";
|
9
|
+
import { getTypeName, requireGraphQLSchemaFromContext } from "../utils.js";
|
10
|
+
const RULE_ID = "relay-edge-types";
|
11
|
+
const MESSAGE_MUST_BE_OBJECT_TYPE = "MESSAGE_MUST_BE_OBJECT_TYPE";
|
12
|
+
const MESSAGE_MISSING_EDGE_SUFFIX = "MESSAGE_MISSING_EDGE_SUFFIX";
|
13
|
+
const MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE = "MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE";
|
14
|
+
const MESSAGE_SHOULD_IMPLEMENTS_NODE = "MESSAGE_SHOULD_IMPLEMENTS_NODE";
|
15
|
+
let edgeTypesCache;
|
16
|
+
function getEdgeTypes(schema2) {
|
17
|
+
if (edgeTypesCache) {
|
18
|
+
return edgeTypesCache;
|
19
|
+
}
|
20
|
+
const edgeTypes = /* @__PURE__ */ new Set();
|
21
|
+
const visitor = {
|
22
|
+
ObjectTypeDefinition(node) {
|
23
|
+
var _a;
|
24
|
+
const typeName = node.name.value;
|
25
|
+
const hasConnectionSuffix = typeName.endsWith("Connection");
|
26
|
+
if (!hasConnectionSuffix) {
|
27
|
+
return;
|
28
|
+
}
|
29
|
+
const edges = (_a = node.fields) == null ? void 0 : _a.find((field) => field.name.value === "edges");
|
30
|
+
if (edges) {
|
31
|
+
const edgesTypeName = getTypeName(edges);
|
32
|
+
const edgesType = schema2.getType(edgesTypeName);
|
33
|
+
if (isObjectType(edgesType)) {
|
34
|
+
edgeTypes.add(edgesTypeName);
|
35
|
+
}
|
36
|
+
}
|
37
|
+
}
|
38
|
+
};
|
39
|
+
const astNode = getDocumentNodeFromSchema(schema2);
|
40
|
+
visit(astNode, visitor);
|
41
|
+
edgeTypesCache = edgeTypes;
|
42
|
+
return edgeTypesCache;
|
43
|
+
}
|
44
|
+
const schema = {
|
45
|
+
type: "array",
|
46
|
+
maxItems: 1,
|
47
|
+
items: {
|
48
|
+
type: "object",
|
49
|
+
additionalProperties: false,
|
50
|
+
minProperties: 1,
|
51
|
+
properties: {
|
52
|
+
withEdgeSuffix: {
|
53
|
+
type: "boolean",
|
54
|
+
default: true,
|
55
|
+
description: 'Edge type name must end in "Edge".'
|
56
|
+
},
|
57
|
+
shouldImplementNode: {
|
58
|
+
type: "boolean",
|
59
|
+
default: true,
|
60
|
+
description: "Edge type's field `node` must implement `Node` interface."
|
61
|
+
},
|
62
|
+
listTypeCanWrapOnlyEdgeType: {
|
63
|
+
type: "boolean",
|
64
|
+
default: true,
|
65
|
+
description: "A list type should only wrap an edge type."
|
66
|
+
}
|
67
|
+
}
|
68
|
+
}
|
69
|
+
};
|
70
|
+
const rule = {
|
71
|
+
meta: {
|
72
|
+
type: "problem",
|
73
|
+
docs: {
|
74
|
+
category: "Schema",
|
75
|
+
description: [
|
76
|
+
"Set of rules to follow Relay specification for Edge types.",
|
77
|
+
"",
|
78
|
+
"- A type that is returned in list form by a connection type's `edges` field is considered by this spec to be an Edge type",
|
79
|
+
"- Edge type must be an Object type",
|
80
|
+
"- Edge type must contain a field `node` that return either Scalar, Enum, Object, Interface, Union, or a non-null wrapper around one of those types. Notably, this field cannot return a list",
|
81
|
+
"- Edge type must contain a field `cursor` that return either String, Scalar, or a non-null wrapper around one of those types",
|
82
|
+
'- Edge type name must end in "Edge" _(optional)_',
|
83
|
+
"- Edge type's field `node` must implement `Node` interface _(optional)_",
|
84
|
+
"- A list type should only wrap an edge type _(optional)_"
|
85
|
+
].join("\n"),
|
86
|
+
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
87
|
+
isDisabledForAllConfig: true,
|
88
|
+
requiresSchema: true,
|
89
|
+
examples: [
|
90
|
+
{
|
91
|
+
title: "Correct",
|
92
|
+
code: (
|
93
|
+
/* GraphQL */
|
94
|
+
`
|
95
|
+
type UserConnection {
|
96
|
+
edges: [UserEdge]
|
97
|
+
pageInfo: PageInfo!
|
98
|
+
}
|
99
|
+
`
|
100
|
+
)
|
101
|
+
}
|
102
|
+
]
|
103
|
+
},
|
104
|
+
messages: {
|
105
|
+
[MESSAGE_MUST_BE_OBJECT_TYPE]: "Edge type must be an Object type.",
|
106
|
+
[MESSAGE_MISSING_EDGE_SUFFIX]: 'Edge type must have "Edge" suffix.',
|
107
|
+
[MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE]: "A list type should only wrap an edge type.",
|
108
|
+
[MESSAGE_SHOULD_IMPLEMENTS_NODE]: "Edge type's field `node` must implement `Node` interface."
|
109
|
+
},
|
110
|
+
schema
|
111
|
+
},
|
112
|
+
create(context) {
|
113
|
+
const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context);
|
114
|
+
const edgeTypes = getEdgeTypes(schema2);
|
115
|
+
const options = {
|
116
|
+
withEdgeSuffix: true,
|
117
|
+
shouldImplementNode: true,
|
118
|
+
listTypeCanWrapOnlyEdgeType: true,
|
119
|
+
...context.options[0]
|
120
|
+
};
|
121
|
+
const isNamedOrNonNullNamed = (node) => node.kind === Kind.NAMED_TYPE || node.kind === Kind.NON_NULL_TYPE && node.gqlType.kind === Kind.NAMED_TYPE;
|
122
|
+
const checkNodeField = (node) => {
|
123
|
+
var _a, _b;
|
124
|
+
const nodeField = (_a = node.fields) == null ? void 0 : _a.find((field) => field.name.value === "node");
|
125
|
+
const message = "return either a Scalar, Enum, Object, Interface, Union, or a non-null wrapper around one of those types.";
|
126
|
+
if (!nodeField) {
|
127
|
+
context.report({
|
128
|
+
node: node.name,
|
129
|
+
message: `Edge type must contain a field \`node\` that ${message}`
|
130
|
+
});
|
131
|
+
} else if (!isNamedOrNonNullNamed(nodeField.gqlType)) {
|
132
|
+
context.report({ node: nodeField.name, message: `Field \`node\` must ${message}` });
|
133
|
+
} else if (options.shouldImplementNode) {
|
134
|
+
const nodeReturnTypeName = getTypeName(nodeField.gqlType.rawNode());
|
135
|
+
const type = schema2.getType(nodeReturnTypeName);
|
136
|
+
if (!isObjectType(type)) {
|
137
|
+
return;
|
138
|
+
}
|
139
|
+
const implementsNode = (_b = type.astNode.interfaces) == null ? void 0 : _b.some((n) => n.name.value === "Node");
|
140
|
+
if (!implementsNode) {
|
141
|
+
context.report({ node: node.name, messageId: MESSAGE_SHOULD_IMPLEMENTS_NODE });
|
142
|
+
}
|
143
|
+
}
|
144
|
+
};
|
145
|
+
const checkCursorField = (node) => {
|
146
|
+
var _a;
|
147
|
+
const cursorField = (_a = node.fields) == null ? void 0 : _a.find((field) => field.name.value === "cursor");
|
148
|
+
const message = "return either a String, Scalar, or a non-null wrapper wrapper around one of those types.";
|
149
|
+
if (!cursorField) {
|
150
|
+
context.report({
|
151
|
+
node: node.name,
|
152
|
+
message: `Edge type must contain a field \`cursor\` that ${message}`
|
153
|
+
});
|
154
|
+
return;
|
155
|
+
}
|
156
|
+
const typeName = getTypeName(cursorField.rawNode());
|
157
|
+
if (!isNamedOrNonNullNamed(cursorField.gqlType) || typeName !== "String" && !isScalarType(schema2.getType(typeName))) {
|
158
|
+
context.report({ node: cursorField.name, message: `Field \`cursor\` must ${message}` });
|
159
|
+
}
|
160
|
+
};
|
161
|
+
const listeners = {
|
162
|
+
":matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/Connection$/] > FieldDefinition[name.value=edges] > .gqlType Name"(node) {
|
163
|
+
const type = schema2.getType(node.value);
|
164
|
+
if (!isObjectType(type)) {
|
165
|
+
context.report({ node, messageId: MESSAGE_MUST_BE_OBJECT_TYPE });
|
166
|
+
}
|
167
|
+
},
|
168
|
+
":matches(ObjectTypeDefinition, ObjectTypeExtension)"(node) {
|
169
|
+
const typeName = node.name.value;
|
170
|
+
if (edgeTypes.has(typeName)) {
|
171
|
+
checkNodeField(node);
|
172
|
+
checkCursorField(node);
|
173
|
+
if (options.withEdgeSuffix && !typeName.endsWith("Edge")) {
|
174
|
+
context.report({ node: node.name, messageId: MESSAGE_MISSING_EDGE_SUFFIX });
|
175
|
+
}
|
176
|
+
}
|
177
|
+
}
|
178
|
+
};
|
179
|
+
if (options.listTypeCanWrapOnlyEdgeType) {
|
180
|
+
listeners["FieldDefinition > .gqlType"] = (node) => {
|
181
|
+
if (node.kind === Kind.LIST_TYPE || node.kind === Kind.NON_NULL_TYPE && node.gqlType.kind === Kind.LIST_TYPE) {
|
182
|
+
const typeName = getTypeName(node.rawNode());
|
183
|
+
if (!edgeTypes.has(typeName)) {
|
184
|
+
context.report({ node, messageId: MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE });
|
185
|
+
}
|
186
|
+
}
|
187
|
+
};
|
188
|
+
}
|
189
|
+
return listeners;
|
190
|
+
}
|
191
|
+
};
|
192
|
+
export {
|
193
|
+
rule
|
194
|
+
};
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import { f as GraphQLESLintRule } from '../types-ace77d86.js';
|
2
|
+
import '@graphql-tools/utils';
|
3
|
+
import 'eslint';
|
4
|
+
import 'estree';
|
5
|
+
import 'graphql';
|
6
|
+
import 'graphql-config';
|
7
|
+
import 'json-schema-to-ts';
|
8
|
+
import '../estree-converter/types.mjs';
|
9
|
+
|
10
|
+
declare const rule: GraphQLESLintRule;
|
11
|
+
|
12
|
+
export { rule };
|
@@ -0,0 +1,98 @@
|
|
1
|
+
import "../chunk-BMTV3EA2.js";
|
2
|
+
import { isScalarType, Kind } from "graphql";
|
3
|
+
import { REPORT_ON_FIRST_CHARACTER, requireGraphQLSchemaFromContext } from "../utils.js";
|
4
|
+
import { NON_OBJECT_TYPES } from "./relay-connection-types.js";
|
5
|
+
const RULE_ID = "relay-page-info";
|
6
|
+
const MESSAGE_MUST_EXIST = "MESSAGE_MUST_EXIST";
|
7
|
+
const MESSAGE_MUST_BE_OBJECT_TYPE = "MESSAGE_MUST_BE_OBJECT_TYPE";
|
8
|
+
const notPageInfoTypesSelector = `:matches(${NON_OBJECT_TYPES})[name.value=PageInfo] > .name`;
|
9
|
+
let hasPageInfoChecked = false;
|
10
|
+
const rule = {
|
11
|
+
meta: {
|
12
|
+
type: "problem",
|
13
|
+
docs: {
|
14
|
+
category: "Schema",
|
15
|
+
description: [
|
16
|
+
"Set of rules to follow Relay specification for `PageInfo` object.",
|
17
|
+
"",
|
18
|
+
"- `PageInfo` must be an Object type",
|
19
|
+
"- `PageInfo` must contain fields `hasPreviousPage` and `hasNextPage`, that return non-null Boolean",
|
20
|
+
"- `PageInfo` must contain fields `startCursor` and `endCursor`, that return either String or Scalar, which can be null if there are no results"
|
21
|
+
].join("\n"),
|
22
|
+
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
23
|
+
examples: [
|
24
|
+
{
|
25
|
+
title: "Correct",
|
26
|
+
code: (
|
27
|
+
/* GraphQL */
|
28
|
+
`
|
29
|
+
type PageInfo {
|
30
|
+
hasPreviousPage: Boolean!
|
31
|
+
hasNextPage: Boolean!
|
32
|
+
startCursor: String
|
33
|
+
endCursor: String
|
34
|
+
}
|
35
|
+
`
|
36
|
+
)
|
37
|
+
}
|
38
|
+
],
|
39
|
+
isDisabledForAllConfig: true,
|
40
|
+
requiresSchema: true
|
41
|
+
},
|
42
|
+
messages: {
|
43
|
+
[MESSAGE_MUST_EXIST]: "The server must provide a `PageInfo` object.",
|
44
|
+
[MESSAGE_MUST_BE_OBJECT_TYPE]: "`PageInfo` must be an Object type."
|
45
|
+
},
|
46
|
+
schema: []
|
47
|
+
},
|
48
|
+
create(context) {
|
49
|
+
const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
|
50
|
+
if (!hasPageInfoChecked) {
|
51
|
+
const pageInfoType = schema.getType("PageInfo");
|
52
|
+
if (!pageInfoType) {
|
53
|
+
context.report({
|
54
|
+
loc: REPORT_ON_FIRST_CHARACTER,
|
55
|
+
messageId: MESSAGE_MUST_EXIST
|
56
|
+
});
|
57
|
+
}
|
58
|
+
hasPageInfoChecked = true;
|
59
|
+
}
|
60
|
+
return {
|
61
|
+
[notPageInfoTypesSelector](node) {
|
62
|
+
context.report({ node, messageId: MESSAGE_MUST_BE_OBJECT_TYPE });
|
63
|
+
},
|
64
|
+
"ObjectTypeDefinition[name.value=PageInfo]"(node) {
|
65
|
+
var _a;
|
66
|
+
const fieldMap = Object.fromEntries(
|
67
|
+
((_a = node.fields) == null ? void 0 : _a.map((field) => [field.name.value, field])) || []
|
68
|
+
);
|
69
|
+
const checkField = (fieldName, typeName) => {
|
70
|
+
const field = fieldMap[fieldName];
|
71
|
+
let isAllowedType = false;
|
72
|
+
if (field) {
|
73
|
+
const type = field.gqlType;
|
74
|
+
if (typeName === "Boolean") {
|
75
|
+
isAllowedType = type.kind === Kind.NON_NULL_TYPE && type.gqlType.kind === Kind.NAMED_TYPE && type.gqlType.name.value === "Boolean";
|
76
|
+
} else if (type.kind === Kind.NAMED_TYPE) {
|
77
|
+
isAllowedType = type.name.value === "String" || isScalarType(schema.getType(type.name.value));
|
78
|
+
}
|
79
|
+
}
|
80
|
+
if (!isAllowedType) {
|
81
|
+
const returnType = typeName === "Boolean" ? "non-null Boolean" : "either String or Scalar, which can be null if there are no results";
|
82
|
+
context.report({
|
83
|
+
node: field ? field.name : node.name,
|
84
|
+
message: field ? `Field \`${fieldName}\` must return ${returnType}.` : `\`PageInfo\` must contain a field \`${fieldName}\`, that return ${returnType}.`
|
85
|
+
});
|
86
|
+
}
|
87
|
+
};
|
88
|
+
checkField("hasPreviousPage", "Boolean");
|
89
|
+
checkField("hasNextPage", "Boolean");
|
90
|
+
checkField("startCursor", "String");
|
91
|
+
checkField("endCursor", "String");
|
92
|
+
}
|
93
|
+
};
|
94
|
+
}
|
95
|
+
};
|
96
|
+
export {
|
97
|
+
rule
|
98
|
+
};
|
@@ -0,0 +1,26 @@
|
|
1
|
+
import { FromSchema } from 'json-schema-to-ts';
|
2
|
+
import { f as GraphQLESLintRule } from '../types-ace77d86.js';
|
3
|
+
import '@graphql-tools/utils';
|
4
|
+
import 'eslint';
|
5
|
+
import 'estree';
|
6
|
+
import 'graphql';
|
7
|
+
import 'graphql-config';
|
8
|
+
import '../estree-converter/types.mjs';
|
9
|
+
|
10
|
+
declare const schema: {
|
11
|
+
readonly type: "array";
|
12
|
+
readonly maxItems: 1;
|
13
|
+
readonly items: {
|
14
|
+
readonly type: "object";
|
15
|
+
readonly additionalProperties: false;
|
16
|
+
readonly properties: {
|
17
|
+
readonly argumentName: {
|
18
|
+
readonly type: "string";
|
19
|
+
};
|
20
|
+
};
|
21
|
+
};
|
22
|
+
};
|
23
|
+
type RuleOptions = FromSchema<typeof schema>;
|
24
|
+
declare const rule: GraphQLESLintRule<RuleOptions>;
|
25
|
+
|
26
|
+
export { RuleOptions, rule };
|
@@ -0,0 +1,141 @@
|
|
1
|
+
import "../chunk-BMTV3EA2.js";
|
2
|
+
import { valueFromNode } from "../estree-converter/index.js";
|
3
|
+
import { getNodeName } from "../utils.js";
|
4
|
+
const DATE_REGEX = /^\d{2}\/\d{2}\/\d{4}$/;
|
5
|
+
const MESSAGE_REQUIRE_DATE = "MESSAGE_REQUIRE_DATE";
|
6
|
+
const MESSAGE_INVALID_FORMAT = "MESSAGE_INVALID_FORMAT";
|
7
|
+
const MESSAGE_INVALID_DATE = "MESSAGE_INVALID_DATE";
|
8
|
+
const MESSAGE_CAN_BE_REMOVED = "MESSAGE_CAN_BE_REMOVED";
|
9
|
+
const schema = {
|
10
|
+
type: "array",
|
11
|
+
maxItems: 1,
|
12
|
+
items: {
|
13
|
+
type: "object",
|
14
|
+
additionalProperties: false,
|
15
|
+
properties: {
|
16
|
+
argumentName: {
|
17
|
+
type: "string"
|
18
|
+
}
|
19
|
+
}
|
20
|
+
}
|
21
|
+
};
|
22
|
+
const rule = {
|
23
|
+
meta: {
|
24
|
+
type: "suggestion",
|
25
|
+
hasSuggestions: true,
|
26
|
+
docs: {
|
27
|
+
category: "Schema",
|
28
|
+
description: "Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.",
|
29
|
+
url: "https://the-guild.dev/graphql/eslint/rules/require-deprecation-date",
|
30
|
+
examples: [
|
31
|
+
{
|
32
|
+
title: "Incorrect",
|
33
|
+
code: (
|
34
|
+
/* GraphQL */
|
35
|
+
`
|
36
|
+
type User {
|
37
|
+
firstname: String @deprecated
|
38
|
+
firstName: String
|
39
|
+
}
|
40
|
+
`
|
41
|
+
)
|
42
|
+
},
|
43
|
+
{
|
44
|
+
title: "Incorrect",
|
45
|
+
code: (
|
46
|
+
/* GraphQL */
|
47
|
+
`
|
48
|
+
type User {
|
49
|
+
firstname: String @deprecated(reason: "Use 'firstName' instead")
|
50
|
+
firstName: String
|
51
|
+
}
|
52
|
+
`
|
53
|
+
)
|
54
|
+
},
|
55
|
+
{
|
56
|
+
title: "Correct",
|
57
|
+
code: (
|
58
|
+
/* GraphQL */
|
59
|
+
`
|
60
|
+
type User {
|
61
|
+
firstname: String
|
62
|
+
@deprecated(reason: "Use 'firstName' instead", deletionDate: "25/12/2022")
|
63
|
+
firstName: String
|
64
|
+
}
|
65
|
+
`
|
66
|
+
)
|
67
|
+
}
|
68
|
+
]
|
69
|
+
},
|
70
|
+
messages: {
|
71
|
+
[MESSAGE_REQUIRE_DATE]: 'Directive "@deprecated" must have a deletion date for {{ nodeName }}',
|
72
|
+
[MESSAGE_INVALID_FORMAT]: 'Deletion date must be in format "DD/MM/YYYY" for {{ nodeName }}',
|
73
|
+
[MESSAGE_INVALID_DATE]: 'Invalid "{{ deletionDate }}" deletion date for {{ nodeName }}',
|
74
|
+
[MESSAGE_CAN_BE_REMOVED]: "{{ nodeName }} \u0441an be removed"
|
75
|
+
},
|
76
|
+
schema
|
77
|
+
},
|
78
|
+
create(context) {
|
79
|
+
return {
|
80
|
+
"Directive[name.value=deprecated]"(node) {
|
81
|
+
var _a, _b;
|
82
|
+
const argName = ((_a = context.options[0]) == null ? void 0 : _a.argumentName) || "deletionDate";
|
83
|
+
const deletionDateNode = (_b = node.arguments) == null ? void 0 : _b.find((arg) => arg.name.value === argName);
|
84
|
+
if (!deletionDateNode) {
|
85
|
+
context.report({
|
86
|
+
node: node.name,
|
87
|
+
messageId: MESSAGE_REQUIRE_DATE,
|
88
|
+
data: {
|
89
|
+
nodeName: getNodeName(node.parent)
|
90
|
+
}
|
91
|
+
});
|
92
|
+
return;
|
93
|
+
}
|
94
|
+
const deletionDate = valueFromNode(deletionDateNode.value);
|
95
|
+
const isValidDate = DATE_REGEX.test(deletionDate);
|
96
|
+
if (!isValidDate) {
|
97
|
+
context.report({
|
98
|
+
node: deletionDateNode.value,
|
99
|
+
messageId: MESSAGE_INVALID_FORMAT,
|
100
|
+
data: { nodeName: getNodeName(node.parent) }
|
101
|
+
});
|
102
|
+
return;
|
103
|
+
}
|
104
|
+
let [day, month, year] = deletionDate.split("/");
|
105
|
+
day = day.padStart(2, "0");
|
106
|
+
month = month.padStart(2, "0");
|
107
|
+
const deletionDateInMS = Date.parse(`${year}-${month}-${day}`);
|
108
|
+
if (Number.isNaN(deletionDateInMS)) {
|
109
|
+
context.report({
|
110
|
+
node: deletionDateNode.value,
|
111
|
+
messageId: MESSAGE_INVALID_DATE,
|
112
|
+
data: {
|
113
|
+
deletionDate,
|
114
|
+
nodeName: getNodeName(node.parent)
|
115
|
+
}
|
116
|
+
});
|
117
|
+
return;
|
118
|
+
}
|
119
|
+
const canRemove = Date.now() > deletionDateInMS;
|
120
|
+
if (canRemove) {
|
121
|
+
const { parent } = node;
|
122
|
+
const nodeName = parent.name.value;
|
123
|
+
context.report({
|
124
|
+
node: parent.name,
|
125
|
+
messageId: MESSAGE_CAN_BE_REMOVED,
|
126
|
+
data: { nodeName: getNodeName(parent) },
|
127
|
+
suggest: [
|
128
|
+
{
|
129
|
+
desc: `Remove \`${nodeName}\``,
|
130
|
+
fix: (fixer) => fixer.remove(parent)
|
131
|
+
}
|
132
|
+
]
|
133
|
+
});
|
134
|
+
}
|
135
|
+
}
|
136
|
+
};
|
137
|
+
}
|
138
|
+
};
|
139
|
+
export {
|
140
|
+
rule
|
141
|
+
};
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import { f as GraphQLESLintRule } from '../types-ace77d86.js';
|
2
|
+
import '@graphql-tools/utils';
|
3
|
+
import 'eslint';
|
4
|
+
import 'estree';
|
5
|
+
import 'graphql';
|
6
|
+
import 'graphql-config';
|
7
|
+
import 'json-schema-to-ts';
|
8
|
+
import '../estree-converter/types.mjs';
|
9
|
+
|
10
|
+
declare const rule: GraphQLESLintRule;
|
11
|
+
|
12
|
+
export { rule };
|