@graphql-eslint/eslint-plugin 3.1.1-alpha-f19a99b.0 → 3.2.0-alpha-001cd75.0

package/index.js

@@ -286,14 +286,6 @@ const TYPES_KINDS = [
     graphql.Kind.INPUT_OBJECT_TYPE_DEFINITION,
     graphql.Kind.UNION_TYPE_DEFINITION,
 ];
-var CaseStyle;
-(function (CaseStyle) {
-    CaseStyle["camelCase"] = "camelCase";
-    CaseStyle["pascalCase"] = "PascalCase";
-    CaseStyle["snakeCase"] = "snake_case";
-    CaseStyle["upperCase"] = "UPPER_CASE";
-    CaseStyle["kebabCase"] = "kebab-case";
-})(CaseStyle || (CaseStyle = {}));
 const pascalCase = (str) => lowerCase(str)
     .split(' ')
     .map(word => word.charAt(0).toUpperCase() + word.slice(1))
@@ -304,15 +296,15 @@ const camelCase = (str) => {
 };
 const convertCase = (style, str) => {
     switch (style) {
-        case CaseStyle.camelCase:
+        case 'camelCase':
             return camelCase(str);
-        case CaseStyle.pascalCase:
+        case 'PascalCase':
             return pascalCase(str);
-        case CaseStyle.snakeCase:
+        case 'snake_case':
             return lowerCase(str).replace(/ /g, '_');
-        case CaseStyle.upperCase:
+        case 'UPPER_CASE':
             return lowerCase(str).replace(/ /g, '_').toUpperCase();
-        case CaseStyle.kebabCase:
+        case 'kebab-case':
             return lowerCase(str).replace(/ /g, '-');
     }
 };
