fix: use @sourcegraph/extension-api-classes (#5)

Provides proper implementations for these classes.
sourcegraph · Apr 30, 2019 · 2d74d6f · 2d74d6f
1 parent 68e025c
commit 2d74d6f
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 34 deletions.
diff --git a/package.json b/package.json
@@ -63,10 +63,10 @@
     "typescript": "^3.4.5"
   },
   "dependencies": {
+    "@sourcegraph/extension-api-classes": "^1.0.2",
     "@types/sinon": "7.0.11",
     "rxjs": "^6.5.1",
     "sinon": "^7.3.2",
-    "sourcegraph": "^23.0.0",
-    "vscode-languageserver-types": "^3.14.0"
+    "sourcegraph": "^23.0.1"
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1,24 +1,22 @@
+import { Location, MarkupKind, NotificationType, Position, Range, Selection } from '@sourcegraph/extension-api-classes'
 import { BehaviorSubject, Subject, Subscription } from 'rxjs'
 import { mapTo } from 'rxjs/operators'
 import * as sinon from 'sinon'
 import * as sourcegraph from 'sourcegraph'
-import { MarkupKind } from 'vscode-languageserver-types'
+import { deprecate } from 'util'
 
-const URI = URL
-type URI = URL
-
-// TODO publish actual classes of these!
-class Position {
-    constructor(public line: number, public character: number) {}
-}
-class Range {
-    constructor(public start: Position, public end: Position) {}
-}
-class Location {
-    constructor(public uri: URI, public range: Range) {}
+interface DeprecatedTypeDefinitionProvider {
+    provideTypeDefinition(
+        document: sourcegraph.TextDocument,
+        position: Position
+    ): sourcegraph.ProviderResult<sourcegraph.Definition>
 }
-class Selection {
-    constructor(public anchor: Position, public active: Position) {}
+
+interface DeprecatedImplementationProvider {
+    provideImplementation(
+        document: sourcegraph.TextDocument,
+        position: Position
+    ): sourcegraph.ProviderResult<sourcegraph.Definition>
 }
 
 let decorationTypeCounter = 0
@@ -33,15 +31,21 @@ export const createStubSourcegraphAPI = () => {
     const openedTextDocuments = new Subject<sourcegraph.TextDocument>()
     // const shims: typeof import('sourcegraph') = {
     const stubs = {
-        internal: {
-            sourcegraphURL: 'https://sourcegraph.test',
-        },
-        URI,
+        // Classes
+        URI: URL,
         Position,
         Range,
         Location,
         Selection,
+
+        // Enums
         MarkupKind,
+        NotificationType,
+
+        // Namespaces
+        internal: {
+            sourcegraphURL: 'https://sourcegraph.test',
+        },
         workspace: {
             onDidOpenTextDocument: openedTextDocuments,
             openedTextDocuments,
@@ -64,12 +68,18 @@ export const createStubSourcegraphAPI = () => {
                 (selector: sourcegraph.DocumentSelector, provider: sourcegraph.ReferenceProvider) => new Subscription()
             ),
             registerTypeDefinitionProvider: sinon.spy(
-                (selector: sourcegraph.DocumentSelector, provider: sourcegraph.TypeDefinitionProvider) =>
-                    new Subscription()
+                deprecate(
+                    (selector: sourcegraph.DocumentSelector, provider: DeprecatedTypeDefinitionProvider) =>
+                        new Subscription(),
+                    'sourcegraph.languages.registerTypeDefinitionProvider() is deprecated. Use sourcegraph.languages.registerLocationProvider() instead.'
+                )
             ),
             registerImplementationProvider: sinon.spy(
-                (selector: sourcegraph.DocumentSelector, provider: sourcegraph.ImplementationProvider) =>
-                    new Subscription()
+                deprecate(
+                    (selector: sourcegraph.DocumentSelector, provider: DeprecatedImplementationProvider) =>
+                        new Subscription(),
+                    'sourcegraph.languages.registerImplementationProvider() is deprecated. Use sourcegraph.languages.registerLocationProvider() instead.'
+                )
             ),
         },
         app: {

diff --git a/yarn.lock b/yarn.lock
@@ -399,6 +399,18 @@
   resolved "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.1.tgz#8da5c6530915653f3a1f38fd5f101d8c3f8079c5"
   integrity sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==
 
+"@sourcegraph/extension-api-classes@^1.0.2":
+  version "1.0.2"
+  resolved "https://registry.npmjs.org/@sourcegraph/extension-api-classes/-/extension-api-classes-1.0.2.tgz#e76ff8394deacffb7cb1edd5f5d24d714e6026ee"
+  integrity sha512-2PUTf/hedG+5DTyUmA2QPK7I/qyiwIbgQHcmAeRGlysg17okOeNFRp4AVLJsAh+NLq8poxtbyXP+dIdrCzONgw==
+  dependencies:
+    "@sourcegraph/extension-api-types" "^2.0.0"
+
+"@sourcegraph/extension-api-types@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.npmjs.org/@sourcegraph/extension-api-types/-/extension-api-types-2.0.0.tgz#b38145521c0549b2be300df53bac48b648ccbc2d"
+  integrity sha512-Te7F1RQJLBH4C8wQ2xz0nPC2vpe13F80V+Yv+c3GySOoh4DcLNN4P5u51Kh4aZPqeS5DJ7CKvHyX2SM/1EBXNg==
+
 "@sourcegraph/prettierrc@^2.2.0":
   version "2.2.0"
   resolved "https://registry.npmjs.org/@sourcegraph/prettierrc/-/prettierrc-2.2.0.tgz#af4a6fcd465b0a39a07ffbd8f2d3414d01e603e8"
@@ -5064,10 +5076,10 @@ source-map@^0.6.0, source-map@^0.6.1, source-map@~0.6.1:
   resolved "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
   integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==
 
-sourcegraph@^23.0.0:
-  version "23.0.0"
-  resolved "https://registry.npmjs.org/sourcegraph/-/sourcegraph-23.0.0.tgz#1fb96015af3e84cc9cc2944823f04a7e952ed565"
-  integrity sha512-hQALHrTt+AK5ZAqUAUNhxO7ClSv/xyTjMQPBb+hQykKJrMaHTk+CnJNHs7dRfXYKnbnZeisQRjaxKGX8UecU0Q==
+sourcegraph@^23.0.1:
+  version "23.0.1"
+  resolved "https://registry.npmjs.org/sourcegraph/-/sourcegraph-23.0.1.tgz#715fcf4129a6d94bc3bfd2740d9c706ae6357ffe"
+  integrity sha512-4We7zqhOagOVxNFdS6/xT/Crhb0Arw/9ytGBu8JuHfjo5yjMtcUYt22kZyu2TaPHXwyPW9muUi1eKSFA6Qg4lw==
 
 spawn-error-forwarder@~1.0.0:
   version "1.0.0"
@@ -5718,11 +5730,6 @@ verror@1.10.0:
     core-util-is "1.0.2"
     extsprintf "^1.2.0"
 
-vscode-languageserver-types@^3.14.0:
-  version "3.14.0"
-  resolved "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.14.0.tgz#d3b5952246d30e5241592b6dde8280e03942e743"
-  integrity sha512-lTmS6AlAlMHOvPQemVwo3CezxBp0sNB95KNPkqp3Nxd5VFEnuG1ByM0zlRWos0zjO3ZWtkvhal0COgiV1xIA4A==
-
 wcwidth@^1.0.0:
   version "1.0.1"
   resolved "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz#f0b0dcf915bc5ff1528afadb2c0e17b532da2fe8"