improvement: cleaner types for monaco-graphql (#1549)

Author: acao

examples/monaco-graphql-webpack/src/index.ts

@@ -4,9 +4,9 @@ import 'regenerator-runtime/runtime';
 import 'monaco-graphql/esm/monaco.contribution';
 
 // eslint-disable-next-line spaced-comment
-/// <reference path='../../../node_modules/monaco-editor/monaco.d.ts'/>
+/// <reference types='monaco-editor'/>
 // eslint-disable-next-line spaced-comment
-/// <reference path='../../../packages/monaco-graphql/src/typings/monaco.d.ts'/>
+///  <reference types='monaco-graphql'/>
 
 // NOTE: using loader syntax becuase Yaml worker imports editor.worker directly and that
 // import shouldn't go through loader syntax.
@@ -99,7 +99,17 @@ const operationEditor = monaco.editor.create(
   },
 );
 
-monaco.languages.graphql.graphqlDefaults.setSchemaConfig({ uri: SCHEMA_URL });
+monaco.languages.graphql.graphqlDefaults.setFormattingOptions({
+  // TODO: get these types working properly
+  prettierConfig: {
+    printWith: 120,
+  },
+});
+
+monaco.languages.graphql.graphqlDefaults.setSchemaConfig({
+  // TODO: get these types working properly
+  uri: SCHEMA_URL,
+});
 
 /**
  * Basic Operation Exec Example

packages/monaco-graphql/package.json

@@ -4,7 +4,7 @@
   "version": "0.1.1",
   "main": "dist/monaco.contribution.js",
   "module": "esm/monaco.contribution.js",
-  "typings": "esm/typings/monaco.d.ts",
+  "typings": "src/typings/monaco.d.ts",
   "contributors": [
     {
       "name": "Peng Lyu",

packages/monaco-graphql/src/GraphQLWorker.ts

@@ -6,9 +6,9 @@
  */
 
 // eslint-disable-next-line spaced-comment
-/// <reference path='../../../node_modules/monaco-editor/monaco.d.ts'/>
+/// <reference types='monaco-editor'/>
 // eslint-disable-next-line spaced-comment
-/// <reference path='../../../packages/monaco-graphql/src/typings/monaco.d.ts'/>
+/// <reference types='monaco-graphql'/>
 
 import type { worker, editor, Position, IRange } from 'monaco-editor';
 

packages/monaco-graphql/src/typings/monaco.d.ts

@@ -6,16 +6,18 @@
  */
 
 // eslint-disable-next-line spaced-comment
-/// <reference path='../../../../node_modules/monaco-editor/monaco.d.ts'/>
+/// <reference types='monaco-editor'/>
 
 declare module monaco.languages.graphql {
-  import type { SchemaLoader, SchemaConfig } from 'graphql-language-service';
+  import type {
+    SchemaLoader,
+    SchemaConfig as SchemaConfiguration,
+    SchemaResponse,
+  } from 'graphql-language-service';
 
-  import type { GraphQLSchema } from 'graphql';
   import type { Options as PrettierConfig } from 'prettier';
 
   import { MonacoGraphQLApi } from '../api';
-
   export interface IDisposable {
     dispose(): void;
   }
@@ -28,9 +30,7 @@ declare module monaco.languages.graphql {
 
   export type FilePointer = string | string[];
 
-  export interface FormattingOptions {
-    prettierConfig: PrettierConfig;
-  }
+  export type FormattingOptions = PrettierConfig;
 
   export interface ModeConfiguration {
     /**
@@ -88,14 +88,12 @@ declare module monaco.languages.graphql {
     languageId: string;
     enableSchemaRequest: boolean;
     schemaConfig: SchemaConfig;
-    schemaLoader: () => Promise<GraphQLSchema>;
+    schemaLoader: () => Promise<SchemaResponse>;
     formattingOptions?: FormattingOptions;
   }
 
   export interface LanguageServiceDefaults {
-    readonly onDidChange: IEvent<
-      monaco.languages.graphql.LanguageServiceDefaults
-    >;
+    readonly onDidChange: IEvent<LanguageServiceDefaults>;
     readonly schemaConfig: SchemaConfig;
     readonly formattingOptions: FormattingOptions;
     readonly modeConfiguration: ModeConfiguration;