Documentation update, make LICENSE usage consistent

TypeFox · Mar 18, 2024 · 9d4c543 · 9d4c543
1 parent 043371f
commit 9d4c543
Show file tree

Hide file tree

Showing 107 changed files with 294 additions and 324 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/versions-and-history.md b/docs/versions-and-history.md
@@ -47,7 +47,7 @@ The following table describes which version of **monaco-languageclient** and **@
 
 ### March 2024 (v8.0.0)
 
-`@codingame/monaco-editor-treemended` is replaced by self-standing `@codingame/monaco-vscode-editor-api`. All service and editor related functions have been moved from `monaco-languageclient` to `monaco-editor-wrapper` which has been moved into this repository.
+`@codingame/monaco-editor-treemended` is replaced by self-standing `@codingame/monaco-vscode-editor-api`. `monaco-editor-wrapper` and `@typefox/monaco-editor-react` have been moved into this repository.
 
 ### October 2023 (v7.0.0)
 

diff --git a/packages/client/License.txt → packages/client/LICENSE b/packages/client/License.txt → packages/client/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.

diff --git a/packages/client/README.md b/packages/client/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)
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -52,7 +52,7 @@
     "src",
     "README.md",
     "CHANGELOG.md",
-    "License.txt"
+    "LICENSE"
   ],
   "dependencies": {
     "@codingame/monaco-vscode-languages-service-override": "~3.1.2",

diff --git a/packages/client/src/index.ts b/packages/client/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';

diff --git a/packages/client/src/vscode/services.ts b/packages/client/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';

diff --git a/packages/examples/License.txt → packages/examples/LICENSE b/packages/examples/License.txt → packages/examples/LICENSE
@@ -1,9 +1,7 @@
-Copyright (c) 2018-2024 TypeFox GmbH (http://www.typefox.io)
-
-All rights reserved.
-
 MIT License
 
+Copyright 2023 - 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.

diff --git a/packages/examples/README.md b/packages/examples/README.md
@@ -12,6 +12,14 @@ This package contains [all examples from the monaco-languageclient repository](h
 
 All changes are noted in the [CHANGELOG](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/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
+
+Needs to be added.
+
 ## License
 
-[MIT](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/License.txt)
+[MIT](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/LICENSE)
diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -106,7 +106,7 @@
     "*.ts",
     "README.md",
     "CHANGELOG.md",
-    "License.txt"
+    "LICENSE"
   ],
   "scripts": {
     "clean": "shx rm -fr dist *.tsbuildinfo",

diff --git a/packages/examples/src/browser/main.ts b/packages/examples/src/browser/main.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 * as vscode from 'vscode';

diff --git a/packages/examples/src/common/example-apps-common.ts b/packages/examples/src/common/example-apps-common.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 { ModelUpdate, MonacoEditorLanguageClientWrapper, UserConfig } from 'monaco-editor-wrapper';

diff --git a/packages/examples/src/common/language-server-runner.ts b/packages/examples/src/common/language-server-runner.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 { WebSocketServer } from 'ws';

diff --git a/packages/examples/src/common/server-commons.ts b/packages/examples/src/common/server-commons.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 { WebSocketServer, ServerOptions } from 'ws';
 import { IncomingMessage, Server } from 'http';

diff --git a/packages/examples/src/groovy/client/main.ts b/packages/examples/src/groovy/client/main.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 getKeybindingsServiceOverride from '@codingame/monaco-vscode-keybindings-service-override';

diff --git a/packages/examples/src/groovy/config.ts b/packages/examples/src/groovy/config.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.
  * ------------------------------------------------------------------------------------------ */
 export const groovyConfig = {
     port: 30002,

diff --git a/packages/examples/src/groovy/server/README.md b/packages/examples/src/groovy/server/README.md
@@ -0,0 +1,19 @@
+# Groovy Language Server self-built instructions
+
+## Preperation
+
+In another directory run (Requires Gradle 7 and OpenJDK 17)
+
+```shell
+git clone https://github.com/GroovyLanguageServer/groovy-language-server
+./gradlew build
+```
+
+Afterwards copy the jar file from from `groovy-language-server/build/libs/groovy-language-server-all.jar` to `packages/examples/resources/external/groovy`.
+
+From the root of this repository run:
+
+```shell
+# start the express server with the language server running as external Java process.
+npm run start:example:server:groovy
+```
diff --git a/packages/examples/src/groovy/server/direct.ts b/packages/examples/src/groovy/server/direct.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 { resolve } from 'path';

diff --git a/packages/examples/src/groovy/server/main.ts b/packages/examples/src/groovy/server/main.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 { runLanguageServer } from '../../common/language-server-runner.js';

diff --git a/packages/examples/src/index.ts b/packages/examples/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.
  * ------------------------------------------------------------------------------------------ */
 
 /* client side export only */

diff --git a/packages/examples/src/json/client/wrapperWs.ts b/packages/examples/src/json/client/wrapperWs.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 getKeybindingsServiceOverride from '@codingame/monaco-vscode-keybindings-service-override';

diff --git a/packages/examples/src/json/server/direct.ts b/packages/examples/src/json/server/direct.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 { resolve } from 'path';
 import { runJsonServer } from './main.js';

diff --git a/packages/examples/src/json/server/json-server.ts b/packages/examples/src/json/server/json-server.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 { readFile } from 'fs';
 import requestLight from 'request-light';

diff --git a/packages/examples/src/json/server/main.ts b/packages/examples/src/json/server/main.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 { runLanguageServer } from '../../common/language-server-runner.js';
 import { resolve } from 'path';

diff --git a/packages/examples/src/langium/langium-dsl/config/classicConfig.ts b/packages/examples/src/langium/langium-dsl/config/classicConfig.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 { Uri } from 'vscode';

diff --git a/packages/examples/src/langium/langium-dsl/config/extendedConfig.ts b/packages/examples/src/langium/langium-dsl/config/extendedConfig.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 getEditorServiceOverride from '@codingame/monaco-vscode-editor-service-override';

diff --git a/packages/examples/src/langium/langium-dsl/config/langium.monarch.ts b/packages/examples/src/langium/langium-dsl/config/langium.monarch.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.
  * ------------------------------------------------------------------------------------------ */
 
 export const LangiumMonarchContent = {

diff --git a/packages/examples/src/langium/langium-dsl/worker/langium-server.ts b/packages/examples/src/langium/langium-dsl/worker/langium-server.ts
@@ -1,6 +1,6 @@
 /* --------------------------------------------------------------------------------------------
  * Copyright (c) 2018-2022 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 { EmptyFileSystem } from 'langium';

diff --git a/packages/examples/src/langium/langium-dsl/wrapperLangium.ts b/packages/examples/src/langium/langium-dsl/wrapperLangium.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 { MonacoEditorLanguageClientWrapper } from 'monaco-editor-wrapper';

diff --git a/packages/examples/src/langium/statemachine/config/wrapperStatemachineConfig.ts b/packages/examples/src/langium/statemachine/config/wrapperStatemachineConfig.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 getEditorServiceOverride from '@codingame/monaco-vscode-editor-service-override';

diff --git a/packages/examples/src/langium/statemachine/main-react.tsx b/packages/examples/src/langium/statemachine/main-react.tsx
@@ -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 React from 'react';

diff --git a/packages/examples/src/langium/statemachine/main.ts b/packages/examples/src/langium/statemachine/main.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 * as vscode from 'vscode';