@@ -335,42 +327,30 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDoc(sourceNode, context, schema, documentNode, rules) {
-    if (documentNode.definitions.length === 0) {
-        return;
-    }
-    try {
-        const validationErrors = schema
-            ? graphql.validate(schema, documentNode, rules)
-            : validate.validateSDL(documentNode, null, rules);
-        for (const error of validationErrors) {
-            /*
-             * TODO: Fix ESTree-AST converter because currently it's incorrectly convert loc.end
-             * Example: loc.end always equal loc.start
-             *  {
-             *    token: {
-             *      type: 'Name',
-             *      loc: { start: { line: 4, column: 13 }, end: { line: 4, column: 13 } },
-             *      value: 'veryBad',
-             *      range: [ 40, 47 ]
-             *    }
-             *  }
-             */
-            const { line, column } = error.locations[0];
-            const ancestors = context.getAncestors();
-            const token = ancestors[0].tokens.find(token => token.loc.start.line === line && token.loc.start.column === column);
+function extractRuleName(stack) {
+    const match = (stack || '').match(/validation[/\\]rules[/\\](.*?)\.js:/) || [];
+    return match[1] || null;
+}
+function validateDoc(sourceNode, context, schema, documentNode, rules, ruleName = null) {
+    var _a;
+    if (((_a = documentNode === null || documentNode === void 0 ? void 0 : documentNode.definitions) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+        try {
+            const validationErrors = schema ? graphql.validate(schema, documentNode, rules) : validate.validateSDL(documentNode, null, rules);
+            for (const error of validationErrors) {
+                const validateRuleName = ruleName || `[${extractRuleName(error.stack)}]`;
+                context.report({
+                    loc: getLocation({ start: error.locations[0] }),
+                    message: ruleName ? error.message : `${validateRuleName} ${error.message}`,
+                });
+            }
+        }
+        catch (e) {
             context.report({
-                loc: getLocation({ start: error.locations[0] }, token === null || token === void 0 ? void 0 : token.value),
-                message: error.message,
+                node: sourceNode,
+                message: e.message,
             });
         }
     }
-    catch (e) {
-        context.report({
-            node: sourceNode,
-            message: e.message,
-        });
-    }
 }
 const isGraphQLImportFile = rawSDL => {
     const trimmedRawSDL = rawSDL.trimLeft();
@@ -417,7 +397,7 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
                         if (isRealFile && getDocumentNode) {
                             documentNode = getDocumentNode(context);
                         }
-                        validateDoc(node, context, schema, documentNode || node.rawNode(), [ruleFn]);
+                        validateDoc(node, context, schema, documentNode || node.rawNode(), [ruleFn], ruleName);
                     },
                 };
             },
@@ -1059,13 +1039,7 @@ const rule$2 = {
 const MATCH_EXTENSION = 'MATCH_EXTENSION';
 const MATCH_STYLE = 'MATCH_STYLE';
 const ACCEPTED_EXTENSIONS = ['.gql', '.graphql'];
-const CASE_STYLES = [
-    CaseStyle.camelCase,
-    CaseStyle.pascalCase,
-    CaseStyle.snakeCase,
-    CaseStyle.upperCase,
-    CaseStyle.kebabCase,
-];
+const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case'];
 const schemaOption = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
@@ -1089,7 +1063,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ query: CaseStyle.snakeCase }],
+                    usage: [{ query: 'snake_case' }],
                     code: /* GraphQL */ `
             # user_by_id.gql
             query UserById {
@@ -1103,7 +1077,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ fragment: { style: CaseStyle.kebabCase, suffix: '.fragment' } }],
+                    usage: [{ fragment: { style: 'kebab-case', suffix: '.fragment' } }],
                     code: /* GraphQL */ `
             # user-fields.fragment.gql
             fragment user_fields on User {
@@ -1114,7 +1088,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ mutation: { style: CaseStyle.pascalCase, suffix: 'Mutation' } }],
+                    usage: [{ mutation: { style: 'PascalCase', suffix: 'Mutation' } }],
                     code: /* GraphQL */ `
             # DeleteUserMutation.gql
             mutation DELETE_USER {
@@ -1134,7 +1108,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Incorrect',
-                    usage: [{ query: CaseStyle.pascalCase }],
+                    usage: [{ query: 'PascalCase' }],
                     code: /* GraphQL */ `
             # user-by-id.gql
             query UserById {
@@ -1149,10 +1123,10 @@ const rule$3 = {
             ],
             configOptions: [
                 {
-                    query: CaseStyle.kebabCase,
-                    mutation: CaseStyle.kebabCase,
-                    subscription: CaseStyle.kebabCase,
-                    fragment: CaseStyle.kebabCase,
+                    query: 'kebab-case',
+                    mutation: 'kebab-case',
+                    subscription: 'kebab-case',
+                    fragment: 'kebab-case',
                 },
             ],
         },
@@ -1169,25 +1143,22 @@ const rule$3 = {
                 asObject: {
                     type: 'object',
                     additionalProperties: false,
+                    minProperties: 1,
                     properties: {
-                        style: {
-                            enum: CASE_STYLES,
-                        },
-                        suffix: {
-                            type: 'string',
-                        },
+                        style: { enum: CASE_STYLES },
+                        suffix: { type: 'string' },
                     },
                 },
             },
             type: 'array',
