monaco-languageclient 8.0.0-next.5 → 8.0.0

package/CHANGELOG.md

@@ -2,11 +2,14 @@
 
 All notable changes to this npm module are documented in this file.
 
-## [8.0.0] - 2024-03-0x
-
-- WIP: Repository now includes `monaco-editor-wrapper` and `@typefox/monaco-editor-react`
-- Updated to `@codingame/monaco-vscode-api@2.0.1`. This ensures amoung other things proper sematic versioning
-  - Details
+## [8.0.0] - 2024-03-18
+
+- Repository now includes `monaco-editor-wrapper` and `@typefox/monaco-editor-react`
+- Aligned LICENSE usage throughout the repository
+- Introduce new exports `vscode/services` where you find all mandatory functions related to `@codingame/monaco-vscode-api` service initialization
+- Updated to `@codingame/monaco-vscode-api@3.1.2` and `@codingame/monaco-vscode-editor-api@3.1.2`
+  - Proper sematic versioning, versions are now idenpendent of VSCode versioning scheme, but compatibility table is found [here](https://github.com/TypeFox/monaco-languageclient/blob/main/docs/versions-and-history.md#monaco-editor--codingamemonaco-vscode-api-compatibility-table).
+  - `@codingame/monaco-vscode-editor-api` is now the alias for `monaco-editor` It provides the full editor's full api and hereby removes the need for a treemended version.
 
 ## [7.3.0] - 2024-01-04
 

package/{License.txt → LICENSE}

@@ -1,9 +1,7 @@
-Copyright (c) 2018-2024 TypeFox GmbH (http://www.typefox.io)
-
-All rights reserved.
-
 MIT License
 
+Copyright 2018 - present TypeFox GmbH
+
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

package/README.md

@@ -8,12 +8,45 @@
 
 Module to connect [Monaco editor](https://microsoft.github.io/monaco-editor/) with [language servers](https://microsoft.github.io/language-server-protocol/).
 
-See [here](https://github.com/TypeFox/monaco-languageclient/blob/main/README.md) for a detailed documentation.
+## CHANGELOG
+
+All changes are noted in the [CHANGELOG](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/client/CHANGELOG.md).
+
+## Getting Started
+
+This is npm package is part of the <https://github.com/TypeFox/monaco-languageclient> mono repo. Please follow the main repositories [instructions]](<https://github.com/TypeFox/monaco-languageclient#getting-started>) to get started with local development.
+
+## Usage
+
+### NEW with v8: Own monaco-vscode-editor-api package
+
+Since version 2 (see [Important Project Changes](https://github.com/TypeFox/monaco-languageclient/blob/main/docs/versions-and-history.md#important-project-changes)) of this library we rely on [@codingame/monaco-vscode-api](https://github.com/CodinGame/monaco-vscode-api) to supply the vscode API. It evolved substantially since then and thesedays allows to use many vscode only services with `monaco-editor`. With v6 and v7 we "treemend" used a "treemended" version of `monaco-editor` which brought back monaco-editor code that was removed during bundling/threeshaking (*treemending*). This left users with the need to define overrides / resolution which was problematic.
+Therefore [monaco-vscode-editor-api](https://www.npmjs.com/package/@codingame/monaco-editor-wrapper) is now used and installed as an alias to `monaco-editor` because it provides the same api as the official monaco-editor.
+
+### Using services and extra packages from @codingame/monaco-vscode-api
 
-## History
+The bespoke projects not only supplies the api, but it provides 100+ packages with additional services, default extensions and language packs. By default when initalizing `monaco-languageclient` via the required `initServices` the following services are always loaded:
 
-For the history please see the [README](https://github.com/TypeFox/monaco-languageclient/blob/main/README.md#latest-important-project-changes) and [CHANGELOG](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/client/CHANGELOG.md).
+- *languages* and model *services* (always added by `monaco-languagclient`)
+- *layout*, *environment*, *extension*, *files* and *quickAccess* (always added by `monaco-vscode-api`)
+
+Please check the [following link](https://github.com/CodinGame/monaco-vscode-api#monaco-standalone-services) for information about all services supplied by [@codingame/monaco-vscode-api](https://github.com/CodinGame/monaco-vscode-api).
+
+Please check our examples [in the examples overview chapter](https://github.com/TypeFox/monaco-languageclient/tree/main?tab=readme-ov-file#examples-overview) as they demonstrate the usage.
+
+#### textmate and monarch
+
+If you use the `textmate` or `theme` services you are able to load textmate based grammars and theme definitions from vscode:
+
+```js
+import getThemeServiceOverride from '@codingame/monaco-vscode-theme-service-override';
+import getTextmateServiceOverride from '@codingame/monaco-vscode-textmate-service-override';
+```
+
+Once you those services you can no longer make use of monarch based grammars and themes.
+
+See [here](https://github.com/TypeFox/monaco-languageclient/blob/main/README.md) for a detailed documentation.
 
 ## License
 
-[MIT](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/client/License.txt)
+[MIT](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/client/LICENSE)

package/lib/index.js

@@ -1,6 +1,6 @@
 /* --------------------------------------------------------------------------------------------
  * Copyright (c) 2024 TypeFox GmbH (http://www.typefox.io). All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
+ * Licensed under the MIT License. See LICENSE in the package root for license information.
  * ------------------------------------------------------------------------------------------ */
 import { BaseLanguageClient } from 'vscode-languageclient/lib/common/client.js';
 export class MonacoLanguageClient extends BaseLanguageClient {

package/lib/vscode/services.js

@@ -1,6 +1,6 @@
 /* --------------------------------------------------------------------------------------------
  * Copyright (c) 2024 TypeFox GmbH (http://www.typefox.io). All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
+ * Licensed under the MIT License. See LICENSE in the package root for license information.
  * ------------------------------------------------------------------------------------------ */
 import { ILogService, initialize, StandaloneServices } from 'vscode/services';
 import getLanguagesServiceOverride from '@codingame/monaco-vscode-languages-service-override';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monaco-languageclient",
-  "version": "8.0.0-next.5",
+  "version": "8.0.0",
   "description": "Monaco Language client implementation",
   "author": {
     "name": "TypeFox GmbH",
@@ -52,7 +52,7 @@
     "src",
     "README.md",
     "CHANGELOG.md",
-    "License.txt"
+    "LICENSE"
   ],
   "dependencies": {
     "@codingame/monaco-vscode-languages-service-override": "~3.1.2",

package/src/index.ts

@@ -1,6 +1,6 @@
 /* --------------------------------------------------------------------------------------------
  * Copyright (c) 2024 TypeFox GmbH (http://www.typefox.io). All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
+ * Licensed under the MIT License. See LICENSE in the package root for license information.
  * ------------------------------------------------------------------------------------------ */
 
 import { BaseLanguageClient, MessageTransports, LanguageClientOptions } from 'vscode-languageclient/lib/common/client.js';

package/src/vscode/services.ts

@@ -1,6 +1,6 @@
 /* --------------------------------------------------------------------------------------------
  * Copyright (c) 2024 TypeFox GmbH (http://www.typefox.io). All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
+ * Licensed under the MIT License. See LICENSE in the package root for license information.
  * ------------------------------------------------------------------------------------------ */
 
 import { editor, Environment } from 'monaco-editor';