@graphql-eslint/eslint-plugin 3.3.0-alpha-0df1b98.0 → 3.3.0-alpha-d255c2b.0

package/docs/rules/naming-convention.md

@@ -71,6 +71,18 @@ type Query {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { FieldDefinition: { style: 'camelCase', ignorePattern: '^(EAN13|UPC|UK)' } }]
+
+type Product {
+  EAN13: String
+  UPC: String
+  UKFlag: String
+}
+```
+
 ## Config Schema
 
 > It's possible to use a [`selector`](https://eslint.org/docs/developer-guide/selectors) that starts with allowed `ASTNode` names which are described below.
@@ -276,6 +288,10 @@ Additional restrictions:
 * Minimum items: `1`
 * Unique items: `true`
 
+### `ignorePattern` (string)
+
+Option to skip validation of some words, e.g. acronyms
+
 ## Resources
 
 - [Rule source](../../packages/plugin/src/rules/naming-convention.ts)

package/docs/rules/require-id-when-available.md

@@ -23,7 +23,7 @@ type User {
 }
 
 # Query
-query {
+query user {
   user {
     name
   }
@@ -42,7 +42,7 @@ type User {
 }
 
 # Query
-query {
+query user {
   user {
     id
     name

package/index.js

@@ -1373,6 +1373,17 @@ const rule$4 = {
             type Query {
               users: [User!]!
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ FieldDefinition: { style: 'camelCase', ignorePattern: '^(EAN13|UPC|UK)' } }],
+                    code: /* GraphQL */ `
+            type Product {
+              EAN13: String
+              UPC: String
+              UKFlag: String
+            }
           `,
                 },
             ],
@@ -1442,6 +1453,10 @@ const rule$4 = {
                             minItems: 1,
                             items: { type: 'string' },
                         },
+                        ignorePattern: {
+                            type: 'string',
+                            description: 'Option to skip validation of some words, e.g. acronyms',
+                        },
                     },
                 },
             },
@@ -1496,15 +1511,15 @@ const rule$4 = {
             if (!node) {
                 return;
             }
-            const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style } = normalisePropertyOption(selector);
+            const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style, ignorePattern } = normalisePropertyOption(selector);
             const nodeType = KindToDisplayName[n.kind] || n.kind;
             const nodeName = node.value;
             const error = getError();
             if (error) {
                 const { errorMessage, renameToName } = error;
-                const [leadingUnderscore] = nodeName.match(/^_*/);
-                const [trailingUnderscore] = nodeName.match(/_*$/);
-                const suggestedName = leadingUnderscore + renameToName + trailingUnderscore;
+                const [leadingUnderscores] = nodeName.match(/^_*/);
+                const [trailingUnderscores] = nodeName.match(/_*$/);
+                const suggestedName = leadingUnderscores + renameToName + trailingUnderscores;
                 context.report({
                     loc: getLocation(node.loc, node.value),
                     message: `${nodeType} "${nodeName}" should ${errorMessage}`,
@@ -1518,6 +1533,9 @@ const rule$4 = {
             }
             function getError() {
                 const name = nodeName.replace(/(^_+)|(_+$)/g, '');
+                if (ignorePattern && new RegExp(ignorePattern, 'u').test(name)) {
+                    return;
+                }
                 if (prefix && !name.startsWith(prefix)) {
                     return {
                         errorMessage: `have "${prefix}" prefix`,
@@ -1544,8 +1562,12 @@ const rule$4 = {
                         renameToName: name.replace(new RegExp(`${forbiddenSuffix}$`), ''),
                     };
                 }
+                // Style is optional
+                if (!style) {
+                    return;
+                }
                 const caseRegex = StyleToRegex[style];
-                if (caseRegex && !caseRegex.test(name)) {
+                if (!caseRegex.test(name)) {
                     return {
                         errorMessage: `be in ${style} format`,
                         renameToName: convertCase(style, name),
@@ -2866,8 +2888,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const RULE_ID$2 = 'require-id-when-available';
-const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
+const REQUIRE_ID_WHEN_AVAILABLE = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
     meta: {
@@ -2875,7 +2896,7 @@ const rule$j = {
         docs: {
             category: 'Operations',
             description: 'Enforce selecting specific fields when they are available on the GraphQL type.',
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
+            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-id-when-available.md',
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -2889,7 +2910,7 @@ const rule$j = {
             }
 
             # Query
-            query {
+            query user {
               user {
                 name
               }
@@ -2906,7 +2927,7 @@ const rule$j = {
             }
 
             # Query
-            query {
+            query user {
               user {
                 id
                 name
@@ -2918,7 +2939,7 @@ const rule$j = {
             recommended: true,
         },
         messages: {
-            [MESSAGE_ID]: [
+            [REQUIRE_ID_WHEN_AVAILABLE]: [
                 `Field {{ fieldName }} must be selected when it's available on a type. Please make sure to include it in your selection set!`,
                 `If you are using fragments, make sure that all used fragments {{ checkedFragments }}specifies the field {{ fieldName }}.`,
             ].join('\n'),
