@codingame/monaco-vscode-api - npm Package Compare versions

Comparing version 1.67.7 to 1.67.8

package.json

 {
   "name": "@codingame/monaco-vscode-api",
-  "version": "1.67.7",
+  "version": "1.67.8",
   "private": false,
@@ -5,0 +5,0 @@ "description": "VSCode public API plugged on the monaco editor",

README.md

 # @codingame/monaco-vscode-api · [![monthly downloads](https://img.shields.io/npm/dm/@codingame/monaco-vscode-api)](https://www.npmjs.com/package/@codingame/monaco-vscode-api) [![npm version](https://img.shields.io/npm/v/@codingame/monaco-vscode-api.svg?style=flat)](https://www.npmjs.com/package/@codingame/monaco-vscode-api) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/codingame/monaco-vscode-api/pulls)
 
-[NPM module](https://www.npmjs.com/) that respects the vscode api and redirect calls to monaco editor.
+[NPM module](https://www.npmjs.com/) that implements the VSCode api and redirects calls to Monaco editor.
 
-Some features not supported by monaco (type hierarchy, call hierarchy...) can be implemented by hands:
+The VSCode api is composed of:
+
+- A lot of classes and tools, which are exported the same way as in VSCode.
+- Some features that are supported by Monaco (Language feature registrations...) which are just forwarded to it (with some transformations)
+- Some features that are not supported by Monaco, and in such case:
+  - If it's an important feature: we let the user implement it as they wish.
+  - If it's some advanced features that don't make a lot of sense on Monaco (debug, tests...), it just throws an error when you try to use it.
+
+
+To implement by hands the optional features (type hierarchy, call hierarchy...), you can use the `Services` namespace from `vscode/services`:
 ```typescript
@@ -28,3 +37,3 @@ import { Services } from 'vscode/services'
 
-Just import it as if you were in a vscode extensions:
+Just import it as if you were in a vscode extension:
 
@@ -37,2 +46,1 @@ ```typescript
 ```
-

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

45

increased by21.62%

Worsened metrics

Total package byte prevSize

1533832

Lines of code

37381

decreased by-0.03%

No dependency changes