+            minItems: 1,
             maxItems: 1,
             items: {
                 type: 'object',
                 additionalProperties: false,
+                minProperties: 1,
                 properties: {
-                    fileExtension: {
-                        enum: ACCEPTED_EXTENSIONS,
-                    },
+                    fileExtension: { enum: ACCEPTED_EXTENSIONS },
                     query: schemaOption,
                     mutation: schemaOption,
                     subscription: schemaOption,
@@ -1242,7 +1213,7 @@ const rule$3 = {
                     option = { style: option };
                 }
                 const expectedExtension = options.fileExtension || fileExtension;
-                const expectedFilename = convertCase(option.style, docName) + (option.suffix || '') + expectedExtension;
+                const expectedFilename = (option.style ? convertCase(option.style, docName) : filename) + (option.suffix || '') + expectedExtension;
                 const filenameWithExtension = filename + expectedExtension;
                 if (expectedFilename !== filenameWithExtension) {
                     context.report({
@@ -1394,6 +1365,7 @@ const rule$4 = {
                 ],
             },
         },
+        hasSuggestions: true,
         schema: {
             definitions: {
                 asString: {
@@ -1468,65 +1440,90 @@ const rule$4 = {
             const style = restOptions[kind] || types;
             return typeof style === 'object' ? style : { style };
         }
-        const checkNode = (selector) => (node) => {
-            const { name } = node.kind === graphql.Kind.VARIABLE_DEFINITION ? node.variable : node;
-            if (!name) {
+        const checkNode = (selector) => (n) => {
+            const { name: node } = n.kind === graphql.Kind.VARIABLE_DEFINITION ? n.variable : n;
+            if (!node) {
                 return;
             }
             const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style } = normalisePropertyOption(selector);
-            const nodeType = KindToDisplayName[node.kind] || node.kind;
-            const nodeName = name.value;
-            const errorMessage = getErrorMessage();
-            if (errorMessage) {
+            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;
                 context.report({
-                    loc: getLocation(name.loc, name.value),
+                    loc: getLocation(node.loc, node.value),
                     message: `${nodeType} "${nodeName}" should ${errorMessage}`,
+                    suggest: [
+                        {
+                            desc: `Rename to "${suggestedName}"`,
+                            fix: fixer => fixer.replaceText(node, suggestedName),
+                        },
+                    ],
                 });
             }
-            function getErrorMessage() {
-                let name = nodeName;
-                if (allowLeadingUnderscore) {
-                    name = name.replace(/^_*/, '');
-                }
-                if (allowTrailingUnderscore) {
-                    name = name.replace(/_*$/, '');
-                }
+            function getError() {
+                const name = nodeName.replace(/(^_+)|(_+$)/g, '');
                 if (prefix && !name.startsWith(prefix)) {
-                    return `have "${prefix}" prefix`;
+                    return {
+                        errorMessage: `have "${prefix}" prefix`,
+                        renameToName: prefix + name,
+                    };
                 }
                 if (suffix && !name.endsWith(suffix)) {
-                    return `have "${suffix}" suffix`;
+                    return {
+                        errorMessage: `have "${suffix}" suffix`,
+                        renameToName: name + suffix,
+                    };
                 }
                 const forbiddenPrefix = forbiddenPrefixes === null || forbiddenPrefixes === void 0 ? void 0 : forbiddenPrefixes.find(prefix => name.startsWith(prefix));
                 if (forbiddenPrefix) {
-                    return `not have "${forbiddenPrefix}" prefix`;
+                    return {
+                        errorMessage: `not have "${forbiddenPrefix}" prefix`,
+                        renameToName: name.replace(new RegExp(`^${forbiddenPrefix}`), ''),
+                    };
                 }
                 const forbiddenSuffix = forbiddenSuffixes === null || forbiddenSuffixes === void 0 ? void 0 : forbiddenSuffixes.find(suffix => name.endsWith(suffix));
                 if (forbiddenSuffix) {
-                    return `not have "${forbiddenSuffix}" suffix`;
-                }
-                if (style && !ALLOWED_STYLES.includes(style)) {
-                    return `be in one of the following options: ${ALLOWED_STYLES.join(', ')}`;
+                    return {
+                        errorMessage: `not have "${forbiddenSuffix}" suffix`,
+                        renameToName: name.replace(new RegExp(`${forbiddenSuffix}$`), ''),
+                    };
                 }
                 const caseRegex = StyleToRegex[style];
                 if (caseRegex && !caseRegex.test(name)) {
-                    return `be in ${style} format`;
+                    return {
+                        errorMessage: `be in ${style} format`,
+                        renameToName: convertCase(style, name),
+                    };
                 }
             }
         };
-        const checkUnderscore = (node) => {
+        const checkUnderscore = (isLeading) => (node) => {
             const name = node.value;
+            const renameToName = name.replace(new RegExp(isLeading ? '^_+' : '_+$'), '');
             context.report({
                 loc: getLocation(node.loc, name),
-                message: `${name.startsWith('_') ? 'Leading' : 'Trailing'} underscores are not allowed`,
+                message: `${isLeading ? 'Leading' : 'Trailing'} underscores are not allowed`,
+                suggest: [
+                    {
+                        desc: `Rename to "${renameToName}"`,
+                        fix: fixer => fixer.replaceText(node, renameToName),
+                    },
+                ],
             });
         };
         const listeners = {};
         if (!allowLeadingUnderscore) {
-            listeners['Name[value=/^_/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
+            listeners['Name[value=/^_/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] =
+                checkUnderscore(true);
         }
         if (!allowTrailingUnderscore) {
-            listeners['Name[value=/_$/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
+            listeners['Name[value=/_$/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] =
+                checkUnderscore(false);
         }
         const selectors = new Set([types && TYPES_KINDS, Object.keys(restOptions)].flat().filter(Boolean));
         for (const selector of selectors) {

package/index.mjs

@@ -280,14 +280,6 @@ const TYPES_KINDS = [
     Kind.INPUT_OBJECT_TYPE_DEFINITION,
     Kind.UNION_TYPE_DEFINITION,
 ];
-var CaseStyle;
-(function (CaseStyle) {
-    CaseStyle["camelCase"] = "camelCase";
-    CaseStyle["pascalCase"] = "PascalCase";
-    CaseStyle["snakeCase"] = "snake_case";
-    CaseStyle["upperCase"] = "UPPER_CASE";
-    CaseStyle["kebabCase"] = "kebab-case";
-})(CaseStyle || (CaseStyle = {}));
 const pascalCase = (str) => lowerCase(str)
     .split(' ')
     .map(word => word.charAt(0).toUpperCase() + word.slice(1))
@@ -298,15 +290,15 @@ const camelCase = (str) => {
 };
 const convertCase = (style, str) => {
     switch (style) {
-        case CaseStyle.camelCase:
+        case 'camelCase':
             return camelCase(str);
-        case CaseStyle.pascalCase:
+        case 'PascalCase':
             return pascalCase(str);
-        case CaseStyle.snakeCase:
+        case 'snake_case':
             return lowerCase(str).replace(/ /g, '_');
-        case CaseStyle.upperCase:
+        case 'UPPER_CASE':
             return lowerCase(str).replace(/ /g, '_').toUpperCase();
-        case CaseStyle.kebabCase:
+        case 'kebab-case':
             return lowerCase(str).replace(/ /g, '-');
     }
 };
@@ -329,42 +321,30 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDoc(sourceNode, context, schema, documentNode, rules) {
-    if (documentNode.definitions.length === 0) {
-        return;
-    }
-    try {
-        const validationErrors = schema
-            ? validate(schema, documentNode, rules)
-            : validateSDL(documentNode, null, rules);
-        for (const error of validationErrors) {
-            /*
-             * TODO: Fix ESTree-AST converter because currently it's incorrectly convert loc.end
-             * Example: loc.end always equal loc.start
-             *  {
-             *    token: {
-             *      type: 'Name',
-             *      loc: { start: { line: 4, column: 13 }, end: { line: 4, column: 13 } },
-             *      value: 'veryBad',
-             *      range: [ 40, 47 ]
-             *    }
-             *  }
-             */
-            const { line, column } = error.locations[0];
-            const ancestors = context.getAncestors();
-            const token = ancestors[0].tokens.find(token => token.loc.start.line === line && token.loc.start.column === column);
+function extractRuleName(stack) {
+    const match = (stack || '').match(/validation[/\\]rules[/\\](.*?)\.js:/) || [];
+    return match[1] || null;
+}
+function validateDoc(sourceNode, context, schema, documentNode, rules, ruleName = null) {
+    var _a;
+    if (((_a = documentNode === null || documentNode === void 0 ? void 0 : documentNode.definitions) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+        try {
+            const validationErrors = schema ? validate(schema, documentNode, rules) : validateSDL(documentNode, null, rules);
+            for (const error of validationErrors) {
+                const validateRuleName = ruleName || `[${extractRuleName(error.stack)}]`;
+                context.report({
+                    loc: getLocation({ start: error.locations[0] }),
+                    message: ruleName ? error.message : `${validateRuleName} ${error.message}`,
+                });
+            }
+        }
+        catch (e) {
             context.report({
-                loc: getLocation({ start: error.locations[0] }, token === null || token === void 0 ? void 0 : token.value),
-                message: error.message,
+                node: sourceNode,
+                message: e.message,
             });
         }
     }
-    catch (e) {
-        context.report({
-            node: sourceNode,
-            message: e.message,
-        });
-    }
 }
 const isGraphQLImportFile = rawSDL => {
     const trimmedRawSDL = rawSDL.trimLeft();
@@ -411,7 +391,7 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
                         if (isRealFile && getDocumentNode) {
                             documentNode = getDocumentNode(context);
                         }
-                        validateDoc(node, context, schema, documentNode || node.rawNode(), [ruleFn]);
+                        validateDoc(node, context, schema, documentNode || node.rawNode(), [ruleFn], ruleName);
                     },
                 };
             },
@@ -1053,13 +1033,7 @@ const rule$2 = {
 const MATCH_EXTENSION = 'MATCH_EXTENSION';
 const MATCH_STYLE = 'MATCH_STYLE';
 const ACCEPTED_EXTENSIONS = ['.gql', '.graphql'];
-const CASE_STYLES = [
-    CaseStyle.camelCase,
-    CaseStyle.pascalCase,
-    CaseStyle.snakeCase,
-    CaseStyle.upperCase,
-    CaseStyle.kebabCase,
-];
+const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case'];
 const schemaOption = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
@@ -1083,7 +1057,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ query: CaseStyle.snakeCase }],
+                    usage: [{ query: 'snake_case' }],
                     code: /* GraphQL */ `
             # user_by_id.gql
             query UserById {
@@ -1097,7 +1071,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ fragment: { style: CaseStyle.kebabCase, suffix: '.fragment' } }],
+                    usage: [{ fragment: { style: 'kebab-case', suffix: '.fragment' } }],
                     code: /* GraphQL */ `
             # user-fields.fragment.gql
             fragment user_fields on User {
@@ -1108,7 +1082,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Correct',
-                    usage: [{ mutation: { style: CaseStyle.pascalCase, suffix: 'Mutation' } }],
+                    usage: [{ mutation: { style: 'PascalCase', suffix: 'Mutation' } }],
                     code: /* GraphQL */ `
             # DeleteUserMutation.gql
             mutation DELETE_USER {
@@ -1128,7 +1102,7 @@ const rule$3 = {
                 },
                 {
                     title: 'Incorrect',
-                    usage: [{ query: CaseStyle.pascalCase }],
+                    usage: [{ query: 'PascalCase' }],
                     code: /* GraphQL */ `
             # user-by-id.gql
             query UserById {
@@ -1143,10 +1117,10 @@ const rule$3 = {
             ],
             configOptions: [
                 {
-                    query: CaseStyle.kebabCase,
-                    mutation: CaseStyle.kebabCase,
-                    subscription: CaseStyle.kebabCase,
-                    fragment: CaseStyle.kebabCase,
+                    query: 'kebab-case',
+                    mutation: 'kebab-case',
+                    subscription: 'kebab-case',
+                    fragment: 'kebab-case',
                 },
             ],
         },
@@ -1163,25 +1137,22 @@ const rule$3 = {
                 asObject: {
                     type: 'object',
                     additionalProperties: false,
+                    minProperties: 1,
                     properties: {
-                        style: {
-                            enum: CASE_STYLES,
-                        },
-                        suffix: {
-                            type: 'string',
-                        },
+                        style: { enum: CASE_STYLES },
+                        suffix: { type: 'string' },
                     },
                 },
             },
             type: 'array',
+            minItems: 1,
             maxItems: 1,
             items: {
                 type: 'object',
                 additionalProperties: false,
+                minProperties: 1,
                 properties: {
-                    fileExtension: {
-                        enum: ACCEPTED_EXTENSIONS,
-                    },
+                    fileExtension: { enum: ACCEPTED_EXTENSIONS },
                     query: schemaOption,
                     mutation: schemaOption,
                     subscription: schemaOption,
@@ -1236,7 +1207,7 @@ const rule$3 = {
                     option = { style: option };
                 }
                 const expectedExtension = options.fileExtension || fileExtension;
-                const expectedFilename = convertCase(option.style, docName) + (option.suffix || '') + expectedExtension;
+                const expectedFilename = (option.style ? convertCase(option.style, docName) : filename) + (option.suffix || '') + expectedExtension;
                 const filenameWithExtension = filename + expectedExtension;
                 if (expectedFilename !== filenameWithExtension) {
                     context.report({
@@ -1388,6 +1359,7 @@ const rule$4 = {
                 ],
             },
         },
+        hasSuggestions: true,
         schema: {
             definitions: {
                 asString: {
@@ -1462,65 +1434,90 @@ const rule$4 = {
             const style = restOptions[kind] || types;
             return typeof style === 'object' ? style : { style };
         }
-        const checkNode = (selector) => (node) => {
-            const { name } = node.kind === Kind.VARIABLE_DEFINITION ? node.variable : node;
-            if (!name) {
+        const checkNode = (selector) => (n) => {
+            const { name: node } = n.kind === Kind.VARIABLE_DEFINITION ? n.variable : n;
+            if (!node) {
                 return;
             }
             const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style } = normalisePropertyOption(selector);
-            const nodeType = KindToDisplayName[node.kind] || node.kind;
-            const nodeName = name.value;
-            const errorMessage = getErrorMessage();
-            if (errorMessage) {
+            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;
                 context.report({
-                    loc: getLocation(name.loc, name.value),
+                    loc: getLocation(node.loc, node.value),
                     message: `${nodeType} "${nodeName}" should ${errorMessage}`,
+                    suggest: [
+                        {
+                            desc: `Rename to "${suggestedName}"`,
+                            fix: fixer => fixer.replaceText(node, suggestedName),
+                        },
+                    ],
                 });
             }
-            function getErrorMessage() {
-                let name = nodeName;
-                if (allowLeadingUnderscore) {
-                    name = name.replace(/^_*/, '');
-                }
-                if (allowTrailingUnderscore) {
-                    name = name.replace(/_*$/, '');
-                }
+            function getError() {
+                const name = nodeName.replace(/(^_+)|(_+$)/g, '');
                 if (prefix && !name.startsWith(prefix)) {
-                    return `have "${prefix}" prefix`;
+                    return {
+                        errorMessage: `have "${prefix}" prefix`,
+                        renameToName: prefix + name,
+                    };
                 }
                 if (suffix && !name.endsWith(suffix)) {
-                    return `have "${suffix}" suffix`;
+                    return {
+                        errorMessage: `have "${suffix}" suffix`,
+                        renameToName: name + suffix,
+                    };
                 }
                 const forbiddenPrefix = forbiddenPrefixes === null || forbiddenPrefixes === void 0 ? void 0 : forbiddenPrefixes.find(prefix => name.startsWith(prefix));
                 if (forbiddenPrefix) {
-                    return `not have "${forbiddenPrefix}" prefix`;
+                    return {
+                        errorMessage: `not have "${forbiddenPrefix}" prefix`,
+                        renameToName: name.replace(new RegExp(`^${forbiddenPrefix}`), ''),
+                    };
                 }
                 const forbiddenSuffix = forbiddenSuffixes === null || forbiddenSuffixes === void 0 ? void 0 : forbiddenSuffixes.find(suffix => name.endsWith(suffix));
                 if (forbiddenSuffix) {
-                    return `not have "${forbiddenSuffix}" suffix`;
-                }
-                if (style && !ALLOWED_STYLES.includes(style)) {
-                    return `be in one of the following options: ${ALLOWED_STYLES.join(', ')}`;
+                    return {
+                        errorMessage: `not have "${forbiddenSuffix}" suffix`,
+                        renameToName: name.replace(new RegExp(`${forbiddenSuffix}$`), ''),
+                    };
                 }
                 const caseRegex = StyleToRegex[style];
                 if (caseRegex && !caseRegex.test(name)) {
-                    return `be in ${style} format`;
+                    return {
+                        errorMessage: `be in ${style} format`,
+                        renameToName: convertCase(style, name),
+                    };
                 }
             }
         };
-        const checkUnderscore = (node) => {
+        const checkUnderscore = (isLeading) => (node) => {
             const name = node.value;
+            const renameToName = name.replace(new RegExp(isLeading ? '^_+' : '_+$'), '');
             context.report({
                 loc: getLocation(node.loc, name),
-                message: `${name.startsWith('_') ? 'Leading' : 'Trailing'} underscores are not allowed`,
+                message: `${isLeading ? 'Leading' : 'Trailing'} underscores are not allowed`,
+                suggest: [
+                    {
+                        desc: `Rename to "${renameToName}"`,
+                        fix: fixer => fixer.replaceText(node, renameToName),
+                    },
+                ],
             });
         };
         const listeners = {};
         if (!allowLeadingUnderscore) {
-            listeners['Name[value=/^_/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
+            listeners['Name[value=/^_/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] =
+                checkUnderscore(true);
         }
         if (!allowTrailingUnderscore) {
-            listeners['Name[value=/_$/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] = checkUnderscore;
+            listeners['Name[value=/_$/]:matches([parent.kind!=Field], [parent.kind=Field][parent.alias])'] =
+                checkUnderscore(false);
         }
         const selectors = new Set([types && TYPES_KINDS, Object.keys(restOptions)].flat().filter(Boolean));
         for (const selector of selectors) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.1.1-alpha-f19a99b.0",
+  "version": "3.2.0-alpha-001cd75.0",
   "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 || ^16.0.0"

package/rules/graphql-js-validation.d.ts

@@ -1,5 +1,5 @@
 import { GraphQLSchema, DocumentNode, ASTNode, ValidationRule } from 'graphql';
 import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser';
-export declare function validateDoc(sourceNode: GraphQLESTreeNode<ASTNode>, context: GraphQLESLintRuleContext, schema: GraphQLSchema | null, documentNode: DocumentNode, rules: ReadonlyArray<ValidationRule>): void;
+export declare function validateDoc(sourceNode: GraphQLESTreeNode<ASTNode>, context: GraphQLESLintRuleContext, schema: GraphQLSchema | null, documentNode: DocumentNode, rules: ReadonlyArray<ValidationRule>, ruleName?: string | null): void;
 export declare const GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule<any[], false>>;

package/rules/index.d.ts

@@ -15,135 +15,8 @@ export declare const rules: {
         checkQueries?: boolean;
         checkMutations?: boolean;
     }], false>;
-    'match-document-filename': import("..").GraphQLESLintRule<[{
-        fileExtension?: ".gql" | ".graphql";
-        query?: import("../utils").CaseStyle | {
-            style: import("../utils").CaseStyle;
-            suffix: string;
-        };
-        mutation?: import("../utils").CaseStyle | {
-            style: import("../utils").CaseStyle;
-            suffix: string;
-        };
-        subscription?: import("../utils").CaseStyle | {
-            style: import("../utils").CaseStyle;
-            suffix: string;
-        };
-        fragment?: import("../utils").CaseStyle | {
-            style: import("../utils").CaseStyle;
-            suffix: string;
-        };
-    }], false>;
-    'naming-convention': import("..").GraphQLESLintRule<[{
-        allowLeadingUnderscore?: boolean;
-        allowTrailingUnderscore?: boolean;
-        types?: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-    } & {
-        [x: `OperationDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `VariableDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `Argument${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `FragmentDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `ScalarTypeDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `ObjectTypeDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `FieldDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `InputValueDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `InterfaceTypeDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `UnionTypeDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `EnumTypeDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `EnumValueDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `InputObjectTypeDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-        [x: `DirectiveDefinition${string}`]: ("PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case") | {
-            style?: "PascalCase" | "camelCase" | "UPPER_CASE" | "snake_case";
-            suffix?: string;
-            prefix?: string;
-            forbiddenPrefixes?: string[];
-            forbiddenSuffixes?: string[];
-        };
-    }], false>;
+    'match-document-filename': import("..").GraphQLESLintRule<[import("./match-document-filename").MatchDocumentFilenameRuleConfig], false>;
+    'naming-convention': import("..").GraphQLESLintRule<[import("./naming-convention").NamingConventionRuleConfig], false>;
     'no-anonymous-operations': import("..").GraphQLESLintRule<any[], false>;
     'no-case-insensitive-enum-values-duplicates': import("..").GraphQLESLintRule<any[], false>;
     'no-deprecated': import("..").GraphQLESLintRule<[], true>;

package/rules/match-document-filename.d.ts

@@ -2,10 +2,10 @@ import { CaseStyle } from '../utils';
 import { GraphQLESLintRule } from '../types';
 declare const ACCEPTED_EXTENSIONS: ['.gql', '.graphql'];
 declare type PropertySchema = {
-    style: CaseStyle;
-    suffix: string;
+    style?: CaseStyle;
+    suffix?: string;
 };
-declare type MatchDocumentFilenameRuleConfig = {
+export declare type MatchDocumentFilenameRuleConfig = {
     fileExtension?: typeof ACCEPTED_EXTENSIONS[number];
     query?: CaseStyle | PropertySchema;
     mutation?: CaseStyle | PropertySchema;

package/rules/naming-convention.d.ts

@@ -25,7 +25,7 @@ declare type PropertySchema = {
     forbiddenSuffixes?: string[];
 };
 declare type Options = AllowedStyle | PropertySchema;
-declare type NamingConventionRuleConfig = {
+export declare type NamingConventionRuleConfig = {
     allowLeadingUnderscore?: boolean;
     allowTrailingUnderscore?: boolean;
     types?: Options;

package/utils.d.ts

@@ -20,13 +20,7 @@ export declare const getOnDiskFilepath: (filepath: string) => string;
 export declare const getTypeName: (node: any) => any;
 export declare const loaderCache: Record<string, LoaderSource[]>;
 export declare const TYPES_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION];
-export declare enum CaseStyle {
-    camelCase = "camelCase",
-    pascalCase = "PascalCase",
-    snakeCase = "snake_case",
-    upperCase = "UPPER_CASE",
-    kebabCase = "kebab-case"
-}
+export declare type CaseStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE' | 'kebab-case';
 export declare const camelCase: (str: string) => string;
 export declare const convertCase: (style: CaseStyle, str: string) => string;
 export declare function getLocation(loc: Partial<AST.SourceLocation>, fieldName?: string, offset?: {