@@ -2949,16 +2970,14 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext(RULE_ID$2, context);
-        const siblings = requireSiblingsOperations(RULE_ID$2, context);
+        requireGraphQLSchemaFromContext('require-id-when-available', context);
+        const siblings = requireSiblingsOperations('require-id-when-available', context);
         const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
-        const idNames = utils.asArray(fieldName);
+        const idNames = Array.isArray(fieldName) ? fieldName : [fieldName];
         const isFound = (s) => s.kind === graphql.Kind.FIELD && idNames.includes(s.name.value);
-        // Skip check selections in FragmentDefinition
-        const selector = 'OperationDefinition SelectionSet[parent.kind!=OperationDefinition]';
         return {
-            [selector](node) {
-                var _a;
+            SelectionSet(node) {
+                var _a, _b;
                 const typeInfo = node.typeInfo();
                 if (!typeInfo.gqlType) {
                     return;
@@ -2975,38 +2994,41 @@ const rule$j = {
                     return;
                 }
                 const checkedFragmentSpreads = new Set();
+                let found = false;
                 for (const selection of node.selections) {
                     if (isFound(selection)) {
-                        return;
+                        found = true;
                     }
-                    if (selection.kind === graphql.Kind.INLINE_FRAGMENT && selection.selectionSet.selections.some(isFound)) {
-                        return;
+                    else if (selection.kind === graphql.Kind.INLINE_FRAGMENT) {
+                        found = (_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections.some(s => isFound(s));
                     }
-                    if (selection.kind === graphql.Kind.FRAGMENT_SPREAD) {
+                    else if (selection.kind === graphql.Kind.FRAGMENT_SPREAD) {
                         const [foundSpread] = siblings.getFragment(selection.name.value);
                         if (foundSpread) {
                             checkedFragmentSpreads.add(foundSpread.document.name.value);
-                            if (foundSpread.document.selectionSet.selections.some(isFound)) {
-                                return;
-                            }
+                            found = (_b = foundSpread.document.selectionSet) === null || _b === void 0 ? void 0 : _b.selections.some(s => isFound(s));
                         }
                     }
+                    if (found) {
+                        break;
+                    }
                 }
                 const { parent } = node;
-                const hasIdFieldInInterfaceSelectionSet = (parent === null || parent === void 0 ? void 0 : parent.kind) === graphql.Kind.INLINE_FRAGMENT &&
-                    ((_a = parent.parent) === null || _a === void 0 ? void 0 : _a.kind) === graphql.Kind.SELECTION_SET &&
-                    parent.parent.selections.some(isFound);
-                if (hasIdFieldInInterfaceSelectionSet) {
-                    return;
+                const hasIdFieldInInterfaceSelectionSet = parent &&
+                    parent.kind === graphql.Kind.INLINE_FRAGMENT &&
+                    parent.parent &&
+                    parent.parent.kind === graphql.Kind.SELECTION_SET &&
+                    parent.parent.selections.some(s => isFound(s));
+                if (!found && !hasIdFieldInInterfaceSelectionSet) {
+                    context.report({
+                        loc: getLocation(node.loc),
+                        messageId: REQUIRE_ID_WHEN_AVAILABLE,
+                        data: {
+                            checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
+                            fieldName: idNames.map(name => `"${name}"`).join(' or '),
+                        },
+                    });
                 }
-                context.report({
-                    loc: getLocation(node.loc),
-                    messageId: MESSAGE_ID,
-                    data: {
-                        checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
-                        fieldName: idNames.map(name => `"${name}"`).join(' or '),
-                    },
-                });
             },
         };
     },

package/index.mjs

@@ -1367,6 +1367,17 @@ const rule$4 = {
             type Query {
               users: [User!]!
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ FieldDefinition: { style: 'camelCase', ignorePattern: '^(EAN13|UPC|UK)' } }],
+                    code: /* GraphQL */ `
+            type Product {
+              EAN13: String
+              UPC: String
+              UKFlag: String
+            }
           `,
                 },
             ],
@@ -1436,6 +1447,10 @@ const rule$4 = {
                             minItems: 1,
                             items: { type: 'string' },
                         },
+                        ignorePattern: {
+                            type: 'string',
+                            description: 'Option to skip validation of some words, e.g. acronyms',
+                        },
                     },
                 },
             },
