@graphql-eslint/eslint-plugin 3.3.0-alpha-1c01242.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/possible-type-extension.md

@@ -2,7 +2,7 @@
 
 - Category: `Schema`
 - Rule name: `@graphql-eslint/possible-type-extension`
-- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
 A type extension is only valid if the type is defined and has the same kind.

package/graphql-config.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLConfig } from 'graphql-config';
 import { ParserOptions } from './types';
-export declare function loadGraphQLConfig(options: ParserOptions): GraphQLConfig;
+export declare function loadGraphqlConfig(options: ParserOptions): GraphQLConfig;

package/index.js

@@ -12,7 +12,7 @@ const utils = require('@graphql-tools/utils');
 const lowerCase = _interopDefault(require('lodash.lowercase'));
 const depthLimit = _interopDefault(require('graphql-depth-limit'));
 const graphqlTagPluck = require('@graphql-tools/graphql-tag-pluck');
-const graphqlConfig = require('graphql-config');
+const graphqlConfig$1 = require('graphql-config');
 const codeFileLoader = require('@graphql-tools/code-file-loader');
 const eslint = require('eslint');
 const codeFrame = require('@babel/code-frame');
@@ -326,14 +326,14 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDocument(context, schema = null, documentNode, rule, isSchemaToExtend = false) {
+function validateDocument(sourceNode, context, schema, documentNode, rule) {
     if (documentNode.definitions.length === 0) {
         return;
     }
     try {
-        const validationErrors = schema && !isSchemaToExtend
+        const validationErrors = schema
             ? graphql.validate(schema, documentNode, [rule])
-            : validate.validateSDL(documentNode, schema, [rule]);
+            : validate.validateSDL(documentNode, null, [rule]);
         for (const error of validationErrors) {
             /*
              * TODO: Fix ESTree-AST converter because currently it's incorrectly convert loc.end
@@ -358,8 +358,7 @@ function validateDocument(context, schema = null, documentNode, rule, isSchemaTo
     }
     catch (e) {
         context.report({
-            // Report on first character
-            loc: { column: 0, line: 1 },
+            node: sourceNode,
             message: e.message,
         });
     }
@@ -441,18 +440,18 @@ const validationToRule = (ruleId, ruleName, docs, getDocumentNode) => {
                 },
             },
             create(context) {
-                if (!ruleFn) {
-                    // eslint-disable-next-line no-console
-                    console.warn(`You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`);
-                    return {};
-                }
-                const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                 return {
                     Document(node) {
+                        if (!ruleFn) {
+                            // eslint-disable-next-line no-console
+                            console.warn(`You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`);
+                            return;
+                        }
+                        const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                         const documentNode = getDocumentNode
                             ? getDocumentNode({ ruleId, context, schema, node: node.rawNode() })
                             : node.rawNode();
-                        validateDocument(context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
+                        validateDocument(node, context, schema, documentNode, ruleFn);
                     },
                 };
             },
@@ -602,9 +601,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
 }), validationToRule('possible-type-extension', 'PossibleTypeExtensions', {
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
-    recommended: false,
-    requiresSchema: true,
-    requiresSchemaToExtend: true,
+    recommended: false, // TODO: enable after https://github.com/dotansimha/graphql-eslint/issues/787 will be fixed
 }), validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],
     description: `A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.`,
@@ -1376,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
+            }
           `,
                 },
             ],
@@ -1445,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',
+                        },
                     },
                 },
             },
@@ -1499,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}`,
@@ -1521,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`,
@@ -1547,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),
@@ -3704,36 +3723,35 @@ function getSiblingOperations(options, gqlConfig) {
     return siblingOperations;
 }
 
-let graphQLConfig;
-function loadGraphQLConfig(options) {
+let graphqlConfig;
+function loadGraphqlConfig(options) {
     // We don't want cache config on test environment
     // Otherwise schema and documents will be same for all tests
-    if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
-        return graphQLConfig;
+    if (process.env.NODE_ENV !== 'test' && graphqlConfig) {
+        return graphqlConfig;
     }
     const onDiskConfig = options.skipGraphQLConfig
         ? null
-        : graphqlConfig.loadConfigSync({
+        : graphqlConfig$1.loadConfigSync({
             throwOnEmpty: false,
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],
         });
-    const configOptions = options.projects
-        ? { projects: options.projects }
-        : {
-            schema: (options.schema || ''),
-            documents: options.documents || options.operations,
-            extensions: options.extensions,
-            include: options.include,
-            exclude: options.exclude,
-        };
-    graphQLConfig =
+    graphqlConfig =
         onDiskConfig ||
-            new graphqlConfig.GraphQLConfig({
-                config: configOptions,
+            new graphqlConfig$1.GraphQLConfig({
+                config: options.projects
+                    ? { projects: options.projects }
+                    : {
+                        schema: (options.schema || ''),
+                        documents: options.documents || options.operations,
+                        extensions: options.extensions,
+                        include: options.include,
+                        exclude: options.exclude,
+                    },
                 filepath: 'virtual-config',
             }, [addCodeFileLoaderExtension]);
-    return graphQLConfig;
+    return graphqlConfig;
 }
 const addCodeFileLoaderExtension = api => {
     api.loaders.schema.register(new codeFileLoader.CodeFileLoader());
@@ -3823,18 +3841,10 @@ function parse(code, options) {
     return parseForESLint(code, options).ast;
 }
 function parseForESLint(code, options = {}) {
-    const gqlConfig = loadGraphQLConfig(options);
-    let schema;
-    try {
-        schema = getSchema(options, gqlConfig);
-    }
-    catch (e) {
-        e.message = `[graphql-eslint] Error while loading schema: ${e.message}`;
-        // eslint-disable-next-line no-console
-        console.error(e);
-    }
+    const gqlConfig = loadGraphqlConfig(options);
+    const schema = getSchema(options, gqlConfig);
     const parserServices = {
-        hasTypeInfo: Boolean(schema),
+        hasTypeInfo: schema !== null,
         schema,
         siblingOperations: getSiblingOperations(options, gqlConfig),
         reachableTypes: getReachableTypes,
@@ -3863,7 +3873,6 @@ function parseForESLint(code, options = {}) {
         };
     }
     catch (e) {
-        e.message = `[graphql-eslint] ${e.message}`;
         // In case of GraphQL parser error, we report it to ESLint as a parser error that matches the requirements
         // of ESLint. This will make sure to display it correctly in IDEs and lint results.
         if (e instanceof graphql.GraphQLError) {
@@ -3871,10 +3880,11 @@ function parseForESLint(code, options = {}) {
                 index: e.positions[0],
                 lineNumber: e.locations[0].line,
                 column: e.locations[0].column,
-                message: e.message,
+                message: `[graphql-eslint]: ${e.message}`,
             };
             throw eslintError;
         }
+        e.message = `[graphql-eslint]: ${e.message}`;
         throw e;
     }
 }

package/index.mjs

@@ -320,14 +320,14 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDocument(context, schema = null, documentNode, rule, isSchemaToExtend = false) {
+function validateDocument(sourceNode, context, schema, documentNode, rule) {
     if (documentNode.definitions.length === 0) {
         return;
     }
     try {
-        const validationErrors = schema && !isSchemaToExtend
+        const validationErrors = schema
             ? validate(schema, documentNode, [rule])
-            : validateSDL(documentNode, schema, [rule]);
+            : validateSDL(documentNode, null, [rule]);
         for (const error of validationErrors) {
             /*
              * TODO: Fix ESTree-AST converter because currently it's incorrectly convert loc.end
@@ -352,8 +352,7 @@ function validateDocument(context, schema = null, documentNode, rule, isSchemaTo
     }
     catch (e) {
         context.report({
-            // Report on first character
-            loc: { column: 0, line: 1 },
+            node: sourceNode,
             message: e.message,
         });
     }
@@ -435,18 +434,18 @@ const validationToRule = (ruleId, ruleName, docs, getDocumentNode) => {
                 },
             },
             create(context) {
-                if (!ruleFn) {
-                    // eslint-disable-next-line no-console
-                    console.warn(`You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`);
-                    return {};
-                }
-                const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                 return {
                     Document(node) {
+                        if (!ruleFn) {
+                            // eslint-disable-next-line no-console
+                            console.warn(`You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`);
+                            return;
+                        }
+                        const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                         const documentNode = getDocumentNode
                             ? getDocumentNode({ ruleId, context, schema, node: node.rawNode() })
                             : node.rawNode();
-                        validateDocument(context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
+                        validateDocument(node, context, schema, documentNode, ruleFn);
                     },
                 };
             },
@@ -596,9 +595,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
 }), validationToRule('possible-type-extension', 'PossibleTypeExtensions', {
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
-    recommended: false,
-    requiresSchema: true,
-    requiresSchemaToExtend: true,
+    recommended: false, // TODO: enable after https://github.com/dotansimha/graphql-eslint/issues/787 will be fixed
 }), validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],
     description: `A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.`,
@@ -1370,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
+            }
           `,
                 },
             ],
@@ -1439,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',
+                        },
                     },
                 },
             },
@@ -1493,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}`,
@@ -1515,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`,
@@ -1541,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),
@@ -3698,12 +3717,12 @@ function getSiblingOperations(options, gqlConfig) {
     return siblingOperations;
 }
 
-let graphQLConfig;
-function loadGraphQLConfig(options) {
+let graphqlConfig;
+function loadGraphqlConfig(options) {
     // We don't want cache config on test environment
     // Otherwise schema and documents will be same for all tests
-    if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
-        return graphQLConfig;
+    if (process.env.NODE_ENV !== 'test' && graphqlConfig) {
+        return graphqlConfig;
     }
     const onDiskConfig = options.skipGraphQLConfig
         ? null
@@ -3712,22 +3731,21 @@ function loadGraphQLConfig(options) {
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],
         });
-    const configOptions = options.projects
-        ? { projects: options.projects }
-        : {
-            schema: (options.schema || ''),
-            documents: options.documents || options.operations,
-            extensions: options.extensions,
-            include: options.include,
-            exclude: options.exclude,
-        };
-    graphQLConfig =
+    graphqlConfig =
         onDiskConfig ||
             new GraphQLConfig({
-                config: configOptions,
+                config: options.projects
+                    ? { projects: options.projects }
+                    : {
+                        schema: (options.schema || ''),
+                        documents: options.documents || options.operations,
+                        extensions: options.extensions,
+                        include: options.include,
+                        exclude: options.exclude,
+                    },
                 filepath: 'virtual-config',
             }, [addCodeFileLoaderExtension]);
-    return graphQLConfig;
+    return graphqlConfig;
 }
 const addCodeFileLoaderExtension = api => {
     api.loaders.schema.register(new CodeFileLoader());
@@ -3817,18 +3835,10 @@ function parse(code, options) {
     return parseForESLint(code, options).ast;
 }
 function parseForESLint(code, options = {}) {
-    const gqlConfig = loadGraphQLConfig(options);
-    let schema;
-    try {
-        schema = getSchema(options, gqlConfig);
-    }
-    catch (e) {
-        e.message = `[graphql-eslint] Error while loading schema: ${e.message}`;
-        // eslint-disable-next-line no-console
-        console.error(e);
-    }
+    const gqlConfig = loadGraphqlConfig(options);
+    const schema = getSchema(options, gqlConfig);
     const parserServices = {
-        hasTypeInfo: Boolean(schema),
+        hasTypeInfo: schema !== null,
         schema,
         siblingOperations: getSiblingOperations(options, gqlConfig),
         reachableTypes: getReachableTypes,
@@ -3857,7 +3867,6 @@ function parseForESLint(code, options = {}) {
         };
     }
     catch (e) {
-        e.message = `[graphql-eslint] ${e.message}`;
         // In case of GraphQL parser error, we report it to ESLint as a parser error that matches the requirements
         // of ESLint. This will make sure to display it correctly in IDEs and lint results.
         if (e instanceof GraphQLError) {
@@ -3865,10 +3874,11 @@ function parseForESLint(code, options = {}) {
                 index: e.positions[0],
                 lineNumber: e.locations[0].line,
                 column: e.locations[0].column,
-                message: e.message,
+                message: `[graphql-eslint]: ${e.message}`,
             };
             throw eslintError;
         }
+        e.message = `[graphql-eslint]: ${e.message}`;
         throw e;
     }
 }

package/package.json

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

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/types.d.ts

@@ -51,7 +51,6 @@ export declare type RuleDocsInfo<T> = {
         category: CategoryType | CategoryType[];
         requiresSchema?: true;
         requiresSiblings?: true;
-        requiresSchemaToExtend?: true;
         examples?: {
             title: string;
             code: string;