add config option to show error on invalid schema

graphql · Nov 18, 2023 · a6e5f6e · a6e5f6e
1 parent 1d28a4d
commit a6e5f6e
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/packages/cm6-graphql/src/interfaces.ts b/packages/cm6-graphql/src/interfaces.ts
@@ -4,6 +4,7 @@ import { GraphQLSchema } from 'graphql';
 import { ContextToken, CompletionItem } from 'graphql-language-service';
 import { Position } from './helpers';
 export interface GqlExtensionsOptions {
+  showErrorOnInvalidSchema?: boolean;
   onShowInDocs?: (field?: string, type?: string, parentType?: string) => void;
   onFillAllFields?: (
     view: EditorView,

diff --git a/packages/cm6-graphql/src/lint.ts b/packages/cm6-graphql/src/lint.ts
@@ -1,7 +1,12 @@
 import { Diagnostic, linter } from '@codemirror/lint';
 import { getDiagnostics } from 'graphql-language-service';
 import { Position, posToOffset } from './helpers';
-import { getSchema, optionsStateField, schemaStateField } from './state';
+import {
+  getOpts,
+  getSchema,
+  optionsStateField,
+  schemaStateField,
+} from './state';
 import { Extension } from '@codemirror/state';
 import { validateSchema } from 'graphql';
 
@@ -10,11 +15,16 @@ const SEVERITY = ['error', 'warning', 'info'] as const;
 export const lint: Extension = linter(
   view => {
     const schema = getSchema(view.state);
+    const options = getOpts(view.state);
     if (!schema) {
       return [];
     }
     const validationErrors = validateSchema(schema);
     if (validationErrors.length) {
+      if (!options?.showErrorOnInvalidSchema) {
+        return [];
+      }
+
       const combinedError = validationErrors.map(error => {
         return error.message;
       });

diff --git a/packages/cm6-graphql/src/state.ts b/packages/cm6-graphql/src/state.ts
@@ -49,7 +49,14 @@ export const getOpts = (state: EditorState) => {
   return state.field(optionsStateField);
 };
 
+const defaultOpts: GqlExtensionsOptions = {
+  showErrorOnInvalidSchema: true,
+};
+
 export const stateExtensions = (
   schema?: GraphQLSchema,
   opts?: GqlExtensionsOptions,
-) => [schemaStateField.init(() => schema), optionsStateField.init(() => opts)];
+) => [
+  schemaStateField.init(() => schema),
+  optionsStateField.init(() => ({ ...defaultOpts, ...opts })),
+];