@graphql-eslint/eslint-plugin 3.19.3-alpha-20230702093957-98f7783 → 3.20.0-alpha-20230703154330-0d51273
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
@@ -1,41 +1,70 @@
|
|
1
1
|
"use strict";
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
2
|
+
var __create = Object.create;
|
3
|
+
var __defProp = Object.defineProperty;
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
8
|
+
var __export = (target, all) => {
|
9
|
+
for (var name in all)
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
11
|
+
};
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
14
|
+
for (let key of __getOwnPropNames(from))
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
17
|
+
}
|
18
|
+
return to;
|
19
|
+
};
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
26
|
+
mod
|
27
|
+
));
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
29
|
+
var selection_set_depth_exports = {};
|
30
|
+
__export(selection_set_depth_exports, {
|
31
|
+
rule: () => rule
|
32
|
+
});
|
33
|
+
module.exports = __toCommonJS(selection_set_depth_exports);
|
34
|
+
var import_graphql = require("graphql");
|
35
|
+
var import_graphql_depth_limit = __toESM(require("graphql-depth-limit"));
|
36
|
+
var import_utils = require("../utils.js");
|
37
|
+
const RULE_ID = "selection-set-depth";
|
9
38
|
const schema = {
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
39
|
+
type: "array",
|
40
|
+
minItems: 1,
|
41
|
+
maxItems: 1,
|
42
|
+
items: {
|
43
|
+
type: "object",
|
44
|
+
additionalProperties: false,
|
45
|
+
required: ["maxDepth"],
|
46
|
+
properties: {
|
47
|
+
maxDepth: {
|
48
|
+
type: "number"
|
49
|
+
},
|
50
|
+
ignore: import_utils.ARRAY_DEFAULT_OPTIONS
|
51
|
+
}
|
52
|
+
}
|
24
53
|
};
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
54
|
+
const rule = {
|
55
|
+
meta: {
|
56
|
+
type: "suggestion",
|
57
|
+
hasSuggestions: true,
|
58
|
+
docs: {
|
59
|
+
category: "Operations",
|
60
|
+
description: "Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).",
|
61
|
+
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
62
|
+
requiresSiblings: true,
|
63
|
+
examples: [
|
64
|
+
{
|
65
|
+
title: "Incorrect",
|
66
|
+
usage: [{ maxDepth: 1 }],
|
67
|
+
code: `
|
39
68
|
query deep2 {
|
40
69
|
viewer { # Level 0
|
41
70
|
albums { # Level 1
|
@@ -43,12 +72,12 @@ exports.rule = {
|
|
43
72
|
}
|
44
73
|
}
|
45
74
|
}
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
75
|
+
`
|
76
|
+
},
|
77
|
+
{
|
78
|
+
title: "Correct",
|
79
|
+
usage: [{ maxDepth: 4 }],
|
80
|
+
code: `
|
52
81
|
query deep2 {
|
53
82
|
viewer { # Level 0
|
54
83
|
albums { # Level 1
|
@@ -56,12 +85,12 @@ exports.rule = {
|
|
56
85
|
}
|
57
86
|
}
|
58
87
|
}
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
88
|
+
`
|
89
|
+
},
|
90
|
+
{
|
91
|
+
title: "Correct (ignored field)",
|
92
|
+
usage: [{ maxDepth: 1, ignore: ["albums"] }],
|
93
|
+
code: `
|
65
94
|
query deep2 {
|
66
95
|
viewer { # Level 0
|
67
96
|
albums { # Level 1
|
@@ -69,67 +98,78 @@ exports.rule = {
|
|
69
98
|
}
|
70
99
|
}
|
71
100
|
}
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
},
|
78
|
-
schema,
|
101
|
+
`
|
102
|
+
}
|
103
|
+
],
|
104
|
+
recommended: true,
|
105
|
+
configOptions: [{ maxDepth: 7 }]
|
79
106
|
},
|
80
|
-
|
81
|
-
|
107
|
+
schema
|
108
|
+
},
|
109
|
+
create(context) {
|
110
|
+
let siblings = null;
|
111
|
+
try {
|
112
|
+
siblings = (0, import_utils.requireSiblingsOperations)(RULE_ID, context);
|
113
|
+
} catch {
|
114
|
+
import_utils.logger.warn(
|
115
|
+
`Rule "${RULE_ID}" works best with siblings operations loaded. For more info: https://bit.ly/graphql-eslint-operations`
|
116
|
+
);
|
117
|
+
}
|
118
|
+
const { maxDepth, ignore = [] } = context.options[0];
|
119
|
+
const checkFn = (0, import_graphql_depth_limit.default)(maxDepth, { ignore });
|
120
|
+
return {
|
121
|
+
"OperationDefinition, FragmentDefinition"(node) {
|
82
122
|
try {
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
const foundNode = sourceCode.getNodeByRangeIndex(token.range[0]);
|
119
|
-
const parentNode = foundNode.parent.parent;
|
120
|
-
return fixer.remove(foundNode.kind === 'Name' ? parentNode.parent : parentNode);
|
121
|
-
},
|
122
|
-
},
|
123
|
-
],
|
124
|
-
}),
|
125
|
-
});
|
126
|
-
},
|
127
|
-
});
|
128
|
-
}
|
129
|
-
catch (e) {
|
130
|
-
utils_js_1.logger.warn(`Rule "${RULE_ID}" check failed due to a missing siblings operations. For more info: https://bit.ly/graphql-eslint-operations`, e);
|
123
|
+
const rawNode = node.rawNode();
|
124
|
+
const fragmentsInUse = siblings ? siblings.getFragmentsInUse(rawNode) : [];
|
125
|
+
const document = {
|
126
|
+
kind: import_graphql.Kind.DOCUMENT,
|
127
|
+
definitions: [rawNode, ...fragmentsInUse]
|
128
|
+
};
|
129
|
+
checkFn({
|
130
|
+
getDocument: () => document,
|
131
|
+
reportError(error) {
|
132
|
+
const { line, column } = error.locations[0];
|
133
|
+
const ancestors = context.getAncestors();
|
134
|
+
const token = ancestors[0].tokens.find(
|
135
|
+
(token2) => token2.loc.start.line === line && token2.loc.start.column === column - 1
|
136
|
+
);
|
137
|
+
context.report({
|
138
|
+
loc: {
|
139
|
+
line,
|
140
|
+
column: column - 1
|
141
|
+
},
|
142
|
+
message: error.message,
|
143
|
+
// Don't provide suggestions for fragment that can be in a separate file
|
144
|
+
...token && {
|
145
|
+
suggest: [
|
146
|
+
{
|
147
|
+
desc: "Remove selections",
|
148
|
+
fix(fixer) {
|
149
|
+
const sourceCode = context.getSourceCode();
|
150
|
+
const foundNode = sourceCode.getNodeByRangeIndex(token.range[0]);
|
151
|
+
const parentNode = foundNode.parent.parent;
|
152
|
+
return fixer.remove(
|
153
|
+
foundNode.kind === "Name" ? parentNode.parent : parentNode
|
154
|
+
);
|
155
|
+
}
|
156
|
+
}
|
157
|
+
]
|
131
158
|
}
|
132
|
-
|
133
|
-
|
134
|
-
|
159
|
+
});
|
160
|
+
}
|
161
|
+
});
|
162
|
+
} catch (e) {
|
163
|
+
import_utils.logger.warn(
|
164
|
+
`Rule "${RULE_ID}" check failed due to a missing siblings operations. For more info: https://bit.ly/graphql-eslint-operations`,
|
165
|
+
e
|
166
|
+
);
|
167
|
+
}
|
168
|
+
}
|
169
|
+
};
|
170
|
+
}
|
135
171
|
};
|
172
|
+
// Annotate the CommonJS export names for ESM import in node:
|
173
|
+
0 && (module.exports = {
|
174
|
+
rule
|
175
|
+
});
|
@@ -1,5 +1,12 @@
|
|
1
1
|
import { FromSchema } from 'json-schema-to-ts';
|
2
|
-
import { GraphQLESLintRule } from '../types.js';
|
2
|
+
import { i as GraphQLESLintRule } from '../types-e3367e3c.js';
|
3
|
+
import '@graphql-tools/utils';
|
4
|
+
import 'eslint';
|
5
|
+
import 'estree';
|
6
|
+
import 'graphql';
|
7
|
+
import 'graphql-config';
|
8
|
+
import '../estree-converter/types.js';
|
9
|
+
|
3
10
|
declare const schema: {
|
4
11
|
readonly type: "array";
|
5
12
|
readonly maxItems: 1;
|
@@ -52,6 +59,7 @@ declare const schema: {
|
|
52
59
|
};
|
53
60
|
};
|
54
61
|
};
|
55
|
-
|
56
|
-
|
57
|
-
|
62
|
+
type RuleOptions = FromSchema<typeof schema>;
|
63
|
+
declare const rule: GraphQLESLintRule<RuleOptions>;
|
64
|
+
|
65
|
+
export { RuleOptions, rule };
|
@@ -1,61 +1,83 @@
|
|
1
1
|
"use strict";
|
2
|
-
Object.defineProperty
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
2
|
+
var __defProp = Object.defineProperty;
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
6
|
+
var __export = (target, all) => {
|
7
|
+
for (var name in all)
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
9
|
+
};
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
12
|
+
for (let key of __getOwnPropNames(from))
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
15
|
+
}
|
16
|
+
return to;
|
17
|
+
};
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
19
|
+
var strict_id_in_types_exports = {};
|
20
|
+
__export(strict_id_in_types_exports, {
|
21
|
+
rule: () => rule
|
22
|
+
});
|
23
|
+
module.exports = __toCommonJS(strict_id_in_types_exports);
|
24
|
+
var import_graphql = require("graphql");
|
25
|
+
var import_utils = require("../utils.js");
|
26
|
+
const RULE_ID = "strict-id-in-types";
|
7
27
|
const schema = {
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
28
|
+
type: "array",
|
29
|
+
maxItems: 1,
|
30
|
+
items: {
|
31
|
+
type: "object",
|
32
|
+
additionalProperties: false,
|
33
|
+
properties: {
|
34
|
+
acceptedIdNames: {
|
35
|
+
...import_utils.ARRAY_DEFAULT_OPTIONS,
|
36
|
+
default: ["id"]
|
37
|
+
},
|
38
|
+
acceptedIdTypes: {
|
39
|
+
...import_utils.ARRAY_DEFAULT_OPTIONS,
|
40
|
+
default: ["ID"]
|
41
|
+
},
|
42
|
+
exceptions: {
|
43
|
+
type: "object",
|
12
44
|
additionalProperties: false,
|
13
45
|
properties: {
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
types: {
|
27
|
-
...utils_js_1.ARRAY_DEFAULT_OPTIONS,
|
28
|
-
description: 'This is used to exclude types with names that match one of the specified values.',
|
29
|
-
},
|
30
|
-
suffixes: {
|
31
|
-
...utils_js_1.ARRAY_DEFAULT_OPTIONS,
|
32
|
-
description: 'This is used to exclude types with names with suffixes that match one of the specified values.',
|
33
|
-
},
|
34
|
-
},
|
35
|
-
},
|
36
|
-
},
|
37
|
-
},
|
46
|
+
types: {
|
47
|
+
...import_utils.ARRAY_DEFAULT_OPTIONS,
|
48
|
+
description: "This is used to exclude types with names that match one of the specified values."
|
49
|
+
},
|
50
|
+
suffixes: {
|
51
|
+
...import_utils.ARRAY_DEFAULT_OPTIONS,
|
52
|
+
description: "This is used to exclude types with names with suffixes that match one of the specified values."
|
53
|
+
}
|
54
|
+
}
|
55
|
+
}
|
56
|
+
}
|
57
|
+
}
|
38
58
|
};
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
+
const rule = {
|
60
|
+
meta: {
|
61
|
+
type: "suggestion",
|
62
|
+
docs: {
|
63
|
+
description: "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.",
|
64
|
+
category: "Schema",
|
65
|
+
recommended: true,
|
66
|
+
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
67
|
+
requiresSchema: true,
|
68
|
+
examples: [
|
69
|
+
{
|
70
|
+
title: "Incorrect",
|
71
|
+
usage: [
|
72
|
+
{
|
73
|
+
acceptedIdNames: ["id", "_id"],
|
74
|
+
acceptedIdTypes: ["ID"],
|
75
|
+
exceptions: { suffixes: ["Payload"] }
|
76
|
+
}
|
77
|
+
],
|
78
|
+
code: (
|
79
|
+
/* GraphQL */
|
80
|
+
`
|
59
81
|
# Incorrect field name
|
60
82
|
type InvalidFieldName {
|
61
83
|
key: ID!
|
@@ -76,18 +98,21 @@ exports.rule = {
|
|
76
98
|
id: ID!
|
77
99
|
_id: ID!
|
78
100
|
}
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
101
|
+
`
|
102
|
+
)
|
103
|
+
},
|
104
|
+
{
|
105
|
+
title: "Correct",
|
106
|
+
usage: [
|
107
|
+
{
|
108
|
+
acceptedIdNames: ["id", "_id"],
|
109
|
+
acceptedIdTypes: ["ID"],
|
110
|
+
exceptions: { types: ["Error"], suffixes: ["Payload"] }
|
111
|
+
}
|
112
|
+
],
|
113
|
+
code: (
|
114
|
+
/* GraphQL */
|
115
|
+
`
|
91
116
|
type User {
|
92
117
|
id: ID!
|
93
118
|
}
|
@@ -103,62 +128,58 @@ exports.rule = {
|
|
103
128
|
type Error {
|
104
129
|
message: String!
|
105
130
|
}
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
schema,
|
111
|
-
},
|
112
|
-
create(context) {
|
113
|
-
const options = {
|
114
|
-
acceptedIdNames: ['id'],
|
115
|
-
acceptedIdTypes: ['ID'],
|
116
|
-
exceptions: {},
|
117
|
-
...context.options[0],
|
118
|
-
};
|
119
|
-
const schema = (0, utils_js_1.requireGraphQLSchemaFromContext)(RULE_ID, context);
|
120
|
-
const rootTypeNames = [
|
121
|
-
schema.getQueryType(),
|
122
|
-
schema.getMutationType(),
|
123
|
-
schema.getSubscriptionType(),
|
124
|
-
]
|
125
|
-
.filter(utils_js_1.truthy)
|
126
|
-
.map(type => type.name);
|
127
|
-
const selector = `ObjectTypeDefinition[name.value!=/^(${rootTypeNames.join('|')})$/]`;
|
128
|
-
return {
|
129
|
-
[selector](node) {
|
130
|
-
var _a, _b, _c;
|
131
|
-
const typeName = node.name.value;
|
132
|
-
const shouldIgnoreNode = ((_a = options.exceptions.types) === null || _a === void 0 ? void 0 : _a.includes(typeName)) ||
|
133
|
-
((_b = options.exceptions.suffixes) === null || _b === void 0 ? void 0 : _b.some(suffix => typeName.endsWith(suffix)));
|
134
|
-
if (shouldIgnoreNode) {
|
135
|
-
return;
|
136
|
-
}
|
137
|
-
const validIds = (_c = node.fields) === null || _c === void 0 ? void 0 : _c.filter(field => {
|
138
|
-
const fieldNode = field.rawNode();
|
139
|
-
const isValidIdName = options.acceptedIdNames.includes(fieldNode.name.value);
|
140
|
-
// To be a valid type, it must be non-null and one of the accepted types.
|
141
|
-
let isValidIdType = false;
|
142
|
-
if (fieldNode.type.kind === graphql_1.Kind.NON_NULL_TYPE &&
|
143
|
-
fieldNode.type.type.kind === graphql_1.Kind.NAMED_TYPE) {
|
144
|
-
isValidIdType = options.acceptedIdTypes.includes(fieldNode.type.type.name.value);
|
145
|
-
}
|
146
|
-
return isValidIdName && isValidIdType;
|
147
|
-
});
|
148
|
-
// Usually, there should be only one unique identifier field per type.
|
149
|
-
// Some clients allow multiple fields to be used. If more people need this,
|
150
|
-
// we can extend this rule later.
|
151
|
-
if ((validIds === null || validIds === void 0 ? void 0 : validIds.length) !== 1) {
|
152
|
-
const pluralNamesSuffix = options.acceptedIdNames.length > 1 ? 's' : '';
|
153
|
-
const pluralTypesSuffix = options.acceptedIdTypes.length > 1 ? 's' : '';
|
154
|
-
context.report({
|
155
|
-
node: node.name,
|
156
|
-
message: `${(0, utils_js_1.displayNodeName)(node)} must have exactly one non-nullable unique identifier.
|
157
|
-
Accepted name${pluralNamesSuffix}: ${(0, utils_js_1.englishJoinWords)(options.acceptedIdNames)}.
|
158
|
-
Accepted type${pluralTypesSuffix}: ${(0, utils_js_1.englishJoinWords)(options.acceptedIdTypes)}.`,
|
159
|
-
});
|
160
|
-
}
|
161
|
-
},
|
162
|
-
};
|
131
|
+
`
|
132
|
+
)
|
133
|
+
}
|
134
|
+
]
|
163
135
|
},
|
136
|
+
schema
|
137
|
+
},
|
138
|
+
create(context) {
|
139
|
+
const options = {
|
140
|
+
acceptedIdNames: ["id"],
|
141
|
+
acceptedIdTypes: ["ID"],
|
142
|
+
exceptions: {},
|
143
|
+
...context.options[0]
|
144
|
+
};
|
145
|
+
const schema2 = (0, import_utils.requireGraphQLSchemaFromContext)(RULE_ID, context);
|
146
|
+
const rootTypeNames = [
|
147
|
+
schema2.getQueryType(),
|
148
|
+
schema2.getMutationType(),
|
149
|
+
schema2.getSubscriptionType()
|
150
|
+
].filter(import_utils.truthy).map((type) => type.name);
|
151
|
+
const selector = `ObjectTypeDefinition[name.value!=/^(${rootTypeNames.join("|")})$/]`;
|
152
|
+
return {
|
153
|
+
[selector](node) {
|
154
|
+
const typeName = node.name.value;
|
155
|
+
const shouldIgnoreNode = options.exceptions.types?.includes(typeName) || options.exceptions.suffixes?.some((suffix) => typeName.endsWith(suffix));
|
156
|
+
if (shouldIgnoreNode) {
|
157
|
+
return;
|
158
|
+
}
|
159
|
+
const validIds = node.fields?.filter((field) => {
|
160
|
+
const fieldNode = field.rawNode();
|
161
|
+
const isValidIdName = options.acceptedIdNames.includes(fieldNode.name.value);
|
162
|
+
let isValidIdType = false;
|
163
|
+
if (fieldNode.type.kind === import_graphql.Kind.NON_NULL_TYPE && fieldNode.type.type.kind === import_graphql.Kind.NAMED_TYPE) {
|
164
|
+
isValidIdType = options.acceptedIdTypes.includes(fieldNode.type.type.name.value);
|
165
|
+
}
|
166
|
+
return isValidIdName && isValidIdType;
|
167
|
+
});
|
168
|
+
if (validIds?.length !== 1) {
|
169
|
+
const pluralNamesSuffix = options.acceptedIdNames.length > 1 ? "s" : "";
|
170
|
+
const pluralTypesSuffix = options.acceptedIdTypes.length > 1 ? "s" : "";
|
171
|
+
context.report({
|
172
|
+
node: node.name,
|
173
|
+
message: `${(0, import_utils.displayNodeName)(node)} must have exactly one non-nullable unique identifier.
|
174
|
+
Accepted name${pluralNamesSuffix}: ${(0, import_utils.englishJoinWords)(options.acceptedIdNames)}.
|
175
|
+
Accepted type${pluralTypesSuffix}: ${(0, import_utils.englishJoinWords)(options.acceptedIdTypes)}.`
|
176
|
+
});
|
177
|
+
}
|
178
|
+
}
|
179
|
+
};
|
180
|
+
}
|
164
181
|
};
|
182
|
+
// Annotate the CommonJS export names for ESM import in node:
|
183
|
+
0 && (module.exports = {
|
184
|
+
rule
|
185
|
+
});
|
@@ -0,0 +1,13 @@
|
|
1
|
+
import { ExecutableDefinitionNode } from 'graphql';
|
2
|
+
import { GraphQLESTreeNode } from '../estree-converter/types.js';
|
3
|
+
import { g as GraphQLESLintRuleContext, i as GraphQLESLintRule } from '../types-e3367e3c.js';
|
4
|
+
import 'eslint';
|
5
|
+
import 'estree';
|
6
|
+
import '@graphql-tools/utils';
|
7
|
+
import 'graphql-config';
|
8
|
+
import 'json-schema-to-ts';
|
9
|
+
|
10
|
+
declare const checkNode: (context: GraphQLESLintRuleContext, node: GraphQLESTreeNode<ExecutableDefinitionNode>, ruleId: string) => void;
|
11
|
+
declare const rule: GraphQLESLintRule;
|
12
|
+
|
13
|
+
export { checkNode, rule };
|