@graphql-eslint/eslint-plugin 3.18.1-alpha-20230522133807-c37ed49 → 3.19.0

package/cjs/configs/schema-all.js

@@ -19,6 +19,7 @@ exports.default = {
         '@graphql-eslint/require-deprecation-date': 'error',
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': 'error',
         '@graphql-eslint/require-nullable-fields-with-oneof': 'error',
+        '@graphql-eslint/require-nullable-result-in-root': 'error',
         '@graphql-eslint/require-type-pattern-with-oneof': 'error',
     },
 };

package/cjs/rules/index.js

@@ -33,6 +33,7 @@ const require_field_of_type_query_in_mutation_result_js_1 = require("./require-f
 const require_id_when_available_js_1 = require("./require-id-when-available.js");
 const require_import_fragment_js_1 = require("./require-import-fragment.js");
 const require_nullable_fields_with_oneof_js_1 = require("./require-nullable-fields-with-oneof.js");
+const require_nullable_result_in_root_js_1 = require("./require-nullable-result-in-root.js");
 const require_type_pattern_with_oneof_js_1 = require("./require-type-pattern-with-oneof.js");
 const selection_set_depth_js_1 = require("./selection-set-depth.js");
 const strict_id_in_types_js_1 = require("./strict-id-in-types.js");
@@ -68,6 +69,7 @@ exports.rules = {
     'require-id-when-available': require_id_when_available_js_1.rule,
     'require-import-fragment': require_import_fragment_js_1.rule,
     'require-nullable-fields-with-oneof': require_nullable_fields_with_oneof_js_1.rule,
+    'require-nullable-result-in-root': require_nullable_result_in_root_js_1.rule,
     'require-type-pattern-with-oneof': require_type_pattern_with_oneof_js_1.rule,
     'selection-set-depth': selection_set_depth_js_1.rule,
     'strict-id-in-types': strict_id_in_types_js_1.rule,

package/cjs/rules/require-nullable-result-in-root.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = void 0;
+const graphql_1 = require("graphql");
+const utils_js_1 = require("../utils.js");
+const RULE_ID = 'require-nullable-result-in-root';
+exports.rule = {
+    meta: {
+        type: 'suggestion',
+        hasSuggestions: true,
+        docs: {
+            category: 'Schema',
+            description: 'Require nullable fields in root types.',
+            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            requiresSchema: true,
+            examples: [
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            type Query {
+              user: User!
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    code: /* GraphQL */ `
+            type Query {
+              foo: User
+              baz: [User]!
+              bar: [User!]!
+            }
+          `,
+                },
+            ],
+        },
+        messages: {
+            [RULE_ID]: 'Unexpected non-null result {{ resultType }} in {{ rootType }}',
+        },
+        schema: [],
+    },
+    create(context) {
+        const schema = (0, utils_js_1.requireGraphQLSchemaFromContext)(RULE_ID, context);
+        const rootTypeNames = new Set([schema.getQueryType(), schema.getMutationType(), schema.getSubscriptionType()]
+            .filter(utils_js_1.truthy)
+            .map(type => type.name));
+        const sourceCode = context.getSourceCode();
+        return {
+            'ObjectTypeDefinition,ObjectTypeExtension'(node) {
+                if (!rootTypeNames.has(node.name.value))
+                    return;
+                for (const field of node.fields || []) {
+                    if (field.gqlType.type !== graphql_1.Kind.NON_NULL_TYPE ||
+                        field.gqlType.gqlType.type !== graphql_1.Kind.NAMED_TYPE)
+                        continue;
+                    const name = field.gqlType.gqlType.name.value;
+                    const type = schema.getType(name);
+                    const resultType = type ? (0, utils_js_1.getNodeName)(type.astNode) : '';
+                    context.report({
+                        node: field.gqlType,
+                        messageId: RULE_ID,
+                        data: {
+                            resultType,
+                            rootType: (0, utils_js_1.getNodeName)(node),
+                        },
+                        suggest: [
+                            {
+                                desc: `Make ${resultType} nullable`,
+                                fix(fixer) {
+                                    const text = sourceCode.getText(field.gqlType);
+                                    return fixer.replaceText(field.gqlType, text.replace('!', ''));
+                                },
+                            },
+                        ],
+                    });
+                }
+            },
+        };
+    },
+};

package/cjs/utils.js

@@ -127,6 +127,7 @@ exports.displayNodeName = displayNodeName;
 function getNodeName(node) {
     switch (node.kind) {
         case graphql_1.Kind.OBJECT_TYPE_DEFINITION:
+        case graphql_1.Kind.OBJECT_TYPE_EXTENSION:
         case graphql_1.Kind.INTERFACE_TYPE_DEFINITION:
         case graphql_1.Kind.ENUM_TYPE_DEFINITION:
         case graphql_1.Kind.SCALAR_TYPE_DEFINITION:

package/esm/configs/schema-all.js

@@ -17,6 +17,7 @@ export default {
         '@graphql-eslint/require-deprecation-date': 'error',
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': 'error',
         '@graphql-eslint/require-nullable-fields-with-oneof': 'error',
+        '@graphql-eslint/require-nullable-result-in-root': 'error',
         '@graphql-eslint/require-type-pattern-with-oneof': 'error',
     },
 };

package/esm/rules/index.js

@@ -30,6 +30,7 @@ import { rule as requireFieldOfTypeQueryInMutationResult } from './require-field
 import { rule as requireIdWhenAvailable } from './require-id-when-available.js';
 import { rule as requireImportFragment } from './require-import-fragment.js';
 import { rule as requireNullableFieldsWithOneof } from './require-nullable-fields-with-oneof.js';
+import { rule as requireNullableResultInRoot } from './require-nullable-result-in-root.js';
 import { rule as requireTypePatternWithOneof } from './require-type-pattern-with-oneof.js';
 import { rule as selectionSetDepth } from './selection-set-depth.js';
 import { rule as strictIdInTypes } from './strict-id-in-types.js';
@@ -65,6 +66,7 @@ export const rules = {
     'require-id-when-available': requireIdWhenAvailable,
     'require-import-fragment': requireImportFragment,
     'require-nullable-fields-with-oneof': requireNullableFieldsWithOneof,
+    'require-nullable-result-in-root': requireNullableResultInRoot,
     'require-type-pattern-with-oneof': requireTypePatternWithOneof,
     'selection-set-depth': selectionSetDepth,
     'strict-id-in-types': strictIdInTypes,

package/esm/rules/require-nullable-result-in-root.js

@@ -0,0 +1,77 @@
+import { Kind } from 'graphql';
+import { getNodeName, requireGraphQLSchemaFromContext, truthy } from '../utils.js';
+const RULE_ID = 'require-nullable-result-in-root';
+export const rule = {
+    meta: {
+        type: 'suggestion',
+        hasSuggestions: true,
+        docs: {
+            category: 'Schema',
+            description: 'Require nullable fields in root types.',
+            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            requiresSchema: true,
+            examples: [
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            type Query {
+              user: User!
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    code: /* GraphQL */ `
+            type Query {
+              foo: User
+              baz: [User]!
+              bar: [User!]!
+            }
+          `,
+                },
+            ],
+        },
+        messages: {
+            [RULE_ID]: 'Unexpected non-null result {{ resultType }} in {{ rootType }}',
+        },
+        schema: [],
+    },
+    create(context) {
+        const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+        const rootTypeNames = new Set([schema.getQueryType(), schema.getMutationType(), schema.getSubscriptionType()]
+            .filter(truthy)
+            .map(type => type.name));
+        const sourceCode = context.getSourceCode();
+        return {
+            'ObjectTypeDefinition,ObjectTypeExtension'(node) {
+                if (!rootTypeNames.has(node.name.value))
+                    return;
+                for (const field of node.fields || []) {
+                    if (field.gqlType.type !== Kind.NON_NULL_TYPE ||
+                        field.gqlType.gqlType.type !== Kind.NAMED_TYPE)
+                        continue;
+                    const name = field.gqlType.gqlType.name.value;
+                    const type = schema.getType(name);
+                    const resultType = type ? getNodeName(type.astNode) : '';
+                    context.report({
+                        node: field.gqlType,
+                        messageId: RULE_ID,
+                        data: {
+                            resultType,
+                            rootType: getNodeName(node),
+                        },
+                        suggest: [
+                            {
+                                desc: `Make ${resultType} nullable`,
+                                fix(fixer) {
+                                    const text = sourceCode.getText(field.gqlType);
+                                    return fixer.replaceText(field.gqlType, text.replace('!', ''));
+                                },
+                            },
+                        ],
+                    });
+                }
+            },
+        };
+    },
+};

package/esm/utils.js

@@ -112,6 +112,7 @@ export function displayNodeName(node) {
 export function getNodeName(node) {
     switch (node.kind) {
         case Kind.OBJECT_TYPE_DEFINITION:
+        case Kind.OBJECT_TYPE_EXTENSION:
         case Kind.INTERFACE_TYPE_DEFINITION:
         case Kind.ENUM_TYPE_DEFINITION:
         case Kind.SCALAR_TYPE_DEFINITION:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.18.1-alpha-20230522133807-c37ed49",
+  "version": "3.19.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {
@@ -14,7 +14,7 @@
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "fast-glob": "^3.2.12",
-    "graphql-config": "^5.0.0",
+    "graphql-config": "^4.4.0",
     "graphql-depth-limit": "^1.1.0",
     "lodash.lowercase": "^4.3.0",
     "tslib": "^2.4.1"

package/typings/configs/index.d.cts

@@ -59,6 +59,7 @@ export declare const configs: {
             '@graphql-eslint/require-deprecation-date': string;
             '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
             '@graphql-eslint/require-nullable-fields-with-oneof': string;
+            '@graphql-eslint/require-nullable-result-in-root': string;
             '@graphql-eslint/require-type-pattern-with-oneof': string;
         };
     };

package/typings/configs/index.d.ts

@@ -59,6 +59,7 @@ export declare const configs: {
             '@graphql-eslint/require-deprecation-date': string;
             '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
             '@graphql-eslint/require-nullable-fields-with-oneof': string;
+            '@graphql-eslint/require-nullable-result-in-root': string;
             '@graphql-eslint/require-type-pattern-with-oneof': string;
         };
     };

package/typings/configs/schema-all.d.cts

@@ -11,6 +11,7 @@ declare const _default: {
         '@graphql-eslint/require-deprecation-date': string;
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
         '@graphql-eslint/require-nullable-fields-with-oneof': string;
+        '@graphql-eslint/require-nullable-result-in-root': string;
         '@graphql-eslint/require-type-pattern-with-oneof': string;
     };
 };

package/typings/configs/schema-all.d.ts

@@ -11,6 +11,7 @@ declare const _default: {
         '@graphql-eslint/require-deprecation-date': string;
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
         '@graphql-eslint/require-nullable-fields-with-oneof': string;
+        '@graphql-eslint/require-nullable-result-in-root': string;
         '@graphql-eslint/require-type-pattern-with-oneof': string;
     };
 };

package/typings/flat-configs.d.cts

@@ -151,6 +151,7 @@ export declare const flatConfigs: {
             '@graphql-eslint/require-deprecation-date': string;
             '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
             '@graphql-eslint/require-nullable-fields-with-oneof': string;
+            '@graphql-eslint/require-nullable-result-in-root': string;
             '@graphql-eslint/require-type-pattern-with-oneof': string;
             '@graphql-eslint/description-style': string;
             '@graphql-eslint/known-argument-names': string;

package/typings/flat-configs.d.ts

@@ -151,6 +151,7 @@ export declare const flatConfigs: {
             '@graphql-eslint/require-deprecation-date': string;
             '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
             '@graphql-eslint/require-nullable-fields-with-oneof': string;
+            '@graphql-eslint/require-nullable-result-in-root': string;
             '@graphql-eslint/require-type-pattern-with-oneof': string;
             '@graphql-eslint/description-style': string;
             '@graphql-eslint/known-argument-names': string;

package/typings/rules/index.d.cts

@@ -92,6 +92,7 @@ export declare const rules: {
     }[], true>;
     'require-import-fragment': import("../types.js").GraphQLESLintRule;
     'require-nullable-fields-with-oneof': import("../types.js").GraphQLESLintRule;
+    'require-nullable-result-in-root': import("../types.js").GraphQLESLintRule;
     'require-type-pattern-with-oneof': import("../types.js").GraphQLESLintRule;
     'selection-set-depth': import("../types.js").GraphQLESLintRule<{
         ignore?: string[] | undefined;

package/typings/rules/index.d.ts

@@ -92,6 +92,7 @@ export declare const rules: {
     }[], true>;
     'require-import-fragment': import("../types.js").GraphQLESLintRule;
     'require-nullable-fields-with-oneof': import("../types.js").GraphQLESLintRule;
+    'require-nullable-result-in-root': import("../types.js").GraphQLESLintRule;
     'require-type-pattern-with-oneof': import("../types.js").GraphQLESLintRule;
     'selection-set-depth': import("../types.js").GraphQLESLintRule<{
         ignore?: string[] | undefined;

package/typings/rules/require-nullable-result-in-root.d.cts

@@ -0,0 +1,2 @@
+import { GraphQLESLintRule } from '../types.cjs';
+export declare const rule: GraphQLESLintRule;

package/typings/rules/require-nullable-result-in-root.d.ts

@@ -0,0 +1,2 @@
+import { GraphQLESLintRule } from '../types.js';
+export declare const rule: GraphQLESLintRule;