@@ -1490,15 +1505,15 @@ const rule$4 = {
             if (!node) {
                 return;
             }
-            const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style } = normalisePropertyOption(selector);
+            const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style, ignorePattern } = normalisePropertyOption(selector);
             const nodeType = KindToDisplayName[n.kind] || n.kind;
             const nodeName = node.value;
             const error = getError();
             if (error) {
                 const { errorMessage, renameToName } = error;
-                const [leadingUnderscore] = nodeName.match(/^_*/);
-                const [trailingUnderscore] = nodeName.match(/_*$/);
-                const suggestedName = leadingUnderscore + renameToName + trailingUnderscore;
+                const [leadingUnderscores] = nodeName.match(/^_*/);
+                const [trailingUnderscores] = nodeName.match(/_*$/);
+                const suggestedName = leadingUnderscores + renameToName + trailingUnderscores;
                 context.report({
                     loc: getLocation(node.loc, node.value),
                     message: `${nodeType} "${nodeName}" should ${errorMessage}`,
@@ -1512,6 +1527,9 @@ const rule$4 = {
             }
             function getError() {
                 const name = nodeName.replace(/(^_+)|(_+$)/g, '');
+                if (ignorePattern && new RegExp(ignorePattern, 'u').test(name)) {
+                    return;
+                }
                 if (prefix && !name.startsWith(prefix)) {
                     return {
                         errorMessage: `have "${prefix}" prefix`,
@@ -1538,8 +1556,12 @@ const rule$4 = {
                         renameToName: name.replace(new RegExp(`${forbiddenSuffix}$`), ''),
                     };
                 }
+                // Style is optional
+                if (!style) {
+                    return;
+                }
                 const caseRegex = StyleToRegex[style];
-                if (caseRegex && !caseRegex.test(name)) {
+                if (!caseRegex.test(name)) {
                     return {
                         errorMessage: `be in ${style} format`,
                         renameToName: convertCase(style, name),
@@ -2860,8 +2882,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const RULE_ID$2 = 'require-id-when-available';
-const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
+const REQUIRE_ID_WHEN_AVAILABLE = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
     meta: {
@@ -2869,7 +2890,7 @@ const rule$j = {
         docs: {
             category: 'Operations',
             description: 'Enforce selecting specific fields when they are available on the GraphQL type.',
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
+            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-id-when-available.md',
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -2883,7 +2904,7 @@ const rule$j = {
             }
 
             # Query
-            query {
+            query user {
               user {
                 name
               }
@@ -2900,7 +2921,7 @@ const rule$j = {
             }
 
             # Query
-            query {
+            query user {
               user {
                 id
                 name
@@ -2912,7 +2933,7 @@ const rule$j = {
             recommended: true,
         },
         messages: {
-            [MESSAGE_ID]: [
+            [REQUIRE_ID_WHEN_AVAILABLE]: [
                 `Field {{ fieldName }} must be selected when it's available on a type. Please make sure to include it in your selection set!`,
                 `If you are using fragments, make sure that all used fragments {{ checkedFragments }}specifies the field {{ fieldName }}.`,
             ].join('\n'),
@@ -2943,16 +2964,14 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext(RULE_ID$2, context);
-        const siblings = requireSiblingsOperations(RULE_ID$2, context);
+        requireGraphQLSchemaFromContext('require-id-when-available', context);
+        const siblings = requireSiblingsOperations('require-id-when-available', context);
         const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
-        const idNames = asArray(fieldName);
+        const idNames = Array.isArray(fieldName) ? fieldName : [fieldName];
         const isFound = (s) => s.kind === Kind.FIELD && idNames.includes(s.name.value);
-        // Skip check selections in FragmentDefinition
-        const selector = 'OperationDefinition SelectionSet[parent.kind!=OperationDefinition]';
         return {
-            [selector](node) {
-                var _a;
+            SelectionSet(node) {
+                var _a, _b;
                 const typeInfo = node.typeInfo();
                 if (!typeInfo.gqlType) {
                     return;
@@ -2969,38 +2988,41 @@ const rule$j = {
                     return;
                 }
                 const checkedFragmentSpreads = new Set();
+                let found = false;
                 for (const selection of node.selections) {
                     if (isFound(selection)) {
-                        return;
+                        found = true;
                     }
-                    if (selection.kind === Kind.INLINE_FRAGMENT && selection.selectionSet.selections.some(isFound)) {
-                        return;
+                    else if (selection.kind === Kind.INLINE_FRAGMENT) {
+                        found = (_a = selection.selectionSet) === null || _a === void 0 ? void 0 : _a.selections.some(s => isFound(s));
                     }
-                    if (selection.kind === Kind.FRAGMENT_SPREAD) {
+                    else if (selection.kind === Kind.FRAGMENT_SPREAD) {
                         const [foundSpread] = siblings.getFragment(selection.name.value);
                         if (foundSpread) {
                             checkedFragmentSpreads.add(foundSpread.document.name.value);
-                            if (foundSpread.document.selectionSet.selections.some(isFound)) {
-                                return;
-                            }
+                            found = (_b = foundSpread.document.selectionSet) === null || _b === void 0 ? void 0 : _b.selections.some(s => isFound(s));
                         }
                     }
+                    if (found) {
+                        break;
+                    }
                 }
                 const { parent } = node;
-                const hasIdFieldInInterfaceSelectionSet = (parent === null || parent === void 0 ? void 0 : parent.kind) === Kind.INLINE_FRAGMENT &&
-                    ((_a = parent.parent) === null || _a === void 0 ? void 0 : _a.kind) === Kind.SELECTION_SET &&
-                    parent.parent.selections.some(isFound);
-                if (hasIdFieldInInterfaceSelectionSet) {
-                    return;
+                const hasIdFieldInInterfaceSelectionSet = parent &&
+                    parent.kind === Kind.INLINE_FRAGMENT &&
+                    parent.parent &&
+                    parent.parent.kind === Kind.SELECTION_SET &&
+                    parent.parent.selections.some(s => isFound(s));
+                if (!found && !hasIdFieldInInterfaceSelectionSet) {
+                    context.report({
+                        loc: getLocation(node.loc),
+                        messageId: REQUIRE_ID_WHEN_AVAILABLE,
+                        data: {
+                            checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
+                            fieldName: idNames.map(name => `"${name}"`).join(' or '),
+                        },
+                    });
                 }
-                context.report({
-                    loc: getLocation(node.loc),
-                    messageId: MESSAGE_ID,
-                    data: {
-                        checkedFragments: checkedFragmentSpreads.size === 0 ? '' : `(${[...checkedFragmentSpreads].join(', ')}) `,
-                        fieldName: idNames.map(name => `"${name}"`).join(' or '),
-                    },
-                });
             },
         };
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.3.0-alpha-0df1b98.0",
+  "version": "3.3.0-alpha-d255c2b.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/rules/index.d.ts

@@ -48,7 +48,9 @@ export declare const rules: {
         DirectiveDefinition?: boolean;
     }], false>;
     'require-field-of-type-query-in-mutation-result': import("..").GraphQLESLintRule<any[], false>;
-    'require-id-when-available': import("..").GraphQLESLintRule<[import("./require-id-when-available").RequireIdWhenAvailableRuleConfig], true>;
+    'require-id-when-available': import("..").GraphQLESLintRule<[{
+        fieldName: string;
+    }], true>;
     'selection-set-depth': import("..").GraphQLESLintRule<[{
         maxDepth: number;
         ignore?: string[];

package/rules/naming-convention.d.ts

@@ -23,6 +23,7 @@ declare type PropertySchema = {
     prefix?: string;
     forbiddenPrefixes?: string[];
     forbiddenSuffixes?: string[];
+    ignorePattern?: string;
 };
 declare type Options = AllowedStyle | PropertySchema;
 export declare type NamingConventionRuleConfig = {

package/rules/require-id-when-available.d.ts

@@ -1,6 +1,6 @@
 import { GraphQLESLintRule } from '../types';
-export declare type RequireIdWhenAvailableRuleConfig = {
-    fieldName: string | string[];
+declare type RequireIdWhenAvailableRuleConfig = {
+    fieldName: string;
 };
 declare const rule: GraphQLESLintRule<[RequireIdWhenAvailableRuleConfig], true>;
 export default rule;