@graphql-eslint/eslint-plugin 4.4.0-alpha-20241207210859-41eb4549764dc0314b5bd4f257ea6667b178540e → 4.4.0-alpha-20241210121000-22133a7d66f4a5d831e5588ca0ce4fc789bca4ed
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/cjs/graphql-config.d.cts +1 -2
- package/cjs/index.d.cts +1 -2
- package/cjs/meta.js +1 -1
- package/cjs/parser.d.cts +1 -2
- package/cjs/rules/alphabetize/index.d.cts +1 -1
- package/cjs/rules/alphabetize/index.js +2 -1
- package/cjs/rules/description-style/index.d.cts +1 -1
- package/cjs/rules/description-style/index.js +3 -1
- package/cjs/rules/graphql-js-validation.d.cts +1 -2
- package/cjs/rules/graphql-js-validation.js +31 -30
- package/cjs/rules/index.d.cts +1 -2
- package/cjs/rules/input-name/index.d.cts +1 -1
- package/cjs/rules/input-name/index.js +3 -1
- package/cjs/rules/lone-executable-definition/index.d.cts +1 -1
- package/cjs/rules/lone-executable-definition/index.js +2 -1
- package/cjs/rules/match-document-filename/index.d.cts +1 -1
- package/cjs/rules/match-document-filename/index.js +2 -1
- package/cjs/rules/naming-convention/index.d.cts +1 -1
- package/cjs/rules/naming-convention/index.js +3 -1
- package/cjs/rules/no-anonymous-operations/index.d.cts +1 -2
- package/cjs/rules/no-anonymous-operations/index.js +2 -1
- package/cjs/rules/no-deprecated/index.d.cts +1 -2
- package/cjs/rules/no-deprecated/index.js +2 -1
- package/cjs/rules/no-duplicate-fields/index.d.cts +1 -2
- package/cjs/rules/no-duplicate-fields/index.js +2 -1
- package/cjs/rules/no-hashtag-description/index.d.cts +1 -2
- package/cjs/rules/no-hashtag-description/index.js +2 -1
- package/cjs/rules/no-one-place-fragments/index.d.cts +1 -2
- package/cjs/rules/no-one-place-fragments/index.js +1 -1
- package/cjs/rules/no-root-type/index.d.cts +1 -1
- package/cjs/rules/no-root-type/index.js +3 -1
- package/cjs/rules/no-scalar-result-type-on-mutation/index.d.cts +1 -2
- package/cjs/rules/no-scalar-result-type-on-mutation/index.js +2 -1
- package/cjs/rules/no-typename-prefix/index.d.cts +1 -2
- package/cjs/rules/no-typename-prefix/index.js +2 -1
- package/cjs/rules/no-unreachable-types/index.d.cts +1 -2
- package/cjs/rules/no-unreachable-types/index.js +2 -1
- package/cjs/rules/no-unused-fields/index.d.cts +1 -1
- package/cjs/rules/no-unused-fields/index.js +2 -1
- package/cjs/rules/relay-arguments/index.d.cts +1 -1
- package/cjs/rules/relay-arguments/index.js +1 -1
- package/cjs/rules/relay-connection-types/index.d.cts +1 -2
- package/cjs/rules/relay-connection-types/index.js +1 -1
- package/cjs/rules/relay-edge-types/index.d.cts +1 -1
- package/cjs/rules/relay-edge-types/index.js +1 -1
- package/cjs/rules/relay-page-info/index.d.cts +1 -2
- package/cjs/rules/relay-page-info/index.js +1 -1
- package/cjs/rules/require-deprecation-date/index.d.cts +1 -1
- package/cjs/rules/require-deprecation-date/index.js +2 -1
- package/cjs/rules/require-deprecation-reason/index.d.cts +1 -2
- package/cjs/rules/require-deprecation-reason/index.js +1 -1
- package/cjs/rules/require-description/index.d.cts +1 -1
- package/cjs/rules/require-description/index.js +2 -1
- package/cjs/rules/require-field-of-type-query-in-mutation-result/index.d.cts +1 -2
- package/cjs/rules/require-field-of-type-query-in-mutation-result/index.js +1 -1
- package/cjs/rules/require-import-fragment/index.d.cts +1 -2
- package/cjs/rules/require-import-fragment/index.js +2 -1
- package/cjs/rules/require-nullable-fields-with-oneof/index.d.cts +1 -2
- package/cjs/rules/require-nullable-fields-with-oneof/index.js +1 -1
- package/cjs/rules/require-nullable-result-in-root/index.d.cts +1 -2
- package/cjs/rules/require-nullable-result-in-root/index.js +2 -1
- package/cjs/rules/require-selections/index.d.cts +1 -1
- package/cjs/rules/require-selections/index.js +8 -4
- package/cjs/rules/require-type-pattern-with-oneof/index.d.cts +1 -2
- package/cjs/rules/require-type-pattern-with-oneof/index.js +1 -1
- package/cjs/rules/selection-set-depth/index.d.cts +1 -1
- package/cjs/rules/selection-set-depth/index.js +3 -1
- package/cjs/rules/strict-id-in-types/index.d.cts +1 -1
- package/cjs/rules/strict-id-in-types/index.js +5 -5
- package/cjs/rules/unique-enum-value-names/index.d.cts +1 -2
- package/cjs/rules/unique-enum-value-names/index.js +2 -1
- package/cjs/rules/unique-fragment-name/index.d.cts +0 -1
- package/cjs/rules/unique-fragment-name/index.js +1 -2
- package/cjs/rules/unique-operation-name/index.d.cts +1 -2
- package/cjs/rules/unique-operation-name/index.js +1 -1
- package/cjs/schema.d.cts +1 -2
- package/cjs/types.d.cts +7 -17
- package/cjs/utils.d.cts +2 -2
- package/cjs/utils.js +5 -1
- package/esm/graphql-config.d.ts +1 -2
- package/esm/index.d.ts +0 -1
- package/esm/meta.js +1 -1
- package/esm/parser.d.ts +1 -2
- package/esm/rules/alphabetize/index.d.ts +1 -1
- package/esm/rules/alphabetize/index.js +2 -1
- package/esm/rules/description-style/index.d.ts +1 -1
- package/esm/rules/description-style/index.js +3 -1
- package/esm/rules/graphql-js-validation.d.ts +1 -2
- package/esm/rules/graphql-js-validation.js +31 -30
- package/esm/rules/index.d.ts +0 -1
- package/esm/rules/input-name/index.d.ts +1 -1
- package/esm/rules/input-name/index.js +3 -1
- package/esm/rules/lone-executable-definition/index.d.ts +1 -1
- package/esm/rules/lone-executable-definition/index.js +2 -1
- package/esm/rules/match-document-filename/index.d.ts +1 -1
- package/esm/rules/match-document-filename/index.js +2 -1
- package/esm/rules/naming-convention/index.d.ts +1 -1
- package/esm/rules/naming-convention/index.js +3 -1
- package/esm/rules/no-anonymous-operations/index.d.ts +1 -2
- package/esm/rules/no-anonymous-operations/index.js +2 -1
- package/esm/rules/no-deprecated/index.d.ts +1 -2
- package/esm/rules/no-deprecated/index.js +2 -1
- package/esm/rules/no-duplicate-fields/index.d.ts +1 -2
- package/esm/rules/no-duplicate-fields/index.js +2 -1
- package/esm/rules/no-hashtag-description/index.d.ts +1 -2
- package/esm/rules/no-hashtag-description/index.js +2 -1
- package/esm/rules/no-one-place-fragments/index.d.ts +1 -2
- package/esm/rules/no-one-place-fragments/index.js +1 -1
- package/esm/rules/no-root-type/index.d.ts +1 -1
- package/esm/rules/no-root-type/index.js +3 -1
- package/esm/rules/no-scalar-result-type-on-mutation/index.d.ts +1 -2
- package/esm/rules/no-scalar-result-type-on-mutation/index.js +2 -1
- package/esm/rules/no-typename-prefix/index.d.ts +1 -2
- package/esm/rules/no-typename-prefix/index.js +2 -1
- package/esm/rules/no-unreachable-types/index.d.ts +1 -2
- package/esm/rules/no-unreachable-types/index.js +2 -1
- package/esm/rules/no-unused-fields/index.d.ts +1 -1
- package/esm/rules/no-unused-fields/index.js +2 -1
- package/esm/rules/relay-arguments/index.d.ts +1 -1
- package/esm/rules/relay-arguments/index.js +1 -1
- package/esm/rules/relay-connection-types/index.d.ts +1 -2
- package/esm/rules/relay-connection-types/index.js +1 -1
- package/esm/rules/relay-edge-types/index.d.ts +1 -1
- package/esm/rules/relay-edge-types/index.js +1 -1
- package/esm/rules/relay-page-info/index.d.ts +1 -2
- package/esm/rules/relay-page-info/index.js +1 -1
- package/esm/rules/require-deprecation-date/index.d.ts +1 -1
- package/esm/rules/require-deprecation-date/index.js +2 -1
- package/esm/rules/require-deprecation-reason/index.d.ts +1 -2
- package/esm/rules/require-deprecation-reason/index.js +1 -1
- package/esm/rules/require-description/index.d.ts +1 -1
- package/esm/rules/require-description/index.js +2 -1
- package/esm/rules/require-field-of-type-query-in-mutation-result/index.d.ts +1 -2
- package/esm/rules/require-field-of-type-query-in-mutation-result/index.js +1 -1
- package/esm/rules/require-import-fragment/index.d.ts +1 -2
- package/esm/rules/require-import-fragment/index.js +2 -1
- package/esm/rules/require-nullable-fields-with-oneof/index.d.ts +1 -2
- package/esm/rules/require-nullable-fields-with-oneof/index.js +1 -1
- package/esm/rules/require-nullable-result-in-root/index.d.ts +1 -2
- package/esm/rules/require-nullable-result-in-root/index.js +2 -1
- package/esm/rules/require-selections/index.d.ts +1 -1
- package/esm/rules/require-selections/index.js +8 -4
- package/esm/rules/require-type-pattern-with-oneof/index.d.ts +1 -2
- package/esm/rules/require-type-pattern-with-oneof/index.js +1 -1
- package/esm/rules/selection-set-depth/index.d.ts +1 -1
- package/esm/rules/selection-set-depth/index.js +3 -1
- package/esm/rules/strict-id-in-types/index.d.ts +1 -1
- package/esm/rules/strict-id-in-types/index.js +5 -5
- package/esm/rules/unique-enum-value-names/index.d.ts +1 -2
- package/esm/rules/unique-enum-value-names/index.js +2 -1
- package/esm/rules/unique-fragment-name/index.d.ts +0 -1
- package/esm/rules/unique-fragment-name/index.js +1 -2
- package/esm/rules/unique-operation-name/index.d.ts +1 -2
- package/esm/rules/unique-operation-name/index.js +1 -1
- package/esm/schema.d.ts +1 -2
- package/esm/types.d.ts +7 -17
- package/esm/utils.d.ts +2 -2
- package/esm/utils.js +4 -0
- package/package.json +11 -1
- package/{index.browser.js → programmatic.js} +104 -73
@@ -5,7 +5,7 @@ const rule = {
|
|
5
5
|
meta: {
|
6
6
|
type: "suggestion",
|
7
7
|
docs: {
|
8
|
-
category: "
|
8
|
+
category: "schema",
|
9
9
|
description: "Require `input` or `type` fields to be non-nullable with `@oneOf` directive.",
|
10
10
|
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
11
11
|
examples: [
|
@@ -1,10 +1,9 @@
|
|
1
1
|
import { GraphQLESLintRule } from '../../types.js';
|
2
2
|
import 'eslint';
|
3
|
-
import 'estree';
|
4
3
|
import 'graphql';
|
5
4
|
import 'graphql-config';
|
6
|
-
import 'json-schema-to-ts';
|
7
5
|
import '../../estree-converter/types.js';
|
6
|
+
import 'estree';
|
8
7
|
import '../../siblings.js';
|
9
8
|
import '@graphql-tools/utils';
|
10
9
|
|
@@ -6,7 +6,7 @@ const rule = {
|
|
6
6
|
type: "suggestion",
|
7
7
|
hasSuggestions: true,
|
8
8
|
docs: {
|
9
|
-
category: "
|
9
|
+
category: "schema",
|
10
10
|
description: "Require nullable fields in root types.",
|
11
11
|
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
12
12
|
requiresSchema: true,
|
@@ -67,6 +67,7 @@ const rule = {
|
|
67
67
|
suggest: [
|
68
68
|
{
|
69
69
|
desc: `Make ${resultType} nullable`,
|
70
|
+
// @ts-expect-error -- fixme
|
70
71
|
fix(fixer) {
|
71
72
|
const text = sourceCode.getText(field.gqlType);
|
72
73
|
return fixer.replaceText(field.gqlType, text.replace("!", ""));
|
@@ -1,10 +1,10 @@
|
|
1
1
|
import { FromSchema } from 'json-schema-to-ts';
|
2
2
|
import { GraphQLESLintRule } from '../../types.js';
|
3
3
|
import 'eslint';
|
4
|
-
import 'estree';
|
5
4
|
import 'graphql';
|
6
5
|
import 'graphql-config';
|
7
6
|
import '../../estree-converter/types.js';
|
7
|
+
import 'estree';
|
8
8
|
import '../../siblings.js';
|
9
9
|
import '@graphql-tools/utils';
|
10
10
|
|
@@ -12,6 +12,7 @@ import { getBaseType } from "../../estree-converter/index.js";
|
|
12
12
|
import {
|
13
13
|
ARRAY_DEFAULT_OPTIONS,
|
14
14
|
englishJoinWords,
|
15
|
+
pluralize,
|
15
16
|
requireGraphQLOperations,
|
16
17
|
requireGraphQLSchema
|
17
18
|
} from "../../utils.js";
|
@@ -46,7 +47,7 @@ const rule = {
|
|
46
47
|
type: "suggestion",
|
47
48
|
hasSuggestions: true,
|
48
49
|
docs: {
|
49
|
-
category: "
|
50
|
+
category: "operations",
|
50
51
|
description: "Enforce selecting specific fields when they are available on the GraphQL type.",
|
51
52
|
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
52
53
|
requiresSchema: true,
|
@@ -107,6 +108,7 @@ const rule = {
|
|
107
108
|
messages: {
|
108
109
|
[RULE_ID]: "Field{{ pluralSuffix }} {{ fieldName }} must be selected when it's available on a type.\nInclude it in your selection set{{ addition }}."
|
109
110
|
},
|
111
|
+
// @ts-expect-error -- fixme
|
110
112
|
schema
|
111
113
|
},
|
112
114
|
create(context) {
|
@@ -212,13 +214,14 @@ const rule = {
|
|
212
214
|
const fieldName2 = englishJoinWords(
|
213
215
|
idNames2.map((name) => `\`${(parent.alias || parent.name).value}.${name}\``)
|
214
216
|
);
|
215
|
-
const
|
216
|
-
|
217
|
+
const addition = checkedFragmentSpreads.size === 0 ? "" : ` or add to used fragment${pluralize(
|
218
|
+
checkedFragmentSpreads.size
|
219
|
+
)} ${englishJoinWords([...checkedFragmentSpreads].map((name) => `\`${name}\``))}`;
|
217
220
|
const problem = {
|
218
221
|
loc,
|
219
222
|
messageId: RULE_ID,
|
220
223
|
data: {
|
221
|
-
pluralSuffix,
|
224
|
+
pluralSuffix: pluralize(idNames2.length),
|
222
225
|
fieldName: fieldName2,
|
223
226
|
addition
|
224
227
|
}
|
@@ -226,6 +229,7 @@ const rule = {
|
|
226
229
|
if ("type" in node) {
|
227
230
|
problem.suggest = idNames2.map((idName) => ({
|
228
231
|
desc: `Add \`${idName}\` selection`,
|
232
|
+
// @ts-expect-error -- fixme
|
229
233
|
fix: (fixer) => {
|
230
234
|
let insertNode = node.selections[0];
|
231
235
|
insertNode = insertNode.kind === Kind.INLINE_FRAGMENT ? insertNode.selectionSet.selections[0] : insertNode;
|
@@ -1,10 +1,9 @@
|
|
1
1
|
import { GraphQLESLintRule } from '../../types.js';
|
2
2
|
import 'eslint';
|
3
|
-
import 'estree';
|
4
3
|
import 'graphql';
|
5
4
|
import 'graphql-config';
|
6
|
-
import 'json-schema-to-ts';
|
7
5
|
import '../../estree-converter/types.js';
|
6
|
+
import 'estree';
|
8
7
|
import '../../siblings.js';
|
9
8
|
import '@graphql-tools/utils';
|
10
9
|
|
@@ -1,10 +1,10 @@
|
|
1
1
|
import { FromSchema } from 'json-schema-to-ts';
|
2
2
|
import { GraphQLESLintRule } from '../../types.js';
|
3
3
|
import 'eslint';
|
4
|
-
import 'estree';
|
5
4
|
import 'graphql';
|
6
5
|
import 'graphql-config';
|
7
6
|
import '../../estree-converter/types.js';
|
7
|
+
import 'estree';
|
8
8
|
import '../../siblings.js';
|
9
9
|
import '@graphql-tools/utils';
|
10
10
|
|
@@ -23,7 +23,7 @@ const rule = {
|
|
23
23
|
type: "suggestion",
|
24
24
|
hasSuggestions: true,
|
25
25
|
docs: {
|
26
|
-
category: "
|
26
|
+
category: "operations",
|
27
27
|
description: "Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).",
|
28
28
|
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
29
29
|
requiresSiblings: true,
|
@@ -71,6 +71,7 @@ const rule = {
|
|
71
71
|
recommended: true,
|
72
72
|
configOptions: [{ maxDepth: 7 }]
|
73
73
|
},
|
74
|
+
// @ts-expect-error -- fixme
|
74
75
|
schema
|
75
76
|
},
|
76
77
|
create(context) {
|
@@ -112,6 +113,7 @@ const rule = {
|
|
112
113
|
suggest: [
|
113
114
|
{
|
114
115
|
desc: "Remove selections",
|
116
|
+
// @ts-expect-error -- fixme
|
115
117
|
fix(fixer) {
|
116
118
|
const sourceCode = context.getSourceCode();
|
117
119
|
const foundNode = sourceCode.getNodeByRangeIndex(token.range[0]);
|
@@ -1,10 +1,10 @@
|
|
1
1
|
import { FromSchema } from 'json-schema-to-ts';
|
2
2
|
import { GraphQLESLintRule } from '../../types.js';
|
3
3
|
import 'eslint';
|
4
|
-
import 'estree';
|
5
4
|
import 'graphql';
|
6
5
|
import 'graphql-config';
|
7
6
|
import '../../estree-converter/types.js';
|
7
|
+
import 'estree';
|
8
8
|
import '../../siblings.js';
|
9
9
|
import '@graphql-tools/utils';
|
10
10
|
|
@@ -3,6 +3,7 @@ import {
|
|
3
3
|
ARRAY_DEFAULT_OPTIONS,
|
4
4
|
displayNodeName,
|
5
5
|
englishJoinWords,
|
6
|
+
pluralize,
|
6
7
|
requireGraphQLSchema
|
7
8
|
} from "../../utils.js";
|
8
9
|
const RULE_ID = "strict-id-in-types";
|
@@ -43,7 +44,7 @@ const rule = {
|
|
43
44
|
type: "suggestion",
|
44
45
|
docs: {
|
45
46
|
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.",
|
46
|
-
category: "
|
47
|
+
category: "schema",
|
47
48
|
recommended: true,
|
48
49
|
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
49
50
|
requiresSchema: true,
|
@@ -115,6 +116,7 @@ const rule = {
|
|
115
116
|
}
|
116
117
|
]
|
117
118
|
},
|
119
|
+
// @ts-expect-error -- fixme
|
118
120
|
schema
|
119
121
|
},
|
120
122
|
create(context) {
|
@@ -148,13 +150,11 @@ const rule = {
|
|
148
150
|
return isValidIdName && isValidIdType;
|
149
151
|
});
|
150
152
|
if (validIds?.length !== 1) {
|
151
|
-
const pluralNamesSuffix = options.acceptedIdNames.length > 1 ? "s" : "";
|
152
|
-
const pluralTypesSuffix = options.acceptedIdTypes.length > 1 ? "s" : "";
|
153
153
|
context.report({
|
154
154
|
node: node.name,
|
155
155
|
message: `${displayNodeName(node)} must have exactly one non-nullable unique identifier.
|
156
|
-
Accepted name${
|
157
|
-
Accepted type${
|
156
|
+
Accepted name${pluralize(options.acceptedIdNames.length)}: ${englishJoinWords(options.acceptedIdNames)}.
|
157
|
+
Accepted type${pluralize(options.acceptedIdTypes.length)}: ${englishJoinWords(options.acceptedIdTypes)}.`
|
158
158
|
});
|
159
159
|
}
|
160
160
|
}
|
@@ -1,10 +1,9 @@
|
|
1
1
|
import { GraphQLESLintRule } from '../../types.js';
|
2
2
|
import 'eslint';
|
3
|
-
import 'estree';
|
4
3
|
import 'graphql';
|
5
4
|
import 'graphql-config';
|
6
|
-
import 'json-schema-to-ts';
|
7
5
|
import '../../estree-converter/types.js';
|
6
|
+
import 'estree';
|
8
7
|
import '../../siblings.js';
|
9
8
|
import '@graphql-tools/utils';
|
10
9
|
|
@@ -6,7 +6,7 @@ const rule = {
|
|
6
6
|
hasSuggestions: true,
|
7
7
|
docs: {
|
8
8
|
url: "https://the-guild.dev/graphql/eslint/rules/unique-enum-value-names",
|
9
|
-
category: "
|
9
|
+
category: "schema",
|
10
10
|
recommended: true,
|
11
11
|
description: `A GraphQL enum type is only valid if all its values are uniquely named.
|
12
12
|
> This rule disallows case-insensitive enum values duplicates too.`,
|
@@ -58,6 +58,7 @@ const rule = {
|
|
58
58
|
suggest: [
|
59
59
|
{
|
60
60
|
desc: `Remove \`${enumName}\` enum value`,
|
61
|
+
// @ts-expect-error -- fixme
|
61
62
|
fix: (fixer) => fixer.remove(duplicate)
|
62
63
|
}
|
63
64
|
]
|
@@ -19,7 +19,6 @@ const checkNode = (context, node, ruleId) => {
|
|
19
19
|
documentName,
|
20
20
|
summary: conflictingDocuments.map((f) => ` ${relative(CWD, f.filePath.replace(VIRTUAL_DOCUMENT_REGEX, ""))}`).join("\n")
|
21
21
|
},
|
22
|
-
// @ts-expect-error name will exist
|
23
22
|
node: node.name
|
24
23
|
});
|
25
24
|
}
|
@@ -28,7 +27,7 @@ const rule = {
|
|
28
27
|
meta: {
|
29
28
|
type: "suggestion",
|
30
29
|
docs: {
|
31
|
-
category: "
|
30
|
+
category: "operations",
|
32
31
|
description: "Enforce unique fragment names across your project.",
|
33
32
|
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
34
33
|
requiresSiblings: true,
|
@@ -1,10 +1,9 @@
|
|
1
1
|
import { GraphQLESLintRule } from '../../types.js';
|
2
2
|
import 'eslint';
|
3
|
-
import 'estree';
|
4
3
|
import 'graphql';
|
5
4
|
import 'graphql-config';
|
6
|
-
import 'json-schema-to-ts';
|
7
5
|
import '../../estree-converter/types.js';
|
6
|
+
import 'estree';
|
8
7
|
import '../../siblings.js';
|
9
8
|
import '@graphql-tools/utils';
|
10
9
|
|
@@ -4,7 +4,7 @@ const rule = {
|
|
4
4
|
meta: {
|
5
5
|
type: "suggestion",
|
6
6
|
docs: {
|
7
|
-
category: "
|
7
|
+
category: "operations",
|
8
8
|
description: "Enforce unique operation names across your project.",
|
9
9
|
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
|
10
10
|
requiresSiblings: true,
|
package/esm/schema.d.ts
CHANGED
@@ -1,10 +1,9 @@
|
|
1
1
|
import { GraphQLProjectConfig } from 'graphql-config';
|
2
2
|
import { Schema } from './types.js';
|
3
3
|
import 'eslint';
|
4
|
-
import 'estree';
|
5
4
|
import 'graphql';
|
6
|
-
import 'json-schema-to-ts';
|
7
5
|
import './estree-converter/types.js';
|
6
|
+
import 'estree';
|
8
7
|
import './siblings.js';
|
9
8
|
import '@graphql-tools/utils';
|
10
9
|
|
package/esm/types.d.ts
CHANGED
@@ -1,10 +1,9 @@
|
|
1
|
-
import { Linter, Rule
|
2
|
-
import * as ESTree from 'estree';
|
1
|
+
import { Linter, Rule } from 'eslint';
|
3
2
|
import { GraphQLSchema, ASTKindToNode } from 'graphql';
|
4
3
|
import { IGraphQLConfig } from 'graphql-config';
|
5
|
-
import { JSONSchema } from 'json-schema-to-ts';
|
6
4
|
import { GraphQLESTreeNode } from './estree-converter/types.js';
|
7
5
|
import { SiblingOperations } from './siblings.js';
|
6
|
+
import 'estree';
|
8
7
|
import '@graphql-tools/utils';
|
9
8
|
|
10
9
|
type Schema = GraphQLSchema | null;
|
@@ -21,24 +20,16 @@ type ParserServices = {
|
|
21
20
|
type GraphQLESLintParseResult = Linter.ESLintParseResult & {
|
22
21
|
services: ParserServices;
|
23
22
|
};
|
24
|
-
type
|
25
|
-
type ReportDescriptorLocation = {
|
26
|
-
loc: Location;
|
27
|
-
} | {
|
28
|
-
node: {
|
29
|
-
loc: Location;
|
30
|
-
};
|
31
|
-
};
|
23
|
+
type ReportDescriptorLocation = any;
|
32
24
|
type ReportDescriptor = ReportDescriptorLocation & Rule.ReportDescriptorMessage & Rule.ReportDescriptorOptions;
|
33
|
-
type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleContext, 'options' | '
|
25
|
+
type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleContext, 'options' | 'report'> & {
|
34
26
|
options: Options;
|
35
|
-
parserServices: ParserServices;
|
36
27
|
report(descriptor: ReportDescriptor): void;
|
37
28
|
};
|
38
|
-
type CategoryType = '
|
29
|
+
type CategoryType = 'schema' | 'operations' | 'schema-and-operations';
|
39
30
|
type RuleMetaDataDocs = Required<Rule.RuleMetaData>['docs'];
|
40
31
|
type RuleDocsInfo<T> = Omit<RuleMetaDataDocs, 'category' | 'suggestion'> & {
|
41
|
-
category
|
32
|
+
category?: string;
|
42
33
|
requiresSchema?: true;
|
43
34
|
requiresSiblings?: true;
|
44
35
|
examples?: {
|
@@ -58,9 +49,8 @@ type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = Record<st
|
|
58
49
|
[K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
|
59
50
|
};
|
60
51
|
type GraphQLESLintRule<Options = [], WithTypeInfo extends boolean = false> = {
|
61
|
-
meta
|
52
|
+
meta?: Omit<Rule.RuleMetaData, 'docs'> & {
|
62
53
|
docs?: RuleDocsInfo<Options>;
|
63
|
-
schema: Readonly<JSONSchema> | [];
|
64
54
|
};
|
65
55
|
create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
|
66
56
|
};
|
package/esm/utils.d.ts
CHANGED
@@ -6,7 +6,6 @@ import { SiblingOperations } from './siblings.js';
|
|
6
6
|
import { GraphQLESLintRuleContext } from './types.js';
|
7
7
|
import '@graphql-tools/utils';
|
8
8
|
import 'graphql-config';
|
9
|
-
import 'json-schema-to-ts';
|
10
9
|
|
11
10
|
declare function requireGraphQLOperations(ruleId: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
|
12
11
|
declare function requireGraphQLSchema(ruleId: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
|
@@ -40,5 +39,6 @@ declare const englishJoinWords: (words: string[]) => string;
|
|
40
39
|
declare function displayNodeName(node: GraphQLESTreeNode<ASTNode, boolean>): string;
|
41
40
|
declare function getNodeName(node: GraphQLESTreeNode<ASTNode>): string;
|
42
41
|
declare const eslintSelectorsTip = "> [!TIP]\n>\n> These fields are defined by ESLint [`selectors`](https://eslint.org/docs/developer-guide/selectors).\n> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.";
|
42
|
+
declare function pluralize(size: number): "" | "s";
|
43
43
|
|
44
|
-
export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, eslintSelectorsTip, getLocation, getNodeName, getTypeName, logger, pascalCase, requireGraphQLOperations, requireGraphQLSchema, slash };
|
44
|
+
export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, eslintSelectorsTip, getLocation, getNodeName, getTypeName, logger, pascalCase, pluralize, requireGraphQLOperations, requireGraphQLSchema, slash };
|
package/esm/utils.js
CHANGED
@@ -158,6 +158,9 @@ const eslintSelectorsTip = `> [!TIP]
|
|
158
158
|
>
|
159
159
|
> These fields are defined by ESLint [\`selectors\`](https://eslint.org/docs/developer-guide/selectors).
|
160
160
|
> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.`;
|
161
|
+
function pluralize(size) {
|
162
|
+
return size > 1 ? "s" : "";
|
163
|
+
}
|
161
164
|
export {
|
162
165
|
ARRAY_DEFAULT_OPTIONS,
|
163
166
|
CWD,
|
@@ -174,6 +177,7 @@ export {
|
|
174
177
|
getTypeName,
|
175
178
|
logger,
|
176
179
|
pascalCase,
|
180
|
+
pluralize,
|
177
181
|
requireGraphQLOperations,
|
178
182
|
requireGraphQLSchema,
|
179
183
|
slash
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@graphql-eslint/eslint-plugin",
|
3
|
-
"version": "4.4.0-alpha-
|
3
|
+
"version": "4.4.0-alpha-20241210121000-22133a7d66f4a5d831e5588ca0ce4fc789bca4ed",
|
4
4
|
"type": "module",
|
5
5
|
"description": "GraphQL plugin for ESLint",
|
6
6
|
"repository": "https://github.com/dimaMachina/graphql-eslint",
|
@@ -20,6 +20,16 @@
|
|
20
20
|
"types": "./esm/index.d.ts",
|
21
21
|
"default": "./esm/index.js"
|
22
22
|
}
|
23
|
+
},
|
24
|
+
"./*": {
|
25
|
+
"require": {
|
26
|
+
"types": "./cjs/*.d.cts",
|
27
|
+
"default": "./cjs/*.js"
|
28
|
+
},
|
29
|
+
"import": {
|
30
|
+
"types": "./esm/*.d.ts",
|
31
|
+
"default": "./esm/*.js"
|
32
|
+
}
|
23
33
|
}
|
24
34
|
},
|
25
35
|
"types": "esm/index.d.ts",
|