@graphql-eslint/eslint-plugin 3.14.0-alpha-20221222204329-42a81c5 → 3.14.0-alpha-20221222211011-998efb7

package/cjs/configs/operations-all.js

@@ -24,6 +24,7 @@ exports.default = {
                 fragment: 'kebab-case',
             },
         ],
+        '@graphql-eslint/no-one-place-fragments': 'error',
         '@graphql-eslint/unique-fragment-name': 'error',
         '@graphql-eslint/unique-operation-name': 'error',
     },

package/cjs/rules/index.js

@@ -16,6 +16,7 @@ const no_case_insensitive_enum_values_duplicates_1 = require("./no-case-insensit
 const no_deprecated_1 = require("./no-deprecated");
 const no_duplicate_fields_1 = require("./no-duplicate-fields");
 const no_hashtag_description_1 = require("./no-hashtag-description");
+const no_one_place_fragments_1 = require("./no-one-place-fragments");
 const no_root_type_1 = require("./no-root-type");
 const no_scalar_result_type_on_mutation_1 = require("./no-scalar-result-type-on-mutation");
 const no_typename_prefix_1 = require("./no-typename-prefix");
@@ -49,6 +50,7 @@ exports.rules = {
     'no-deprecated': no_deprecated_1.rule,
     'no-duplicate-fields': no_duplicate_fields_1.rule,
     'no-hashtag-description': no_hashtag_description_1.rule,
+    'no-one-place-fragments': no_one_place_fragments_1.rule,
     'no-root-type': no_root_type_1.rule,
     'no-scalar-result-type-on-mutation': no_scalar_result_type_on_mutation_1.rule,
     'no-typename-prefix': no_typename_prefix_1.rule,

package/cjs/rules/no-one-place-fragments.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = void 0;
+const eslint_plugin_1 = require("@graphql-eslint/eslint-plugin");
+const utils_1 = require("../utils");
+const path_1 = require("path");
+const graphql_1 = require("graphql");
+const RULE_ID = 'no-one-place-fragments';
+exports.rule = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            category: 'Operations',
+            description: 'Disallow fragments that are used only in one place.',
+            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            examples: [
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            fragment UserFields on User {
+              id
+            }
+
+            {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    code: /* GraphQL */ `
+            fragment UserFields on User {
+              id
+            }
+
+            {
+              user {
+                ...UserFields
+                friends {
+                  ...UserFields
+                }
+              }
+            }
+          `,
+                },
+            ],
+            requiresSiblings: true,
+        },
+        messages: {
+            [RULE_ID]: 'Fragment `{{fragmentName}}` used only once. Inline him in "{{filePath}}".',
+        },
+        schema: [],
+    },
+    create(context) {
+        const operations = (0, eslint_plugin_1.requireSiblingsOperations)(RULE_ID, context);
+        const allDocuments = [...operations.getOperations(), ...operations.getFragments()];
+        const usedFragmentsMap = Object.create(null);
+        for (const { document, filePath } of allDocuments) {
+            const relativeFilePath = (0, path_1.relative)(utils_1.CWD, filePath);
+            (0, graphql_1.visit)(document, {
+                FragmentSpread({ name }) {
+                    const spreadName = name.value;
+                    usedFragmentsMap[spreadName] || (usedFragmentsMap[spreadName] = []);
+                    usedFragmentsMap[spreadName].push(relativeFilePath);
+                },
+            });
+        }
+        return {
+            'FragmentDefinition > Name'(node) {
+                const fragmentName = node.value;
+                const fragmentUsage = usedFragmentsMap[fragmentName];
+                if (fragmentUsage.length === 1) {
+                    context.report({
+                        node,
+                        messageId: RULE_ID,
+                        data: { fragmentName, filePath: fragmentUsage[0] },
+                    });
+                }
+            },
+        };
+    },
+};

package/docs/README.md

@@ -36,6 +36,7 @@ Name            &nbs
 [no-duplicate-fields](rules/no-duplicate-fields.md)|Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.|![recommended][]|📦|🚀|💡
 [no-fragment-cycles](rules/no-fragment-cycles.md)|A GraphQL fragment is only valid when it does not have cycles in fragments usage.|![recommended][]|📦|🔮|
 [no-hashtag-description](rules/no-hashtag-description.md)|Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.|![recommended][]|📄|🚀|💡
