@graphql-eslint/eslint-plugin 3.14.0-alpha-20221222170519-5410a68 → 3.14.0-alpha-20221222175319-991733a

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-type-pattern-with-oneof': 'error',
     },
 };
 module.exports = exports.default;

package/cjs/rules/index.js

@@ -31,6 +31,7 @@ const require_description_1 = require("./require-description");
 const require_field_of_type_query_in_mutation_result_1 = require("./require-field-of-type-query-in-mutation-result");
 const require_id_when_available_1 = require("./require-id-when-available");
 const require_nullable_fields_with_oneof_1 = require("./require-nullable-fields-with-oneof");
+const require_type_pattern_with_oneof_1 = require("./require-type-pattern-with-oneof");
 const selection_set_depth_1 = require("./selection-set-depth");
 const strict_id_in_types_1 = require("./strict-id-in-types");
 const unique_fragment_name_1 = require("./unique-fragment-name");
@@ -63,6 +64,7 @@ exports.rules = {
     'require-field-of-type-query-in-mutation-result': require_field_of_type_query_in_mutation_result_1.rule,
     'require-id-when-available': require_id_when_available_1.rule,
     'require-nullable-fields-with-oneof': require_nullable_fields_with_oneof_1.rule,
+    'require-type-pattern-with-oneof': require_type_pattern_with_oneof_1.rule,
     'selection-set-depth': selection_set_depth_1.rule,
     'strict-id-in-types': strict_id_in_types_1.rule,
     'unique-fragment-name': unique_fragment_name_1.rule,

package/cjs/rules/require-nullable-fields-with-oneof.js

@@ -38,15 +38,15 @@ exports.rule = {
     },
     create(context) {
         return {
-            'Directive[name.value=oneOf]'(node) {
+            'Directive[name.value=oneOf]'({ parent, }) {
                 const isTypeOrInput = [
                     graphql_1.Kind.OBJECT_TYPE_DEFINITION,
                     graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION,
-                ].includes(node.parent.kind);
+                ].includes(parent.kind);
                 if (!isTypeOrInput) {
                     return;
                 }
-                for (const field of node.parent.fields) {
+                for (const field of parent.fields) {
                     if (field.gqlType.kind === graphql_1.Kind.NON_NULL_TYPE) {
                         context.report({
                             node: field.name,

package/cjs/rules/require-type-pattern-with-oneof.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = void 0;
+const RULE_ID = 'require-type-pattern-with-oneof';
+exports.rule = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            category: 'Schema',
+            description: 'Enforce types with `@oneOf` directive have `error` and `ok` fields.',
+            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            examples: [
+                {
+                    title: 'Correct',
+                    code: /* GraphQL */ `
+            type Mutation {
+              doSomething: DoSomethingMutationResult!
+            }
+
+            interface Error {
+              message: String!
+            }
+
+            type DoSomethingMutationResult @oneOf {
+              ok: DoSomethingSuccess
+              error: Error
+            }
+
+            type DoSomethingSuccess {
+              # ...
+            }
+          `,
+                },
+            ],
+        },
+        messages: {
+            [RULE_ID]: 'Type `{{typeName}}` should have `{{fieldName}}` field.',
+        },
+        schema: [],
+    },
+    create(context) {
+        return {
+            'Directive[name.value=oneOf][parent.kind=ObjectTypeDefinition]'({ parent, }) {
+                const requiredFields = ['error', 'ok'];
+                for (const fieldName of requiredFields) {
+                    if (!parent.fields.some(field => field.name.value === fieldName)) {
+                        context.report({
+                            node: parent.name,
+                            messageId: RULE_ID,
+                            data: {
+                                typeName: parent.name.value,
+                                fieldName,
+                            },
+                        });
+                    }
+                }
+            },
+        };
+    },
+};

package/docs/README.md

@@ -59,6 +59,7 @@ Name            &nbs
 [require-field-of-type-query-in-mutation-result](rules/require-field-of-type-query-in-mutation-result.md)|Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.|![all][]|📄|🚀|
 [require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|![recommended][]|📦|🚀|💡
 [require-nullable-fields-with-oneof](rules/require-nullable-fields-with-oneof.md)|Require are `input` or `type` fields be non nullable with `@oneOf` directive.|![all][]|📄|🚀|
+[require-type-pattern-with-oneof](rules/require-type-pattern-with-oneof.md)|Enforce types with `@oneOf` directive have `error` and `ok` fields.|![all][]|📄|🚀|
 [scalar-leafs](rules/scalar-leafs.md)|A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.|![recommended][]|📦|🔮|💡
 [selection-set-depth](rules/selection-set-depth.md)|Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).|![recommended][]|📦|🚀|💡
 [strict-id-in-types](rules/strict-id-in-types.md)|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.|![recommended][]|📄|🚀|

package/docs/rules/require-type-pattern-with-oneof.md

@@ -0,0 +1,39 @@
+# `require-type-pattern-with-oneof`
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/require-type-pattern-with-oneof`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false`
+  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Enforce types with `@oneOf` directive have `error` and `ok` fields.
+
+## Usage Examples
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/require-type-pattern-with-oneof: 'error'
+
+type Mutation {
+  doSomething: DoSomethingMutationResult!
+}
+
+interface Error {
+  message: String!
+}
+
+type DoSomethingMutationResult @oneOf {
+  ok: DoSomethingSuccess
+  error: Error
+}
+
+type DoSomethingSuccess {
+  # ...
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/require-type-pattern-with-oneof.ts)
+- [Test source](../../packages/plugin/tests/require-type-pattern-with-oneof.spec.ts)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.14.0-alpha-20221222170519-5410a68",
+  "version": "3.14.0-alpha-20221222175319-991733a",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/typings/configs/index.d.cts

@@ -58,6 +58,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-type-pattern-with-oneof': string;
         };
     };
     'operations-recommended': {

package/typings/configs/index.d.ts

@@ -58,6 +58,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-type-pattern-with-oneof': string;
         };
     };
     'operations-recommended': {

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-type-pattern-with-oneof': string;
     };
 };
 export default _default;

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-type-pattern-with-oneof': string;
     };
 };
 export default _default;

package/typings/rules/index.d.cts

@@ -88,6 +88,7 @@ export declare const rules: {
         fieldName?: string | string[];
     }[], true>;
     'require-nullable-fields-with-oneof': import("..").GraphQLESLintRule<any[], false>;
+    'require-type-pattern-with-oneof': import("..").GraphQLESLintRule<any[], false>;
     'selection-set-depth': import("..").GraphQLESLintRule<{
         ignore?: string[];
         maxDepth: number;

package/typings/rules/index.d.ts

@@ -88,6 +88,7 @@ export declare const rules: {
         fieldName?: string | string[];
     }[], true>;
     'require-nullable-fields-with-oneof': import("..").GraphQLESLintRule<any[], false>;
+    'require-type-pattern-with-oneof': import("..").GraphQLESLintRule<any[], false>;
     'selection-set-depth': import("..").GraphQLESLintRule<{
         ignore?: string[];
         maxDepth: number;

package/typings/rules/require-type-pattern-with-oneof.d.cts

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

package/typings/rules/require-type-pattern-with-oneof.d.ts

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