Remove optionalDependencies from API npm package and document to inst…

…all vscode types separately
karrtikr · Aug 4, 2023 · 598985c · 598985c
1 parent cabdf39
commit 598985c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 7 deletions.
diff --git a/pythonExtensionApi/README.md b/pythonExtensionApi/README.md
@@ -17,11 +17,14 @@ First we need to define a `package.json` for the extension that wants to use the
 	// Depend on the Python extension facade npm module to get easier API access to the
 	// core extension.
 	"dependencies": {
-		"@vscode/python-extension": "..."
+		"@vscode/python-extension": "...",
+        "@types/vscode": "..."
 	},
 }
 ```
 
+Update `"@types/vscode"` to [a recent version](https://code.visualstudio.com/updates/) of VS Code, say `"^1.81.0"` for VS Code version `"1.81"`, in case there are any conflicts.
+
 The actual source code to get the active environment to run some script could look like this:
 
 ```typescript

diff --git a/pythonExtensionApi/package-lock.json b/pythonExtensionApi/package-lock.json
diff --git a/pythonExtensionApi/package.json b/pythonExtensionApi/package.json
@@ -25,9 +25,6 @@
     "bugs": {
         "url": "https://github.com/Microsoft/vscode-python/issues"
     },
-    "optionalDependencies": {
-        "@types/vscode": "^1.78.0"
-    },
     "devDependencies": {
         "typescript": "5.0.4",
         "@types/vscode": "^1.78.0"