@graphql-eslint/eslint-plugin 2.3.1 → 2.3.2-alpha-99be3d2.0

package/docs/custom-rules.md

@@ -58,7 +58,7 @@ This is useful if you wish to use other GraphQL tools that works with the origin
 Here's an example for using original `graphql-js` validate method to validate `OperationDefinition`:
 
 ```ts
-import { validate } from 'graphql-js';
+import { validate } from 'graphql';
 import { requireGraphQLSchemaFromContext } from '@graphql-eslint/eslint-plugin';
 
 export const rule = {

package/index.js

@@ -15,6 +15,8 @@ const depthLimit = _interopDefault(require('graphql-depth-limit'));
 const graphqlTagPluck = require('@graphql-tools/graphql-tag-pluck');
 const graphqlConfig$1 = require('graphql-config');
 const codeFileLoader = require('@graphql-tools/code-file-loader');
+const eslint = require('eslint');
+const codeFrame = require('@babel/code-frame');
 
 /*
  * 🚨 IMPORTANT! Do not manually modify this file. Run: `yarn generate-configs`
@@ -242,6 +244,24 @@ const convertCase = (style, str) => {
             return lowerCase(str).replace(/ /g, '-');
     }
 };
+function getLocation(loc, fieldName = '', offset) {
+    const { start } = loc;
+    /*
+     * ESLint has 0-based column number
+     * https://eslint.org/docs/developer-guide/working-with-rules#contextreport
+     */
+    const { offsetStart = 1, offsetEnd = 1 } = offset !== null && offset !== void 0 ? offset : {};
+    return {
+        start: {
+            line: start.line,
+            column: start.column - offsetStart,
+        },
+        end: {
+            line: start.line,
+            column: start.column - offsetEnd + fieldName.length,
+        },
+    };
+}
 
 function extractRuleName(stack) {
     const match = (stack || '').match(/validation[/\\\\]rules[/\\\\](.*?)\.js:/) || [];
@@ -1370,7 +1390,8 @@ const rule$7 = {
                 var _a;
                 if (options.fileExtension && options.fileExtension !== fileExtension) {
                     context.report({
-                        node: documentNode,
+                        // Report on first character
+                        loc: { column: 0, line: 1 },
                         messageId: MATCH_EXTENSION,
                         data: {
                             fileExtension,
@@ -1402,7 +1423,8 @@ const rule$7 = {
                 const filenameWithExtension = filename + expectedExtension;
                 if (expectedFilename !== filenameWithExtension) {
                     context.report({
-                        node: documentNode,
+                        // Report on first character
+                        loc: { column: 0, line: 1 },
                         messageId: MATCH_STYLE,
                         data: {
                             expectedFilename,
@@ -3185,11 +3207,7 @@ const rule$m = {
 const RULE_NAME$3 = 'unique-fragment-name';
 const UNIQUE_FRAGMENT_NAME = 'UNIQUE_FRAGMENT_NAME';
 const checkNode = (context, node, ruleName, messageId) => {
-    var _a;
-    const documentName = (_a = node.name) === null || _a === void 0 ? void 0 : _a.value;
-    if (!documentName) {
-        return;
-    }
+    const documentName = node.name.value;
     const siblings = requireSiblingsOperations(ruleName, context);
     const siblingDocuments = node.kind === graphql.Kind.FRAGMENT_DEFINITION ? siblings.getFragment(documentName) : siblings.getOperation(documentName);
     const filepath = context.getFilename();
@@ -3200,7 +3218,6 @@ const checkNode = (context, node, ruleName, messageId) => {
         return isSameName && !isSamePath;
     });
     if (conflictingDocuments.length > 0) {
-        const { start, end } = node.name.loc;
         context.report({
             messageId,
             data: {
@@ -3209,16 +3226,7 @@ const checkNode = (context, node, ruleName, messageId) => {
                     .map(f => `\t${path.relative(process.cwd(), getOnDiskFilepath(f.filePath))}`)
                     .join('\n'),
             },
-            loc: {
-                start: {
-                    line: start.line,
-                    column: start.column - 1,
-                },
-                end: {
-                    line: end.line,
-                    column: end.column - 1,
-                },
-            },
+            loc: getLocation(node.name.loc, documentName),
         });
     }
 };
@@ -3335,7 +3343,7 @@ const rule$o = {
     },
     create(context) {
         return {
-            OperationDefinition(node) {
+            'OperationDefinition[name!=undefined]'(node) {
                 checkNode(context, node, RULE_NAME$4, UNIQUE_OPERATION_NAME);
             },
         };
@@ -3765,22 +3773,92 @@ function parseForESLint(code, options = {}) {
     }
 }
 
-class GraphQLRuleTester extends require('eslint').RuleTester {
+class GraphQLRuleTester extends eslint.RuleTester {
     constructor(parserOptions = {}) {
-        super({
+        const config = {
             parser: require.resolve('@graphql-eslint/eslint-plugin'),
             parserOptions: {
                 ...parserOptions,
                 skipGraphQLConfig: true,
             },
-        });
+        };
+        super(config);
+        this.config = config;
     }
     fromMockFile(path$1) {
         return fs.readFileSync(path.resolve(__dirname, `../tests/mocks/${path$1}`), 'utf-8');
     }
     runGraphQLTests(name, rule, tests) {
         super.run(name, rule, tests);
+        // Skip snapshot testing if `expect` variable is not defined
+        if (typeof expect === 'undefined') {
+            return;
+        }
+        const linter = new eslint.Linter();
+        linter.defineRule(name, rule);
+        for (const testCase of tests.invalid) {
+            const verifyConfig = getVerifyConfig(name, this.config, testCase);
+            defineParser(linter, verifyConfig.parser);
+            const { code, filename } = testCase;
+            const messages = linter.verify(code, verifyConfig, { filename });
+            for (const message of messages) {
+                if (message.fatal) {
+                    throw new Error(message.message);
+                }
+                const messageForSnapshot = visualizeEslintMessage(code, message);
+                // eslint-disable-next-line no-undef
+                expect(messageForSnapshot).toMatchSnapshot();
+            }
+        }
+    }
+}
+function getVerifyConfig(ruleId, testerConfig, testCase) {
+    const { options, parserOptions, parser = testerConfig.parser } = testCase;
+    return {
+        ...testerConfig,
+        parser,
+        parserOptions: {
+            ...testerConfig.parserOptions,
+            ...parserOptions,
+        },
+        rules: {
+            [ruleId]: ['error', ...(Array.isArray(options) ? options : [])],
+        },
+    };
+}
+const parsers = new WeakMap();
+function defineParser(linter, parser) {
+    if (!parser) {
+        return;
+    }
+    if (!parsers.has(linter)) {
+        parsers.set(linter, new Set());
+    }
+    const defined = parsers.get(linter);
+    if (!defined.has(parser)) {
+        defined.add(parser);
+        linter.defineParser(parser, require(parser));
+    }
+}
+function visualizeEslintMessage(text, result) {
+    const { line, column, endLine, endColumn, message } = result;
+    const location = {
+        start: {
+            line,
+            column,
+        },
+    };
+    if (typeof endLine === 'number' && typeof endColumn === 'number') {
+        location.end = {
+            line: endLine,
+            column: endColumn,
+        };
     }
+    return codeFrame.codeFrameColumns(text, location, {
+        linesAbove: Number.POSITIVE_INFINITY,
+        linesBelow: Number.POSITIVE_INFINITY,
+        message,
+    });
 }
 
 exports.GraphQLRuleTester = GraphQLRuleTester;

package/index.mjs

@@ -9,6 +9,8 @@ import depthLimit from 'graphql-depth-limit';
 import { parseCode } from '@graphql-tools/graphql-tag-pluck';
 import { loadConfigSync, GraphQLConfig } from 'graphql-config';
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
+import { RuleTester, Linter } from 'eslint';
+import { codeFrameColumns } from '@babel/code-frame';
 
 /*
  * 🚨 IMPORTANT! Do not manually modify this file. Run: `yarn generate-configs`
@@ -236,6 +238,24 @@ const convertCase = (style, str) => {
             return lowerCase(str).replace(/ /g, '-');
     }
 };
+function getLocation(loc, fieldName = '', offset) {
+    const { start } = loc;
+    /*
+     * ESLint has 0-based column number
+     * https://eslint.org/docs/developer-guide/working-with-rules#contextreport
+     */
+    const { offsetStart = 1, offsetEnd = 1 } = offset !== null && offset !== void 0 ? offset : {};
+    return {
+        start: {
+            line: start.line,
+            column: start.column - offsetStart,
+        },
+        end: {
+            line: start.line,
+            column: start.column - offsetEnd + fieldName.length,
+        },
+    };
+}
 
 function extractRuleName(stack) {
     const match = (stack || '').match(/validation[/\\\\]rules[/\\\\](.*?)\.js:/) || [];
@@ -1364,7 +1384,8 @@ const rule$7 = {
                 var _a;
                 if (options.fileExtension && options.fileExtension !== fileExtension) {
                     context.report({
-                        node: documentNode,
+                        // Report on first character
+                        loc: { column: 0, line: 1 },
                         messageId: MATCH_EXTENSION,
                         data: {
                             fileExtension,
@@ -1396,7 +1417,8 @@ const rule$7 = {
                 const filenameWithExtension = filename + expectedExtension;
                 if (expectedFilename !== filenameWithExtension) {
                     context.report({
-                        node: documentNode,
+                        // Report on first character
+                        loc: { column: 0, line: 1 },
                         messageId: MATCH_STYLE,
                         data: {
                             expectedFilename,
@@ -3179,11 +3201,7 @@ const rule$m = {
 const RULE_NAME$3 = 'unique-fragment-name';
 const UNIQUE_FRAGMENT_NAME = 'UNIQUE_FRAGMENT_NAME';
 const checkNode = (context, node, ruleName, messageId) => {
-    var _a;
-    const documentName = (_a = node.name) === null || _a === void 0 ? void 0 : _a.value;
-    if (!documentName) {
-        return;
-    }
+    const documentName = node.name.value;
     const siblings = requireSiblingsOperations(ruleName, context);
     const siblingDocuments = node.kind === Kind.FRAGMENT_DEFINITION ? siblings.getFragment(documentName) : siblings.getOperation(documentName);
     const filepath = context.getFilename();
@@ -3194,7 +3212,6 @@ const checkNode = (context, node, ruleName, messageId) => {
         return isSameName && !isSamePath;
     });
     if (conflictingDocuments.length > 0) {
-        const { start, end } = node.name.loc;
         context.report({
             messageId,
             data: {
@@ -3203,16 +3220,7 @@ const checkNode = (context, node, ruleName, messageId) => {
                     .map(f => `\t${relative(process.cwd(), getOnDiskFilepath(f.filePath))}`)
                     .join('\n'),
             },
-            loc: {
-                start: {
-                    line: start.line,
-                    column: start.column - 1,
-                },
-                end: {
-                    line: end.line,
-                    column: end.column - 1,
-                },
-            },
+            loc: getLocation(node.name.loc, documentName),
         });
     }
 };
@@ -3329,7 +3337,7 @@ const rule$o = {
     },
     create(context) {
         return {
-            OperationDefinition(node) {
+            'OperationDefinition[name!=undefined]'(node) {
                 checkNode(context, node, RULE_NAME$4, UNIQUE_OPERATION_NAME);
             },
         };
@@ -3759,22 +3767,92 @@ function parseForESLint(code, options = {}) {
     }
 }
 
-class GraphQLRuleTester extends require('eslint').RuleTester {
+class GraphQLRuleTester extends RuleTester {
     constructor(parserOptions = {}) {
-        super({
+        const config = {
             parser: require.resolve('@graphql-eslint/eslint-plugin'),
             parserOptions: {
                 ...parserOptions,
                 skipGraphQLConfig: true,
             },
-        });
+        };
+        super(config);
+        this.config = config;
     }
     fromMockFile(path) {
         return readFileSync(resolve(__dirname, `../tests/mocks/${path}`), 'utf-8');
     }
     runGraphQLTests(name, rule, tests) {
         super.run(name, rule, tests);
+        // Skip snapshot testing if `expect` variable is not defined
+        if (typeof expect === 'undefined') {
+            return;
+        }
+        const linter = new Linter();
+        linter.defineRule(name, rule);
+        for (const testCase of tests.invalid) {
+            const verifyConfig = getVerifyConfig(name, this.config, testCase);
+            defineParser(linter, verifyConfig.parser);
+            const { code, filename } = testCase;
+            const messages = linter.verify(code, verifyConfig, { filename });
+            for (const message of messages) {
+                if (message.fatal) {
+                    throw new Error(message.message);
+                }
+                const messageForSnapshot = visualizeEslintMessage(code, message);
+                // eslint-disable-next-line no-undef
+                expect(messageForSnapshot).toMatchSnapshot();
+            }
+        }
+    }
+}
+function getVerifyConfig(ruleId, testerConfig, testCase) {
+    const { options, parserOptions, parser = testerConfig.parser } = testCase;
+    return {
+        ...testerConfig,
+        parser,
+        parserOptions: {
+            ...testerConfig.parserOptions,
+            ...parserOptions,
+        },
+        rules: {
+            [ruleId]: ['error', ...(Array.isArray(options) ? options : [])],
+        },
+    };
+}
+const parsers = new WeakMap();
+function defineParser(linter, parser) {
+    if (!parser) {
+        return;
+    }
+    if (!parsers.has(linter)) {
+        parsers.set(linter, new Set());
+    }
+    const defined = parsers.get(linter);
+    if (!defined.has(parser)) {
+        defined.add(parser);
+        linter.defineParser(parser, require(parser));
+    }
+}
+function visualizeEslintMessage(text, result) {
+    const { line, column, endLine, endColumn, message } = result;
+    const location = {
+        start: {
+            line,
+            column,
+        },
+    };
+    if (typeof endLine === 'number' && typeof endColumn === 'number') {
+        location.end = {
+            line: endLine,
+            column: endColumn,
+        };
     }
+    return codeFrameColumns(text, location, {
+        linesAbove: Number.POSITIVE_INFINITY,
+        linesBelow: Number.POSITIVE_INFINITY,
+        message,
+    });
 }
 
 export { GraphQLRuleTester, configs, convertDescription, convertLocation, convertRange, convertToESTree, extractCommentsFromAst, getBaseType, isNodeWithDescription, parse, parseForESLint, processors, rules, valueFromNode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "2.3.1",
+  "version": "2.3.2-alpha-99be3d2.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"

package/testkit.d.ts

@@ -13,8 +13,11 @@ export declare type GraphQLInvalidTestCase<T> = GraphQLValidTestCase<T> & {
     errors: number | Array<RuleTester.TestCaseError | string>;
     output?: string | null;
 };
-declare const GraphQLRuleTester_base: any;
-export declare class GraphQLRuleTester extends GraphQLRuleTester_base {
+export declare class GraphQLRuleTester extends RuleTester {
+    config: {
+        parser: string;
+        parserOptions: ParserOptions;
+    };
     constructor(parserOptions?: ParserOptions);
     fromMockFile(path: string): string;
     runGraphQLTests<Config>(name: string, rule: GraphQLESLintRule, tests: {
@@ -22,4 +25,3 @@ export declare class GraphQLRuleTester extends GraphQLRuleTester_base {
         invalid: GraphQLInvalidTestCase<Config>[];
     }): void;
 }
-export {};

package/utils.d.ts

@@ -33,4 +33,8 @@ export declare enum CaseStyle {
 }
 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?: {
+    offsetStart?: number;
+    offsetEnd?: number;
+}): AST.SourceLocation;
 export {};