+[no-one-place-fragments](rules/no-one-place-fragments.md)|Disallow fragments that are used only in one place.|![all][]|📦|🚀|
 [no-root-type](rules/no-root-type.md)|Disallow using root types `mutation` and/or `subscription`.||📄|🚀|💡
 [no-scalar-result-type-on-mutation](rules/no-scalar-result-type-on-mutation.md)|Avoid scalar result type on mutation type to make sure to return a valid state.|![all][]|📄|🚀|💡
 [no-typename-prefix](rules/no-typename-prefix.md)|Enforces users to avoid using the type name in a field name while defining your schema.|![recommended][]|📄|🚀|💡

package/docs/rules/no-one-place-fragments.md

@@ -0,0 +1,51 @@
+# `no-one-place-fragments`
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-one-place-fragments`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `true`
+  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Disallow fragments that are used only in one place.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-one-place-fragments: 'error'
+
+fragment UserFields on User {
+  id
+}
+
+{
+  user {
+    ...UserFields
+  }
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-one-place-fragments: 'error'
+
+fragment UserFields on User {
+  id
+}
+
+{
+  user {
+    ...UserFields
+    friends {
+      ...UserFields
+    }
+  }
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-one-place-fragments.ts)
+- [Test source](../../packages/plugin/tests/no-one-place-fragments.spec.ts)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.14.0-alpha-20221222204329-42a81c5",
+  "version": "3.14.0-alpha-20221222211011-998efb7",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/typings/configs/index.d.cts

@@ -125,6 +125,7 @@ export declare const configs: {
                 subscription: string;
                 fragment: string;
             })[];
+            '@graphql-eslint/no-one-place-fragments': string;
             '@graphql-eslint/unique-fragment-name': string;
             '@graphql-eslint/unique-operation-name': string;
         };

package/typings/configs/index.d.ts

@@ -125,6 +125,7 @@ export declare const configs: {
                 subscription: string;
                 fragment: string;
             })[];
+            '@graphql-eslint/no-one-place-fragments': string;
             '@graphql-eslint/unique-fragment-name': string;
             '@graphql-eslint/unique-operation-name': string;
         };

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

@@ -13,6 +13,7 @@ declare const _default: {
             subscription: string;
             fragment: string;
         })[];
+        '@graphql-eslint/no-one-place-fragments': string;
         '@graphql-eslint/unique-fragment-name': string;
         '@graphql-eslint/unique-operation-name': string;
     };

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

@@ -13,6 +13,7 @@ declare const _default: {
             subscription: string;
             fragment: string;
         })[];
+        '@graphql-eslint/no-one-place-fragments': string;
         '@graphql-eslint/unique-fragment-name': string;
         '@graphql-eslint/unique-operation-name': string;
     };

package/typings/rules/index.d.cts

@@ -61,6 +61,7 @@ export declare const rules: {
     'no-deprecated': import("..").GraphQLESLintRule<[], true>;
     'no-duplicate-fields': import("..").GraphQLESLintRule<any[], false>;
     'no-hashtag-description': import("..").GraphQLESLintRule<any[], false>;
+    'no-one-place-fragments': import("..").GraphQLESLintRule<any[], false>;
     'no-root-type': import("..").GraphQLESLintRule<{
         disallow: ("mutation" | "subscription")[];
     }[], false>;

package/typings/rules/index.d.ts

@@ -61,6 +61,7 @@ export declare const rules: {
     'no-deprecated': import("..").GraphQLESLintRule<[], true>;
     'no-duplicate-fields': import("..").GraphQLESLintRule<any[], false>;
     'no-hashtag-description': import("..").GraphQLESLintRule<any[], false>;
+    'no-one-place-fragments': import("..").GraphQLESLintRule<any[], false>;
     'no-root-type': import("..").GraphQLESLintRule<{
         disallow: ("mutation" | "subscription")[];
     }[], false>;

package/typings/rules/no-one-place-fragments.d.cts

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

package/typings/rules/no-one-place-fragments.d.ts

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