@graphql-eslint/eslint-plugin 2.3.0 → 2.3.1

package/docs/rules/unique-input-field-names.md

@@ -9,4 +9,9 @@
 
 A GraphQL input object value is only valid if all supplied fields are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueInputFieldNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueInputFieldNamesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueInputFieldNamesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueInputFieldNamesRule-test.ts)

package/docs/rules/unique-operation-name.md

@@ -47,4 +47,9 @@ query me {
     id
   }
 }
-```
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/unique-operation-name.ts)
+- [Test source](../../packages/plugin/tests/unique-operation-name.spec.ts)

package/docs/rules/unique-operation-types.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if it has only one type per operation.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueOperationTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueOperationTypesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueOperationTypesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueOperationTypesRule-test.ts)

package/docs/rules/unique-type-names.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if all defined types have unique names.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueTypeNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueTypeNamesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueTypeNamesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueTypeNamesRule-test.ts)

package/docs/rules/unique-variable-names.md

@@ -9,4 +9,9 @@
 
 A GraphQL operation is only valid if all its variables are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueVariableNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueVariableNamesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueVariableNamesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/UniqueVariableNamesRule-test.ts)

package/docs/rules/value-literals-of-correct-type.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if all value literals are of the type expected at their position.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ValuesOfCorrectTypeRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ValuesOfCorrectTypeRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ValuesOfCorrectTypeRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/ValuesOfCorrectTypeRule-test.ts)

package/docs/rules/variables-are-input-types.md

@@ -9,4 +9,9 @@
 
 A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesAreInputTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesAreInputTypesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesAreInputTypesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/VariablesAreInputTypesRule-test.ts)

package/docs/rules/variables-in-allowed-position.md

@@ -9,4 +9,9 @@
 
 Variables passed to field arguments conform to type.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesInAllowedPositionRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesInAllowedPositionRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesInAllowedPositionRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/VariablesInAllowedPositionRule-test.ts)

package/index.js

@@ -292,6 +292,7 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
             meta: {
                 docs: {
                     ...docs,
+                    graphQLJSRuleName: ruleName,
                     category: 'Validation',
                     recommended: true,
                     requiresSchema,
@@ -656,10 +657,7 @@ const rule = {
                                 line: start.line,
                                 column: start.column - (isVariableNode ? 2 : 1),
                             },
-                            end: {
-                                line: end.line,
-                                column: end.column,
-                            },
+                            end,
                         },
                         messageId: ALPHABETIZE,
                         data: isVariableNode
@@ -790,6 +788,7 @@ const rule$1 = {
         messages: {
             [AVOID_DUPLICATE_FIELDS]: `{{ type }} "{{ fieldName }}" defined multiple times.`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -909,15 +908,16 @@ const rule$2 = {
                         const testKeyword = caseSensitive ? keyword : keyword.toLowerCase();
                         const testName = caseSensitive ? node.name.value : node.name.value.toLowerCase();
                         if (testName.startsWith(testKeyword)) {
+                            const { start } = node.name.loc;
                             context.report({
                                 loc: {
                                     start: {
-                                        line: node.name.loc.start.line,
-                                        column: node.name.loc.start.column - 1,
+                                        line: start.line,
+                                        column: start.column - 1,
                                     },
                                     end: {
-                                        line: node.name.loc.start.line,
-                                        column: node.name.loc.start.column + testKeyword.length - 1,
+                                        line: start.line,
+                                        column: start.column - 1 + testKeyword.length,
                                     },
                                 },
                                 data: {
@@ -960,6 +960,7 @@ const rule$3 = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext('avoid-scalar-result-type-on-mutation', context);
@@ -1015,22 +1016,33 @@ const rule$4 = {
         messages: {
             [AVOID_TYPENAME_PREFIX]: `Field "{{ fieldName }}" starts with the name of the parent type "{{ typeName }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
             'ObjectTypeDefinition, ObjectTypeExtension, InterfaceTypeDefinition, InterfaceTypeExtension'(node) {
                 const typeName = node.name.value;
-                const lowerTypeName = (typeName || '').toLowerCase();
+                const lowerTypeName = typeName.toLowerCase();
                 for (const field of node.fields) {
-                    const fieldName = field.name.value || '';
-                    if (fieldName && lowerTypeName && fieldName.toLowerCase().startsWith(lowerTypeName)) {
+                    const fieldName = field.name.value;
+                    if (fieldName.toLowerCase().startsWith(lowerTypeName)) {
+                        const { start } = field.loc;
                         context.report({
-                            node: field.name,
                             data: {
                                 fieldName,
                                 typeName,
                             },
                             messageId: AVOID_TYPENAME_PREFIX,
+                            loc: {
+                                start: {
+                                    line: start.line,
+                                    column: start.column - 1,
+                                },
+                                end: {
+                                    line: start.line,
+                                    column: start.column - 1 + lowerTypeName.length,
+                                },
+                            },
                         });
                     }
                 }
@@ -1728,20 +1740,24 @@ const rule$9 = {
         messages: {
             [NO_ANONYMOUS_OPERATIONS]: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`,
         },
+        schema: [],
     },
     create(context) {
         return {
             OperationDefinition(node) {
-                if (node && (!node.name || node.name.value === '')) {
+                var _a;
+                const isAnonymous = (((_a = node.name) === null || _a === void 0 ? void 0 : _a.value) || '').length === 0;
+                if (isAnonymous) {
+                    const { start } = node.loc;
                     context.report({
                         loc: {
                             start: {
-                                column: node.loc.start.column - 1,
-                                line: node.loc.start.line,
+                                column: start.column - 1,
+                                line: start.line,
                             },
                             end: {
-                                column: node.loc.start.column + node.operation.length,
-                                line: node.loc.start.line,
+                                column: start.column - 1 + node.operation.length,
+                                line: start.line,
                             },
                         },
                         data: {
@@ -1791,6 +1807,7 @@ const rule$a = {
         messages: {
             [ERROR_MESSAGE_ID]: `Case-insensitive enum values duplicates are not allowed! Found: "{{ found }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1885,6 +1902,7 @@ const rule$b = {
         messages: {
             [NO_DEPRECATED]: `This {{ type }} is marked as deprecated in your GraphQL schema {{ reason }}`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1971,6 +1989,7 @@ const rule$c = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2031,15 +2050,28 @@ const rule$d = {
         messages: {
             [NO_OPERATION_NAME_SUFFIX]: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`,
         },
+        schema: [],
     },
     create(context) {
         return {
             'OperationDefinition, FragmentDefinition'(node) {
-                if (node && node.name && node.name.value !== '') {
-                    const invalidSuffix = (node.type === 'OperationDefinition' ? node.operation : 'fragment').toLowerCase();
-                    if (node.name.value.toLowerCase().endsWith(invalidSuffix)) {
+                var _a;
+                const name = ((_a = node.name) === null || _a === void 0 ? void 0 : _a.value) || '';
+                if (name.length > 0) {
+                    const invalidSuffix = 'operation' in node ? node.operation : 'fragment';
+                    if (name.toLowerCase().endsWith(invalidSuffix)) {
+                        const { start, end } = node.name.loc;
                         context.report({
-                            node: node.name,
+                            loc: {
+                                start: {
+                                    column: start.column - 1 + name.length - invalidSuffix.length,
+                                    line: start.line,
+                                },
+                                end: {
+                                    column: end.column - 1 + name.length,
+                                    line: end.line,
+                                },
+                            },
                             data: {
                                 invalidSuffix,
                             },
@@ -2096,6 +2128,7 @@ const rule$e = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const reachableTypes = requireReachableTypesFromContext(RULE_NAME, context);
@@ -2187,6 +2220,7 @@ const rule$f = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const usedFields = requireUsedFieldsFromContext(RULE_NAME$1, context);
@@ -2452,6 +2486,7 @@ const rule$h = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2488,15 +2523,18 @@ const DESCRIBABLE_NODES = [
 function verifyRule(context, node) {
     if (node) {
         if (!node.description || !node.description.value || node.description.value.trim().length === 0) {
+            const { start, end } = ('name' in node ? node.name : node).loc;
             context.report({
                 loc: {
                     start: {
-                        line: node.loc.start.line,
-                        column: node.loc.start.column - 1,
+                        line: start.line,
+                        column: start.column - 1,
                     },
                     end: {
-                        line: node.loc.end.line,
-                        column: node.loc.end.column,
+                        line: end.line,
+                        column: 
+                        // node.name don't exist on SchemaDefinition
+                        'name' in node ? end.column - 1 + node.name.value.length : end.column,
                     },
                 },
                 messageId: REQUIRE_DESCRIPTION_ERROR,
@@ -2610,6 +2648,7 @@ const rule$j = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext(RULE_NAME$2, context);
@@ -3229,6 +3268,7 @@ const rule$n = {
         messages: {
             [UNIQUE_FRAGMENT_NAME]: 'Fragment named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -3291,6 +3331,7 @@ const rule$o = {
         messages: {
             [UNIQUE_OPERATION_NAME]: 'Operation named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {

package/index.mjs

@@ -286,6 +286,7 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
             meta: {
                 docs: {
                     ...docs,
+                    graphQLJSRuleName: ruleName,
                     category: 'Validation',
                     recommended: true,
                     requiresSchema,
@@ -650,10 +651,7 @@ const rule = {
                                 line: start.line,
                                 column: start.column - (isVariableNode ? 2 : 1),
                             },
-                            end: {
-                                line: end.line,
-                                column: end.column,
-                            },
+                            end,
                         },
                         messageId: ALPHABETIZE,
                         data: isVariableNode
@@ -784,6 +782,7 @@ const rule$1 = {
         messages: {
             [AVOID_DUPLICATE_FIELDS]: `{{ type }} "{{ fieldName }}" defined multiple times.`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -903,15 +902,16 @@ const rule$2 = {
                         const testKeyword = caseSensitive ? keyword : keyword.toLowerCase();
                         const testName = caseSensitive ? node.name.value : node.name.value.toLowerCase();
                         if (testName.startsWith(testKeyword)) {
+                            const { start } = node.name.loc;
                             context.report({
                                 loc: {
                                     start: {
-                                        line: node.name.loc.start.line,
-                                        column: node.name.loc.start.column - 1,
+                                        line: start.line,
+                                        column: start.column - 1,
                                     },
                                     end: {
-                                        line: node.name.loc.start.line,
-                                        column: node.name.loc.start.column + testKeyword.length - 1,
+                                        line: start.line,
+                                        column: start.column - 1 + testKeyword.length,
                                     },
                                 },
                                 data: {
@@ -954,6 +954,7 @@ const rule$3 = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext('avoid-scalar-result-type-on-mutation', context);
@@ -1009,22 +1010,33 @@ const rule$4 = {
         messages: {
             [AVOID_TYPENAME_PREFIX]: `Field "{{ fieldName }}" starts with the name of the parent type "{{ typeName }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
             'ObjectTypeDefinition, ObjectTypeExtension, InterfaceTypeDefinition, InterfaceTypeExtension'(node) {
                 const typeName = node.name.value;
-                const lowerTypeName = (typeName || '').toLowerCase();
+                const lowerTypeName = typeName.toLowerCase();
                 for (const field of node.fields) {
-                    const fieldName = field.name.value || '';
-                    if (fieldName && lowerTypeName && fieldName.toLowerCase().startsWith(lowerTypeName)) {
+                    const fieldName = field.name.value;
+                    if (fieldName.toLowerCase().startsWith(lowerTypeName)) {
+                        const { start } = field.loc;
                         context.report({
-                            node: field.name,
                             data: {
                                 fieldName,
                                 typeName,
                             },
                             messageId: AVOID_TYPENAME_PREFIX,
+                            loc: {
+                                start: {
+                                    line: start.line,
+                                    column: start.column - 1,
+                                },
+                                end: {
+                                    line: start.line,
+                                    column: start.column - 1 + lowerTypeName.length,
+                                },
+                            },
                         });
                     }
                 }
@@ -1722,20 +1734,24 @@ const rule$9 = {
         messages: {
             [NO_ANONYMOUS_OPERATIONS]: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`,
         },
+        schema: [],
     },
     create(context) {
         return {
             OperationDefinition(node) {
-                if (node && (!node.name || node.name.value === '')) {
+                var _a;
+                const isAnonymous = (((_a = node.name) === null || _a === void 0 ? void 0 : _a.value) || '').length === 0;
+                if (isAnonymous) {
+                    const { start } = node.loc;
                     context.report({
                         loc: {
                             start: {
-                                column: node.loc.start.column - 1,
-                                line: node.loc.start.line,
+                                column: start.column - 1,
+                                line: start.line,
                             },
                             end: {
-                                column: node.loc.start.column + node.operation.length,
-                                line: node.loc.start.line,
+                                column: start.column - 1 + node.operation.length,
+                                line: start.line,
                             },
                         },
                         data: {
@@ -1785,6 +1801,7 @@ const rule$a = {
         messages: {
             [ERROR_MESSAGE_ID]: `Case-insensitive enum values duplicates are not allowed! Found: "{{ found }}"`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1879,6 +1896,7 @@ const rule$b = {
         messages: {
             [NO_DEPRECATED]: `This {{ type }} is marked as deprecated in your GraphQL schema {{ reason }}`,
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -1965,6 +1983,7 @@ const rule$c = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2025,15 +2044,28 @@ const rule$d = {
         messages: {
             [NO_OPERATION_NAME_SUFFIX]: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`,
         },
+        schema: [],
     },
     create(context) {
         return {
             'OperationDefinition, FragmentDefinition'(node) {
-                if (node && node.name && node.name.value !== '') {
-                    const invalidSuffix = (node.type === 'OperationDefinition' ? node.operation : 'fragment').toLowerCase();
-                    if (node.name.value.toLowerCase().endsWith(invalidSuffix)) {
+                var _a;
+                const name = ((_a = node.name) === null || _a === void 0 ? void 0 : _a.value) || '';
+                if (name.length > 0) {
+                    const invalidSuffix = 'operation' in node ? node.operation : 'fragment';
+                    if (name.toLowerCase().endsWith(invalidSuffix)) {
+                        const { start, end } = node.name.loc;
                         context.report({
-                            node: node.name,
+                            loc: {
+                                start: {
+                                    column: start.column - 1 + name.length - invalidSuffix.length,
+                                    line: start.line,
+                                },
+                                end: {
+                                    column: end.column - 1 + name.length,
+                                    line: end.line,
+                                },
+                            },
                             data: {
                                 invalidSuffix,
                             },
@@ -2090,6 +2122,7 @@ const rule$e = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const reachableTypes = requireReachableTypesFromContext(RULE_NAME, context);
@@ -2181,6 +2214,7 @@ const rule$f = {
         },
         fixable: 'code',
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         const usedFields = requireUsedFieldsFromContext(RULE_NAME$1, context);
@@ -2446,6 +2480,7 @@ const rule$h = {
             ],
         },
         type: 'suggestion',
+        schema: [],
     },
     create(context) {
         return {
@@ -2482,15 +2517,18 @@ const DESCRIBABLE_NODES = [
 function verifyRule(context, node) {
     if (node) {
         if (!node.description || !node.description.value || node.description.value.trim().length === 0) {
+            const { start, end } = ('name' in node ? node.name : node).loc;
             context.report({
                 loc: {
                     start: {
-                        line: node.loc.start.line,
-                        column: node.loc.start.column - 1,
+                        line: start.line,
+                        column: start.column - 1,
                     },
                     end: {
-                        line: node.loc.end.line,
-                        column: node.loc.end.column,
+                        line: end.line,
+                        column: 
+                        // node.name don't exist on SchemaDefinition
+                        'name' in node ? end.column - 1 + node.name.value.length : end.column,
                     },
                 },
                 messageId: REQUIRE_DESCRIPTION_ERROR,
@@ -2604,6 +2642,7 @@ const rule$j = {
                 },
             ],
         },
+        schema: [],
     },
     create(context) {
         const schema = requireGraphQLSchemaFromContext(RULE_NAME$2, context);
@@ -3223,6 +3262,7 @@ const rule$n = {
         messages: {
             [UNIQUE_FRAGMENT_NAME]: 'Fragment named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {
@@ -3285,6 +3325,7 @@ const rule$o = {
         messages: {
             [UNIQUE_OPERATION_NAME]: 'Operation named "{{ documentName }}" already defined in:\n{{ summary }}',
         },
+        schema: [],
     },
     create(context) {
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0"

package/types.d.ts

@@ -56,9 +56,11 @@ export declare type RuleDocsInfo<T> = Rule.RuleMetaData & {
             usage?: T;
         }[];
         optionsForConfig?: T;
+        graphQLJSRuleName?: string;
     };
 };
 export declare type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = false> = {
     create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
     meta: Rule.RuleMetaData & RuleDocsInfo<Options>;
 };
+export declare type ValueOf<T> = T[keyof T];