@graphql-eslint/eslint-plugin 3.19.3 → 3.20.0-alpha-20230703155329-a20556f
Sign up to get free protection for your applications and to get access to all the features.
- package/{typings → cjs}/cache.d.ts +3 -1
- package/cjs/cache.js +57 -26
- package/{typings → cjs}/configs/index.d.ts +3 -1
- package/cjs/configs/index.js +47 -14
- package/{typings → cjs}/configs/operations-all.d.ts +2 -1
- package/cjs/configs/operations-all.js +47 -30
- package/{typings → cjs}/configs/operations-recommended.d.ts +2 -1
- package/cjs/configs/operations-recommended.js +72 -55
- package/{typings → cjs}/configs/relay.d.ts +2 -1
- package/cjs/configs/relay.js +31 -11
- package/{typings → cjs}/configs/schema-all.d.ts +2 -1
- package/cjs/configs/schema-all.js +41 -24
- package/{typings → cjs}/configs/schema-recommended.d.ts +2 -1
- package/cjs/configs/schema-recommended.js +68 -51
- package/{typings → cjs}/documents.d.ts +4 -1
- package/cjs/documents.js +74 -43
- package/cjs/estree-converter/converter.d.ts +8 -0
- package/cjs/estree-converter/converter.js +80 -59
- package/cjs/estree-converter/index.d.ts +8 -0
- package/cjs/estree-converter/index.js +25 -5
- package/{typings → cjs}/estree-converter/types.d.ts +7 -5
- package/cjs/estree-converter/types.js +16 -0
- package/cjs/estree-converter/utils.d.ts +18 -0
- package/cjs/estree-converter/utils.js +119 -95
- package/{typings → cjs}/flat-configs.d.ts +12 -1
- package/cjs/flat-configs.js +56 -32
- package/cjs/graphql-config.d.ts +13 -0
- package/cjs/graphql-config.js +78 -47
- package/cjs/index.d.ts +22 -0
- package/cjs/index.js +50 -18
- package/cjs/parser.d.ts +12 -0
- package/cjs/parser.js +96 -76
- package/cjs/processor.d.ts +9 -0
- package/cjs/processor.js +119 -88
- package/{typings → cjs}/rules/alphabetize.d.ts +12 -4
- package/cjs/rules/alphabetize.js +337 -295
- package/{typings → cjs}/rules/description-style.d.ts +12 -4
- package/cjs/rules/description-style.js +96 -66
- package/cjs/rules/graphql-js-validation.d.ts +12 -0
- package/cjs/rules/graphql-js-validation.js +595 -433
- package/cjs/rules/index.d.ts +125 -0
- package/cjs/rules/index.js +97 -76
- package/{typings → cjs}/rules/input-name.d.ts +12 -4
- package/cjs/rules/input-name.js +153 -123
- package/{typings → cjs}/rules/lone-executable-definition.d.ts +12 -4
- package/cjs/rules/lone-executable-definition.js +101 -72
- package/{typings → cjs}/rules/match-document-filename.d.ts +14 -6
- package/cjs/rules/match-document-filename.js +229 -182
- package/{typings → cjs}/rules/naming-convention.d.ts +12 -4
- package/cjs/rules/naming-convention.js +380 -316
- package/cjs/rules/no-anonymous-operations.d.ts +12 -0
- package/cjs/rules/no-anonymous-operations.js +88 -57
- package/cjs/rules/no-case-insensitive-enum-values-duplicates.d.ts +12 -0
- package/cjs/rules/no-case-insensitive-enum-values-duplicates.js +82 -50
- package/cjs/rules/no-deprecated.d.ts +12 -0
- package/cjs/rules/no-deprecated.js +106 -75
- package/cjs/rules/no-duplicate-fields.d.ts +12 -0
- package/cjs/rules/no-duplicate-fields.js +116 -82
- package/cjs/rules/no-hashtag-description.d.ts +13 -0
- package/cjs/rules/no-hashtag-description.js +119 -82
- package/cjs/rules/no-one-place-fragments.d.ts +12 -0
- package/cjs/rules/no-one-place-fragments.js +88 -58
- package/{typings → cjs}/rules/no-root-type.d.ts +12 -4
- package/cjs/rules/no-root-type.js +101 -74
- package/cjs/rules/no-scalar-result-type-on-mutation.d.ts +12 -0
- package/cjs/rules/no-scalar-result-type-on-mutation.js +90 -60
- package/cjs/rules/no-typename-prefix.d.ts +12 -0
- package/cjs/rules/no-typename-prefix.js +88 -55
- package/cjs/rules/no-unreachable-types.d.ts +12 -0
- package/cjs/rules/no-unreachable-types.js +169 -134
- package/cjs/rules/no-unused-fields.d.ts +12 -0
- package/cjs/rules/no-unused-fields.js +117 -92
- package/{typings → cjs}/rules/relay-arguments.d.ts +12 -4
- package/cjs/rules/relay-arguments.js +136 -110
- package/cjs/rules/relay-connection-types.d.ts +13 -0
- package/cjs/rules/relay-connection-types.js +123 -94
- package/{typings → cjs}/rules/relay-edge-types.d.ts +12 -4
- package/cjs/rules/relay-edge-types.js +196 -179
- package/cjs/rules/relay-page-info.d.ts +12 -0
- package/cjs/rules/relay-page-info.js +108 -89
- package/{typings → cjs}/rules/require-deprecation-date.d.ts +12 -4
- package/cjs/rules/require-deprecation-date.js +143 -112
- package/cjs/rules/require-deprecation-reason.d.ts +12 -0
- package/cjs/rules/require-deprecation-reason.js +80 -46
- package/{typings → cjs}/rules/require-description.d.ts +13 -5
- package/cjs/rules/require-description.js +170 -132
- 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 +81 -51
- package/{typings → cjs}/rules/require-id-when-available.d.ts +12 -4
- package/cjs/rules/require-id-when-available.js +196 -173
- package/cjs/rules/require-import-fragment.d.ts +12 -0
- package/cjs/rules/require-import-fragment.js +138 -88
- package/cjs/rules/require-nullable-fields-with-oneof.d.ts +12 -0
- package/cjs/rules/require-nullable-fields-with-oneof.js +80 -50
- package/cjs/rules/require-nullable-result-in-root.d.ts +12 -0
- package/cjs/rules/require-nullable-result-in-root.js +97 -68
- package/cjs/rules/require-type-pattern-with-oneof.d.ts +12 -0
- package/cjs/rules/require-type-pattern-with-oneof.js +70 -42
- package/{typings → cjs}/rules/selection-set-depth.d.ts +12 -4
- package/cjs/rules/selection-set-depth.js +147 -107
- package/{typings → cjs}/rules/strict-id-in-types.d.ts +12 -4
- package/cjs/rules/strict-id-in-types.js +143 -122
- package/cjs/rules/unique-fragment-name.d.ts +13 -0
- package/cjs/rules/unique-fragment-name.js +88 -62
- package/cjs/rules/unique-operation-name.d.ts +12 -0
- package/cjs/rules/unique-operation-name.js +65 -35
- package/cjs/schema.d.ts +12 -0
- package/cjs/schema.js +62 -30
- package/cjs/siblings.d.ts +8 -0
- package/cjs/siblings.js +124 -106
- package/cjs/testkit.d.ts +8 -0
- package/cjs/testkit.js +165 -144
- package/cjs/types-e3367e3c.d.ts +129 -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 +181 -124
- package/{typings/cache.d.cts → esm/cache.d.mts} +3 -1
- package/esm/cache.js +25 -23
- package/{typings/configs/index.d.cts → esm/configs/index.d.mts} +3 -1
- package/esm/configs/index.js +14 -11
- package/{typings/configs/operations-all.d.cts → esm/configs/operations-all.d.mts} +2 -1
- package/esm/configs/operations-all.js +28 -28
- package/{typings/configs/operations-recommended.d.cts → esm/configs/operations-recommended.d.mts} +2 -1
- package/esm/configs/operations-recommended.js +53 -53
- package/{typings/configs/relay.d.cts → esm/configs/relay.d.mts} +2 -1
- package/esm/configs/relay.js +12 -9
- package/{typings/configs/schema-all.d.cts → esm/configs/schema-all.d.mts} +2 -1
- package/esm/configs/schema-all.js +22 -22
- package/{typings/configs/schema-recommended.d.cts → esm/configs/schema-recommended.d.mts} +2 -1
- package/esm/configs/schema-recommended.js +49 -49
- package/{typings/documents.d.cts → esm/documents.d.mts} +4 -1
- package/esm/documents.js +41 -39
- package/esm/estree-converter/converter.d.mts +8 -0
- package/esm/estree-converter/converter.js +63 -57
- package/esm/estree-converter/index.d.mts +8 -0
- package/esm/estree-converter/index.js +3 -3
- package/{typings/estree-converter/types.d.cts → esm/estree-converter/types.d.mts} +7 -5
- package/esm/estree-converter/utils.d.mts +18 -0
- package/esm/estree-converter/utils.js +102 -93
- package/{typings/flat-configs.d.cts → esm/flat-configs.d.mts} +13 -2
- package/esm/flat-configs.js +33 -30
- package/esm/graphql-config.d.mts +13 -0
- package/esm/graphql-config.js +49 -44
- package/esm/index.d.mts +22 -0
- package/esm/index.js +18 -9
- package/esm/package.json +1 -1
- package/esm/parser.d.mts +12 -0
- package/esm/parser.js +64 -73
- package/esm/processor.d.mts +9 -0
- package/esm/processor.js +98 -86
- package/{typings/rules/alphabetize.d.cts → esm/rules/alphabetize.d.mts} +12 -4
- package/esm/rules/alphabetize.js +304 -290
- package/{typings/rules/description-style.d.cts → esm/rules/description-style.d.mts} +12 -4
- package/esm/rules/description-style.js +73 -64
- package/esm/rules/graphql-js-validation.d.mts +12 -0
- package/esm/rules/graphql-js-validation.js +580 -429
- package/esm/rules/index.d.mts +125 -0
- package/esm/rules/index.js +74 -74
- package/{typings/rules/input-name.d.cts → esm/rules/input-name.d.mts} +12 -4
- package/esm/rules/input-name.js +132 -121
- package/{typings/rules/lone-executable-definition.d.cts → esm/rules/lone-executable-definition.d.mts} +12 -4
- package/esm/rules/lone-executable-definition.js +78 -70
- package/{typings/rules/match-document-filename.d.cts → esm/rules/match-document-filename.d.mts} +14 -6
- package/esm/rules/match-document-filename.js +210 -180
- package/{typings/rules/naming-convention.d.cts → esm/rules/naming-convention.d.mts} +12 -4
- package/esm/rules/naming-convention.js +363 -314
- package/esm/rules/no-anonymous-operations.d.mts +12 -0
- package/esm/rules/no-anonymous-operations.js +65 -55
- package/esm/rules/no-case-insensitive-enum-values-duplicates.d.mts +12 -0
- package/esm/rules/no-case-insensitive-enum-values-duplicates.js +59 -48
- package/esm/rules/no-deprecated.d.mts +12 -0
- package/esm/rules/no-deprecated.js +83 -73
- package/esm/rules/no-duplicate-fields.d.mts +12 -0
- package/esm/rules/no-duplicate-fields.js +93 -80
- package/esm/rules/no-hashtag-description.d.mts +13 -0
- package/esm/rules/no-hashtag-description.js +95 -80
- package/esm/rules/no-one-place-fragments.d.mts +12 -0
- package/esm/rules/no-one-place-fragments.js +65 -56
- package/{typings/rules/no-root-type.d.cts → esm/rules/no-root-type.d.mts} +12 -4
- package/esm/rules/no-root-type.js +78 -72
- package/esm/rules/no-scalar-result-type-on-mutation.d.mts +12 -0
- package/esm/rules/no-scalar-result-type-on-mutation.js +67 -58
- package/esm/rules/no-typename-prefix.d.mts +12 -0
- package/esm/rules/no-typename-prefix.js +65 -53
- package/esm/rules/no-unreachable-types.d.mts +12 -0
- package/esm/rules/no-unreachable-types.js +141 -131
- package/esm/rules/no-unused-fields.d.mts +12 -0
- package/esm/rules/no-unused-fields.js +94 -90
- package/{typings/rules/relay-arguments.d.cts → esm/rules/relay-arguments.d.mts} +12 -4
- package/esm/rules/relay-arguments.js +113 -108
- package/esm/rules/relay-connection-types.d.mts +13 -0
- package/esm/rules/relay-connection-types.js +98 -91
- package/{typings/rules/relay-edge-types.d.cts → esm/rules/relay-edge-types.d.mts} +12 -4
- package/esm/rules/relay-edge-types.js +178 -177
- package/esm/rules/relay-page-info.d.mts +12 -0
- package/esm/rules/relay-page-info.js +84 -86
- package/{typings/rules/require-deprecation-date.d.cts → esm/rules/require-deprecation-date.d.mts} +12 -4
- package/esm/rules/require-deprecation-date.js +120 -110
- package/esm/rules/require-deprecation-reason.d.mts +12 -0
- package/esm/rules/require-deprecation-reason.js +57 -44
- package/{typings/rules/require-description.d.cts → esm/rules/require-description.d.mts} +13 -5
- package/esm/rules/require-description.js +151 -130
- 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 +58 -49
- package/{typings/rules/require-id-when-available.d.cts → esm/rules/require-id-when-available.d.mts} +12 -4
- package/esm/rules/require-id-when-available.js +186 -171
- package/esm/rules/require-import-fragment.d.mts +12 -0
- package/esm/rules/require-import-fragment.js +105 -85
- package/esm/rules/require-nullable-fields-with-oneof.d.mts +12 -0
- package/esm/rules/require-nullable-fields-with-oneof.js +57 -48
- package/esm/rules/require-nullable-result-in-root.d.mts +12 -0
- package/esm/rules/require-nullable-result-in-root.js +74 -66
- package/esm/rules/require-type-pattern-with-oneof.d.mts +12 -0
- package/esm/rules/require-type-pattern-with-oneof.js +47 -40
- package/{typings/rules/selection-set-depth.d.cts → esm/rules/selection-set-depth.d.mts} +12 -4
- package/esm/rules/selection-set-depth.js +114 -104
- package/{typings/rules/strict-id-in-types.d.cts → esm/rules/strict-id-in-types.d.mts} +12 -4
- package/esm/rules/strict-id-in-types.js +125 -119
- package/esm/rules/unique-fragment-name.d.mts +13 -0
- package/esm/rules/unique-fragment-name.js +65 -60
- package/esm/rules/unique-operation-name.d.mts +12 -0
- package/esm/rules/unique-operation-name.js +42 -33
- package/esm/schema.d.mts +12 -0
- package/esm/schema.js +29 -26
- package/esm/siblings.d.mts +8 -0
- package/esm/siblings.js +105 -104
- package/esm/testkit.d.mts +8 -0
- package/esm/testkit.js +132 -141
- package/esm/types-2e1afd7c.d.ts +129 -0
- package/esm/types.d.mts +8 -0
- package/esm/utils.d.mts +44 -0
- package/esm/utils.js +138 -116
- package/package.json +40 -30
- package/typings/estree-converter/converter.d.cts +0 -3
- package/typings/estree-converter/converter.d.ts +0 -3
- package/typings/estree-converter/index.d.cts +0 -3
- package/typings/estree-converter/index.d.ts +0 -3
- package/typings/estree-converter/utils.d.cts +0 -13
- package/typings/estree-converter/utils.d.ts +0 -13
- package/typings/graphql-config.d.cts +0 -4
- package/typings/graphql-config.d.ts +0 -4
- package/typings/index.d.cts +0 -10
- package/typings/index.d.ts +0 -10
- package/typings/parser.d.cts +0 -2
- package/typings/parser.d.ts +0 -2
- package/typings/processor.d.cts +0 -6
- package/typings/processor.d.ts +0 -6
- package/typings/rules/graphql-js-validation.d.cts +0 -2
- package/typings/rules/graphql-js-validation.d.ts +0 -2
- package/typings/rules/index.d.cts +0 -111
- package/typings/rules/index.d.ts +0 -111
- package/typings/rules/no-anonymous-operations.d.cts +0 -2
- package/typings/rules/no-anonymous-operations.d.ts +0 -2
- package/typings/rules/no-case-insensitive-enum-values-duplicates.d.cts +0 -2
- package/typings/rules/no-case-insensitive-enum-values-duplicates.d.ts +0 -2
- package/typings/rules/no-deprecated.d.cts +0 -2
- package/typings/rules/no-deprecated.d.ts +0 -2
- package/typings/rules/no-duplicate-fields.d.cts +0 -2
- package/typings/rules/no-duplicate-fields.d.ts +0 -2
- package/typings/rules/no-hashtag-description.d.cts +0 -3
- package/typings/rules/no-hashtag-description.d.ts +0 -3
- package/typings/rules/no-one-place-fragments.d.cts +0 -2
- package/typings/rules/no-one-place-fragments.d.ts +0 -2
- package/typings/rules/no-scalar-result-type-on-mutation.d.cts +0 -2
- package/typings/rules/no-scalar-result-type-on-mutation.d.ts +0 -2
- package/typings/rules/no-typename-prefix.d.cts +0 -2
- package/typings/rules/no-typename-prefix.d.ts +0 -2
- package/typings/rules/no-unreachable-types.d.cts +0 -2
- package/typings/rules/no-unreachable-types.d.ts +0 -2
- package/typings/rules/no-unused-fields.d.cts +0 -2
- package/typings/rules/no-unused-fields.d.ts +0 -2
- package/typings/rules/relay-connection-types.d.cts +0 -4
- package/typings/rules/relay-connection-types.d.ts +0 -4
- package/typings/rules/relay-page-info.d.cts +0 -2
- package/typings/rules/relay-page-info.d.ts +0 -2
- package/typings/rules/require-deprecation-reason.d.cts +0 -2
- package/typings/rules/require-deprecation-reason.d.ts +0 -2
- package/typings/rules/require-field-of-type-query-in-mutation-result.d.cts +0 -2
- package/typings/rules/require-field-of-type-query-in-mutation-result.d.ts +0 -2
- package/typings/rules/require-import-fragment.d.cts +0 -2
- package/typings/rules/require-import-fragment.d.ts +0 -2
- package/typings/rules/require-nullable-fields-with-oneof.d.cts +0 -2
- package/typings/rules/require-nullable-fields-with-oneof.d.ts +0 -2
- package/typings/rules/require-nullable-result-in-root.d.cts +0 -2
- package/typings/rules/require-nullable-result-in-root.d.ts +0 -2
- package/typings/rules/require-type-pattern-with-oneof.d.cts +0 -2
- package/typings/rules/require-type-pattern-with-oneof.d.ts +0 -2
- package/typings/rules/unique-fragment-name.d.cts +0 -5
- package/typings/rules/unique-fragment-name.d.ts +0 -5
- package/typings/rules/unique-operation-name.d.cts +0 -2
- package/typings/rules/unique-operation-name.d.ts +0 -2
- package/typings/schema.d.cts +0 -3
- package/typings/schema.d.ts +0 -3
- package/typings/siblings.d.cts +0 -22
- package/typings/siblings.d.ts +0 -22
- package/typings/testkit.d.cts +0 -29
- package/typings/testkit.d.ts +0 -29
- package/typings/types.d.cts +0 -83
- package/typings/types.d.ts +0 -83
- package/typings/utils.d.cts +0 -40
- package/typings/utils.d.ts +0 -40
package/esm/siblings.js
CHANGED
@@ -1,109 +1,110 @@
|
|
1
|
-
import { parseGraphQLSDL } from
|
2
|
-
import {
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
1
|
+
import { parseGraphQLSDL } from "@graphql-tools/utils";
|
2
|
+
import {
|
3
|
+
Kind,
|
4
|
+
visit
|
5
|
+
} from "graphql";
|
6
|
+
import { getDocuments } from "./documents.js";
|
7
|
+
import { logger } from "./utils.js";
|
8
|
+
const siblingOperationsCache = /* @__PURE__ */ new Map();
|
9
|
+
function getSiblings(project, documents) {
|
10
|
+
const siblings = project ? getDocuments(project) : typeof documents === "string" ? [parseGraphQLSDL("operation.graphql", documents, { noLocation: true })] : [];
|
11
|
+
if (siblings.length === 0) {
|
12
|
+
let printed = false;
|
13
|
+
const noopWarn = () => {
|
14
|
+
if (!printed) {
|
15
|
+
logger.warn(
|
16
|
+
'getSiblingOperations was called without any operations. Make sure to set "parserOptions.operations" to make this feature available!'
|
17
|
+
);
|
18
|
+
printed = true;
|
19
|
+
}
|
20
|
+
return [];
|
21
|
+
};
|
22
|
+
return {
|
23
|
+
available: false,
|
24
|
+
getFragment: noopWarn,
|
25
|
+
getFragments: noopWarn,
|
26
|
+
getFragmentByType: noopWarn,
|
27
|
+
getFragmentsInUse: noopWarn,
|
28
|
+
getOperation: noopWarn,
|
29
|
+
getOperations: noopWarn,
|
30
|
+
getOperationByType: noopWarn
|
31
|
+
};
|
32
|
+
}
|
33
|
+
const value = siblingOperationsCache.get(siblings);
|
34
|
+
if (value) {
|
35
|
+
return value;
|
36
|
+
}
|
37
|
+
let fragmentsCache = null;
|
38
|
+
const getFragments = () => {
|
39
|
+
if (fragmentsCache === null) {
|
40
|
+
const result = [];
|
41
|
+
for (const source of siblings) {
|
42
|
+
for (const definition of source.document?.definitions || []) {
|
43
|
+
if (definition.kind === Kind.FRAGMENT_DEFINITION) {
|
44
|
+
result.push({
|
45
|
+
filePath: source.location,
|
46
|
+
document: definition
|
47
|
+
});
|
48
|
+
}
|
49
|
+
}
|
50
|
+
}
|
51
|
+
fragmentsCache = result;
|
31
52
|
}
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
if (
|
37
|
-
|
53
|
+
return fragmentsCache;
|
54
|
+
};
|
55
|
+
let cachedOperations = null;
|
56
|
+
const getOperations = () => {
|
57
|
+
if (cachedOperations === null) {
|
58
|
+
const result = [];
|
59
|
+
for (const source of siblings) {
|
60
|
+
for (const definition of source.document?.definitions || []) {
|
61
|
+
if (definition.kind === Kind.OPERATION_DEFINITION) {
|
62
|
+
result.push({
|
63
|
+
filePath: source.location,
|
64
|
+
document: definition
|
65
|
+
});
|
66
|
+
}
|
67
|
+
}
|
68
|
+
}
|
69
|
+
cachedOperations = result;
|
38
70
|
}
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
}
|
53
|
-
}
|
54
|
-
fragmentsCache = result;
|
71
|
+
return cachedOperations;
|
72
|
+
};
|
73
|
+
const getFragment = (name) => getFragments().filter((f) => f.document.name.value === name);
|
74
|
+
const collectFragments = (selectable, recursive, collected = /* @__PURE__ */ new Map()) => {
|
75
|
+
visit(selectable, {
|
76
|
+
FragmentSpread(spread) {
|
77
|
+
const fragmentName = spread.name.value;
|
78
|
+
const [fragment] = getFragment(fragmentName);
|
79
|
+
if (!fragment) {
|
80
|
+
logger.warn(
|
81
|
+
`Unable to locate fragment named "${fragmentName}", please make sure it's loaded using "parserOptions.operations"`
|
82
|
+
);
|
83
|
+
return;
|
55
84
|
}
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
if (cachedOperations === null) {
|
62
|
-
const result = [];
|
63
|
-
for (const source of siblings) {
|
64
|
-
for (const definition of ((_a = source.document) === null || _a === void 0 ? void 0 : _a.definitions) || []) {
|
65
|
-
if (definition.kind === Kind.OPERATION_DEFINITION) {
|
66
|
-
result.push({
|
67
|
-
filePath: source.location,
|
68
|
-
document: definition,
|
69
|
-
});
|
70
|
-
}
|
71
|
-
}
|
72
|
-
}
|
73
|
-
cachedOperations = result;
|
85
|
+
if (!collected.has(fragmentName)) {
|
86
|
+
collected.set(fragmentName, fragment.document);
|
87
|
+
if (recursive) {
|
88
|
+
collectFragments(fragment.document, recursive, collected);
|
89
|
+
}
|
74
90
|
}
|
75
|
-
|
76
|
-
};
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
}
|
92
|
-
}
|
93
|
-
},
|
94
|
-
});
|
95
|
-
return collected;
|
96
|
-
};
|
97
|
-
const siblingOperations = {
|
98
|
-
available: true,
|
99
|
-
getFragment,
|
100
|
-
getFragments,
|
101
|
-
getFragmentByType: typeName => getFragments().filter(f => f.document.typeCondition.name.value === typeName),
|
102
|
-
getFragmentsInUse: (selectable, recursive = true) => Array.from(collectFragments(selectable, recursive).values()),
|
103
|
-
getOperation: name => getOperations().filter(o => { var _a; return ((_a = o.document.name) === null || _a === void 0 ? void 0 : _a.value) === name; }),
|
104
|
-
getOperations,
|
105
|
-
getOperationByType: type => getOperations().filter(o => o.document.operation === type),
|
106
|
-
};
|
107
|
-
siblingOperationsCache.set(siblings, siblingOperations);
|
108
|
-
return siblingOperations;
|
91
|
+
}
|
92
|
+
});
|
93
|
+
return collected;
|
94
|
+
};
|
95
|
+
const siblingOperations = {
|
96
|
+
available: true,
|
97
|
+
getFragment,
|
98
|
+
getFragments,
|
99
|
+
getFragmentByType: (typeName) => getFragments().filter((f) => f.document.typeCondition.name.value === typeName),
|
100
|
+
getFragmentsInUse: (selectable, recursive = true) => Array.from(collectFragments(selectable, recursive).values()),
|
101
|
+
getOperation: (name) => getOperations().filter((o) => o.document.name?.value === name),
|
102
|
+
getOperations,
|
103
|
+
getOperationByType: (type) => getOperations().filter((o) => o.document.operation === type)
|
104
|
+
};
|
105
|
+
siblingOperationsCache.set(siblings, siblingOperations);
|
106
|
+
return siblingOperations;
|
109
107
|
}
|
108
|
+
export {
|
109
|
+
getSiblings
|
110
|
+
};
|
@@ -0,0 +1,8 @@
|
|
1
|
+
import 'eslint';
|
2
|
+
import 'graphql';
|
3
|
+
import './estree-converter/types.mjs';
|
4
|
+
export { G as GraphQLESLintRuleListener, b as GraphQLInvalidTestCase, c as GraphQLRuleTester, a as GraphQLValidTestCase } from './types-2e1afd7c.js';
|
5
|
+
import 'estree';
|
6
|
+
import '@graphql-tools/utils';
|
7
|
+
import 'graphql-config';
|
8
|
+
import 'json-schema-to-ts';
|
package/esm/testkit.js
CHANGED
@@ -1,160 +1,151 @@
|
|
1
1
|
import { createRequire } from 'module';
|
2
2
|
const require = createRequire(import.meta.url);
|
3
|
-
import { readFileSync } from
|
4
|
-
import { resolve } from
|
5
|
-
import { codeFrameColumns } from
|
6
|
-
import { Linter, RuleTester } from
|
3
|
+
import { readFileSync } from "fs";
|
4
|
+
import { resolve } from "path";
|
5
|
+
import { codeFrameColumns } from "@babel/code-frame";
|
6
|
+
import { Linter, RuleTester } from "eslint";
|
7
7
|
function indentCode(code, indent = 4) {
|
8
|
-
|
8
|
+
return code.replace(/^/gm, " ".repeat(indent));
|
9
9
|
}
|
10
|
-
// A simple version of `SourceCodeFixer.applyFixes`
|
11
|
-
// https://github.com/eslint/eslint/issues/14936#issuecomment-906746754
|
12
10
|
function applyFix(code, { range, text }) {
|
13
|
-
|
11
|
+
return [code.slice(0, range[0]), text, code.slice(range[1])].join("");
|
14
12
|
}
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
const
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
messageForSnapshot.push(printWithIndex('#### ❌ Error', index, messages.length), indentCode(codeWithMessage));
|
77
|
-
// Don't print suggestions in snapshots for too big codes
|
78
|
-
if (message.suggestions && (code.match(/\n/g) || '').length < 1000) {
|
79
|
-
for (const [i, suggestion] of message.suggestions.entries()) {
|
80
|
-
const title = printWithIndex('#### 💡 Suggestion', i, message.suggestions.length, suggestion.desc);
|
81
|
-
const output = applyFix(code, suggestion.fix);
|
82
|
-
const codeFrame = printCode(output, { line: 0, column: 0 });
|
83
|
-
messageForSnapshot.push(title, indentCode(codeFrame, 2));
|
84
|
-
}
|
85
|
-
}
|
86
|
-
}
|
87
|
-
if (rule.meta.fixable) {
|
88
|
-
const { fixed, output } = linter.verifyAndFix(code, verifyConfig, filename);
|
89
|
-
if (fixed) {
|
90
|
-
messageForSnapshot.push('#### 🔧 Autofix output', indentCode(printCode(output)));
|
91
|
-
}
|
92
|
-
}
|
93
|
-
it(name || `Invalid #${idx + 1}`, () => {
|
94
|
-
expect(messageForSnapshot.join('\n\n')).toMatchSnapshot();
|
95
|
-
});
|
13
|
+
class GraphQLRuleTester extends RuleTester {
|
14
|
+
constructor(parserOptions = {}) {
|
15
|
+
const config = {
|
16
|
+
parser: require.resolve("@graphql-eslint/eslint-plugin"),
|
17
|
+
parserOptions: {
|
18
|
+
...parserOptions,
|
19
|
+
skipGraphQLConfig: true
|
20
|
+
}
|
21
|
+
};
|
22
|
+
super(config);
|
23
|
+
this.config = config;
|
24
|
+
}
|
25
|
+
fromMockFile(path) {
|
26
|
+
return readFileSync(resolve(__dirname, `../tests/mocks/${path}`), "utf-8");
|
27
|
+
}
|
28
|
+
runGraphQLTests(ruleId, rule, tests) {
|
29
|
+
super.run(ruleId, rule, tests);
|
30
|
+
const linter = new Linter();
|
31
|
+
linter.defineRule(ruleId, rule);
|
32
|
+
const hasOnlyTest = [...tests.valid, ...tests.invalid].some(
|
33
|
+
(t) => typeof t !== "string" && t.only
|
34
|
+
);
|
35
|
+
for (const [idx, testCase] of tests.invalid.entries()) {
|
36
|
+
const { only, filename, options, name } = testCase;
|
37
|
+
if (hasOnlyTest && !only) {
|
38
|
+
continue;
|
39
|
+
}
|
40
|
+
const code = removeTrailingBlankLines(testCase.code);
|
41
|
+
const verifyConfig = getVerifyConfig(ruleId, this.config, testCase);
|
42
|
+
defineParser(linter, verifyConfig.parser);
|
43
|
+
const messages = linter.verify(code, verifyConfig, filename);
|
44
|
+
if (messages.length === 0) {
|
45
|
+
throw new Error("Invalid case should have at least one error.");
|
46
|
+
}
|
47
|
+
const codeFrame = indentCode(printCode(code, { line: 0, column: 0 }));
|
48
|
+
const messageForSnapshot = ["#### \u2328\uFE0F Code", codeFrame];
|
49
|
+
if (options) {
|
50
|
+
const opts = JSON.stringify(options, null, 2).slice(1, -1);
|
51
|
+
messageForSnapshot.push("#### \u2699\uFE0F Options", indentCode(removeTrailingBlankLines(opts), 2));
|
52
|
+
}
|
53
|
+
for (const [index, message] of messages.entries()) {
|
54
|
+
if (message.fatal) {
|
55
|
+
throw new Error(message.message);
|
56
|
+
}
|
57
|
+
const codeWithMessage = printCode(code, message, 1);
|
58
|
+
messageForSnapshot.push(
|
59
|
+
printWithIndex("#### \u274C Error", index, messages.length),
|
60
|
+
indentCode(codeWithMessage)
|
61
|
+
);
|
62
|
+
if (message.suggestions && (code.match(/\n/g) || "").length < 1e3) {
|
63
|
+
for (const [i, suggestion] of message.suggestions.entries()) {
|
64
|
+
const title = printWithIndex(
|
65
|
+
"#### \u{1F4A1} Suggestion",
|
66
|
+
i,
|
67
|
+
message.suggestions.length,
|
68
|
+
suggestion.desc
|
69
|
+
);
|
70
|
+
const output = applyFix(code, suggestion.fix);
|
71
|
+
const codeFrame2 = printCode(output, { line: 0, column: 0 });
|
72
|
+
messageForSnapshot.push(title, indentCode(codeFrame2, 2));
|
73
|
+
}
|
96
74
|
}
|
75
|
+
}
|
76
|
+
if (rule.meta.fixable) {
|
77
|
+
const { fixed, output } = linter.verifyAndFix(code, verifyConfig, filename);
|
78
|
+
if (fixed) {
|
79
|
+
messageForSnapshot.push("#### \u{1F527} Autofix output", indentCode(printCode(output)));
|
80
|
+
}
|
81
|
+
}
|
82
|
+
it(name || `Invalid #${idx + 1}`, () => {
|
83
|
+
expect(messageForSnapshot.join("\n\n")).toMatchSnapshot();
|
84
|
+
});
|
97
85
|
}
|
86
|
+
}
|
98
87
|
}
|
99
88
|
function removeTrailingBlankLines(text) {
|
100
|
-
|
89
|
+
return text.replace(/^\s*\n/, "").trimEnd();
|
101
90
|
}
|
102
91
|
function printWithIndex(title, index, total, description) {
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
92
|
+
if (total > 1) {
|
93
|
+
title += ` ${index + 1}/${total}`;
|
94
|
+
}
|
95
|
+
if (description) {
|
96
|
+
title += `: ${description}`;
|
97
|
+
}
|
98
|
+
return title;
|
110
99
|
}
|
111
100
|
function getVerifyConfig(ruleId, testerConfig, testCase) {
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
101
|
+
const { parser = testerConfig.parser, parserOptions, options } = testCase;
|
102
|
+
return {
|
103
|
+
...testerConfig,
|
104
|
+
parser,
|
105
|
+
parserOptions: {
|
106
|
+
...testerConfig.parserOptions,
|
107
|
+
...parserOptions
|
108
|
+
},
|
109
|
+
rules: {
|
110
|
+
[ruleId]: Array.isArray(options) ? ["error", ...options] : "error"
|
111
|
+
}
|
112
|
+
};
|
124
113
|
}
|
125
|
-
const parsers = new WeakMap();
|
114
|
+
const parsers = /* @__PURE__ */ new WeakMap();
|
126
115
|
function defineParser(linter, parser) {
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
}
|
116
|
+
if (!parser) {
|
117
|
+
return;
|
118
|
+
}
|
119
|
+
if (!parsers.has(linter)) {
|
120
|
+
parsers.set(linter, /* @__PURE__ */ new Set());
|
121
|
+
}
|
122
|
+
const defined = parsers.get(linter);
|
123
|
+
if (!defined.has(parser)) {
|
124
|
+
defined.add(parser);
|
125
|
+
linter.defineParser(parser, require(parser));
|
126
|
+
}
|
139
127
|
}
|
140
128
|
function printCode(code, result = {}, linesOffset = Number.POSITIVE_INFINITY) {
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
129
|
+
const { line, column, endLine, endColumn, message } = result;
|
130
|
+
const location = {};
|
131
|
+
if (typeof line === "number" && typeof column === "number") {
|
132
|
+
location.start = {
|
133
|
+
line,
|
134
|
+
column
|
135
|
+
};
|
136
|
+
}
|
137
|
+
if (typeof endLine === "number" && typeof endColumn === "number") {
|
138
|
+
location.end = {
|
139
|
+
line: endLine,
|
140
|
+
column: endColumn
|
141
|
+
};
|
142
|
+
}
|
143
|
+
return codeFrameColumns(code, location, {
|
144
|
+
linesAbove: linesOffset,
|
145
|
+
linesBelow: linesOffset,
|
146
|
+
message
|
147
|
+
});
|
160
148
|
}
|
149
|
+
export {
|
150
|
+
GraphQLRuleTester
|
151
|
+
};
|
@@ -0,0 +1,129 @@
|
|
1
|
+
import { GraphQLParseOptions } from '@graphql-tools/utils';
|
2
|
+
import { RuleTester, Linter, Rule, AST } from 'eslint';
|
3
|
+
import * as ESTree from 'estree';
|
4
|
+
import { FragmentDefinitionNode, OperationDefinitionNode, SelectionSetNode, OperationTypeNode, ASTKindToNode, GraphQLSchema } from 'graphql';
|
5
|
+
import { GraphQLProjectConfig, IExtensions, IGraphQLProject } from 'graphql-config';
|
6
|
+
import { JSONSchema } from 'json-schema-to-ts';
|
7
|
+
import { GraphQLESTreeNode } from './estree-converter/types.mjs';
|
8
|
+
|
9
|
+
type FragmentSource = {
|
10
|
+
filePath: string;
|
11
|
+
document: FragmentDefinitionNode;
|
12
|
+
};
|
13
|
+
type OperationSource = {
|
14
|
+
filePath: string;
|
15
|
+
document: OperationDefinitionNode;
|
16
|
+
};
|
17
|
+
type SiblingOperations = {
|
18
|
+
available: boolean;
|
19
|
+
getFragment(fragmentName: string): FragmentSource[];
|
20
|
+
getFragments(): FragmentSource[];
|
21
|
+
getFragmentByType(typeName: string): FragmentSource[];
|
22
|
+
getFragmentsInUse(baseOperation: FragmentDefinitionNode | OperationDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
|
23
|
+
getOperation(operationName: string): OperationSource[];
|
24
|
+
getOperations(): OperationSource[];
|
25
|
+
getOperationByType(operationType: OperationTypeNode): OperationSource[];
|
26
|
+
};
|
27
|
+
declare function getSiblings(project?: GraphQLProjectConfig, documents?: ParserOptions['documents']): SiblingOperations;
|
28
|
+
|
29
|
+
type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = Record<string, any> & {
|
30
|
+
[K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
|
31
|
+
};
|
32
|
+
type GraphQLValidTestCase<Options = []> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
|
33
|
+
options?: Options;
|
34
|
+
parserOptions?: Omit<ParserOptions, 'filePath'>;
|
35
|
+
};
|
36
|
+
type GraphQLInvalidTestCase<T = []> = GraphQLValidTestCase<T> & {
|
37
|
+
errors: (RuleTester.TestCaseError | string)[] | number;
|
38
|
+
output?: string | null;
|
39
|
+
};
|
40
|
+
type RuleTesterConfig = {
|
41
|
+
parser: string;
|
42
|
+
parserOptions: Omit<ParserOptions, 'filePath'>;
|
43
|
+
};
|
44
|
+
declare class GraphQLRuleTester extends RuleTester {
|
45
|
+
config: RuleTesterConfig;
|
46
|
+
constructor(parserOptions?: Omit<ParserOptions, 'filePath'>);
|
47
|
+
fromMockFile(path: string): string;
|
48
|
+
runGraphQLTests<Options, WithTypeInfo extends boolean = false>(ruleId: string, rule: GraphQLESLintRule<Options, WithTypeInfo>, tests: {
|
49
|
+
valid: (GraphQLValidTestCase<Options> | string)[];
|
50
|
+
invalid: GraphQLInvalidTestCase<Options>[];
|
51
|
+
}): void;
|
52
|
+
}
|
53
|
+
|
54
|
+
type Schema = GraphQLSchema | null;
|
55
|
+
type Pointer = string | string[];
|
56
|
+
interface ParserOptions {
|
57
|
+
schema?: Pointer | Record<string, {
|
58
|
+
headers: Record<string, string>;
|
59
|
+
}>;
|
60
|
+
documents?: Pointer;
|
61
|
+
extensions?: IExtensions;
|
62
|
+
include?: Pointer;
|
63
|
+
exclude?: Pointer;
|
64
|
+
projects?: Record<string, IGraphQLProject>;
|
65
|
+
schemaOptions?: Omit<GraphQLParseOptions, 'assumeValidSDL'> & {
|
66
|
+
headers: Record<string, string>;
|
67
|
+
};
|
68
|
+
graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
|
69
|
+
skipGraphQLConfig?: boolean;
|
70
|
+
filePath: string;
|
71
|
+
/** @deprecated Use `documents` instead */
|
72
|
+
operations?: Pointer;
|
73
|
+
}
|
74
|
+
type ParserServices = {
|
75
|
+
schema: Schema;
|
76
|
+
siblingOperations: SiblingOperations;
|
77
|
+
};
|
78
|
+
type GraphQLESLintParseResult = Linter.ESLintParseResult & {
|
79
|
+
services: ParserServices;
|
80
|
+
};
|
81
|
+
type Location = AST.SourceLocation | ESTree.Position;
|
82
|
+
type ReportDescriptorLocation = {
|
83
|
+
loc: Location;
|
84
|
+
} | {
|
85
|
+
node: {
|
86
|
+
loc: Location;
|
87
|
+
};
|
88
|
+
};
|
89
|
+
type ReportDescriptor = ReportDescriptorLocation & Rule.ReportDescriptorMessage & Rule.ReportDescriptorOptions;
|
90
|
+
type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleContext, 'options' | 'parserServices' | 'report'> & {
|
91
|
+
options: Options;
|
92
|
+
parserServices: ParserServices;
|
93
|
+
report(descriptor: ReportDescriptor): void;
|
94
|
+
};
|
95
|
+
type CategoryType = 'Operations' | 'Schema';
|
96
|
+
type RuleMetaDataDocs = Required<Rule.RuleMetaData>['docs'];
|
97
|
+
type RuleDocsInfo<T> = Omit<RuleMetaDataDocs, 'category' | 'suggestion'> & {
|
98
|
+
category: CategoryType | CategoryType[];
|
99
|
+
requiresSchema?: true;
|
100
|
+
requiresSiblings?: true;
|
101
|
+
examples?: {
|
102
|
+
title: string;
|
103
|
+
code: string;
|
104
|
+
usage?: T;
|
105
|
+
}[];
|
106
|
+
configOptions?: T | {
|
107
|
+
schema?: T;
|
108
|
+
operations?: T;
|
109
|
+
};
|
110
|
+
graphQLJSRuleName?: string;
|
111
|
+
isDisabledForAllConfig?: true;
|
112
|
+
};
|
113
|
+
type GraphQLESLintRule<Options = [], WithTypeInfo extends boolean = false> = {
|
114
|
+
meta: Omit<Rule.RuleMetaData, 'docs' | 'schema'> & {
|
115
|
+
docs?: RuleDocsInfo<Options>;
|
116
|
+
schema: Readonly<JSONSchema> | [];
|
117
|
+
};
|
118
|
+
create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
|
119
|
+
};
|
120
|
+
type ValueOf<T> = T[keyof T];
|
121
|
+
type Id<T> = {
|
122
|
+
[P in keyof T]: T[P];
|
123
|
+
} & {};
|
124
|
+
type OmitDistributive<T, K extends PropertyKey> = T extends object ? Id<OmitRecursively<T, K>> : T;
|
125
|
+
type OmitRecursively<T extends object, K extends PropertyKey> = Omit<{
|
126
|
+
[P in keyof T]: OmitDistributive<T[P], K>;
|
127
|
+
}, K>;
|
128
|
+
|
129
|
+
export { CategoryType as C, FragmentSource as F, GraphQLESLintRuleListener as G, OmitRecursively as O, ParserOptions as P, ReportDescriptor as R, Schema as S, ValueOf as V, GraphQLValidTestCase as a, GraphQLInvalidTestCase as b, GraphQLRuleTester as c, Pointer as d, ParserServices as e, GraphQLESLintParseResult as f, GraphQLESLintRuleContext as g, RuleDocsInfo as h, GraphQLESLintRule as i, SiblingOperations as j, OperationSource as k, getSiblings as l };
|