@theia/keymaps 1.53.0-next.5 → 1.53.0-next.55

package/README.md

@@ -1,61 +1,61 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - KEYMAPS EXTENSION</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-The `@theia/keymaps` allows the user to reconfigure default keybindings with custom keymaps.\
-By modifying the appropriate `keymaps.json`, the user can modify existing keybindings, or add keybindings to commands that do not yet have a keybinding associated to them.
-
-Example of a valid `keymaps.json` file
-
-```json
-[
-    {
-        "command": "quickCommand",
-        "keybinding": "ctrl+shift+f4"
-    }
-]
-```
- where `command` is a unique command id and keybinding is a valid `keybinding`. There's also an optional `context` property that can be specified (which is also a unique string for a context id).
-
-## Supported Keys
-
-For most keys you can directly use the name of the key i.e `a`, `3`,  `/`, `-`.
-
-To use `ctrl` on Linux/Windows and `cmd` on OSX, use `ctrlcmd`.
-
-You can use `shift`, `ctrl`, `alt`, `meta`, `option` (`alt`), `command` (`meta`), `cmd` (`meta`) as modifiers. Note that if you defined a custom shortcut with `cmd`, `command` or `meta`, the same keymaps file won't work on a Windows/Linux machine as this key doesn't have an equivalent.
-
-You can also use the following strings for special keys: `backspace`, `tab`, `enter`, `return`, `capslock`, `esc`, `escape`, `space`, `pageup`, `pagedown`, `end`, `home`, `left`, `up`, `right`, `down`, `ins`, `del` and `plus`.
-
-If unsure you can always look at the framework's [supported keys](https://eclipse-theia.github.io/theia/docs/next/modules/core.Key-4.html)
-
-## Key Sequences
-
-Key sequences like: `ctrl+x ctrl+a` or `ctrl+a b c` are supported.  With the following limitations:
- - If the key sequence exceeds 1 key chord it won't show in the electron menu.
- - If the key sequence exceeds 2 key chords it won't show in the command palette.
-
-## Additional Information
-
-- [API documentation for `@theia/keymaps`](https://eclipse-theia.github.io/theia/docs/next/modules/keymaps.html)
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - KEYMAPS EXTENSION</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/keymaps` allows the user to reconfigure default keybindings with custom keymaps.\
+By modifying the appropriate `keymaps.json`, the user can modify existing keybindings, or add keybindings to commands that do not yet have a keybinding associated to them.
+
+Example of a valid `keymaps.json` file
+
+```json
+[
+    {
+        "command": "quickCommand",
+        "keybinding": "ctrl+shift+f4"
+    }
+]
+```
+ where `command` is a unique command id and keybinding is a valid `keybinding`. There's also an optional `context` property that can be specified (which is also a unique string for a context id).
+
+## Supported Keys
+
+For most keys you can directly use the name of the key i.e `a`, `3`,  `/`, `-`.
+
+To use `ctrl` on Linux/Windows and `cmd` on OSX, use `ctrlcmd`.
+
+You can use `shift`, `ctrl`, `alt`, `meta`, `option` (`alt`), `command` (`meta`), `cmd` (`meta`) as modifiers. Note that if you defined a custom shortcut with `cmd`, `command` or `meta`, the same keymaps file won't work on a Windows/Linux machine as this key doesn't have an equivalent.
+
+You can also use the following strings for special keys: `backspace`, `tab`, `enter`, `return`, `capslock`, `esc`, `escape`, `space`, `pageup`, `pagedown`, `end`, `home`, `left`, `up`, `right`, `down`, `ins`, `del` and `plus`.
+
+If unsure you can always look at the framework's [supported keys](https://eclipse-theia.github.io/theia/docs/next/modules/core.Key-4.html)
+
+## Key Sequences
+
+Key sequences like: `ctrl+x ctrl+a` or `ctrl+a b c` are supported.  With the following limitations:
+ - If the key sequence exceeds 1 key chord it won't show in the electron menu.
+ - If the key sequence exceeds 2 key chords it won't show in the command palette.
+
+## Additional Information
+
+- [API documentation for `@theia/keymaps`](https://eclipse-theia.github.io/theia/docs/next/modules/keymaps.html)
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@theia/keymaps",
-  "version": "1.53.0-next.5+1e5fb536d",
+  "version": "1.53.0-next.55+d1a989a68c",
   "description": "Theia - Custom Keymaps Extension",
   "dependencies": {
-    "@theia/core": "1.53.0-next.5+1e5fb536d",
-    "@theia/monaco": "1.53.0-next.5+1e5fb536d",
+    "@theia/core": "1.53.0-next.55+d1a989a68c",
+    "@theia/monaco": "1.53.0-next.55+d1a989a68c",
     "@theia/monaco-editor-core": "1.83.101",
-    "@theia/preferences": "1.53.0-next.5+1e5fb536d",
-    "@theia/userstorage": "1.53.0-next.5+1e5fb536d",
+    "@theia/preferences": "1.53.0-next.55+d1a989a68c",
+    "@theia/userstorage": "1.53.0-next.55+d1a989a68c",
     "jsonc-parser": "^2.2.0",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.52.0"
+    "@theia/ext-scripts": "1.53.0"
   },
   "publishConfig": {
     "access": "public"
@@ -49,5 +49,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "1e5fb536d65550ad8fa0fefcec731645b2afc74a"
+  "gitHead": "d1a989a68c1b5ec1f9098e9126653c6346844769"
 }

package/src/browser/index.ts

@@ -1,19 +1,19 @@
-// *****************************************************************************
-// Copyright (C) 2017 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-export * from './keymaps-frontend-module';
-export * from './keymaps-service';
-export * from './keymaps-frontend-contribution';
+// *****************************************************************************
+// Copyright (C) 2017 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export * from './keymaps-frontend-module';
+export * from './keymaps-service';
+export * from './keymaps-frontend-contribution';

package/src/browser/keybinding-schema-updater.ts

@@ -1,95 +1,95 @@
-// *****************************************************************************
-// Copyright (C) 2022 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { nls, CommandRegistry, InMemoryResources, deepClone } from '@theia/core/lib/common';
-import { JsonSchemaContribution, JsonSchemaRegisterContext } from '@theia/core/lib/browser/json-schema-store';
-import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-
-@injectable()
-export class KeybindingSchemaUpdater implements JsonSchemaContribution {
-    protected readonly uri = new URI(keybindingSchemaId);
-    @inject(CommandRegistry) protected readonly commandRegistry: CommandRegistry;
-    @inject(InMemoryResources) protected readonly inMemoryResources: InMemoryResources;
-
-    @postConstruct()
-    protected init(): void {
-        this.inMemoryResources.add(new URI(keybindingSchemaId), '');
-        this.updateSchema();
-        this.commandRegistry.onCommandsChanged(() => this.updateSchema());
-    }
-
-    registerSchemas(store: JsonSchemaRegisterContext): void {
-        store.registerSchema({
-            fileMatch: ['keybindings.json', 'keymaps.json'],
-            url: this.uri.toString(),
-        });
-    }
-
-    protected updateSchema(): void {
-        const schema = deepClone(keybindingSchema);
-        const enumValues = schema.items.allOf[0].properties!.command.anyOf[1].enum!;
-        const enumDescriptions = schema.items.allOf[0].properties!.command.anyOf[1].enumDescriptions!;
-        for (const command of this.commandRegistry.getAllCommands()) {
-            if (command.handlers.length > 0 && !command.id.startsWith('_')) {
-                enumValues.push(command.id);
-                enumDescriptions.push(command.label ?? '');
-            }
-        }
-        this.inMemoryResources.update(this.uri, JSON.stringify(schema));
-    }
-}
-
-const keybindingSchemaId = 'vscode://schemas/keybindings';
-export const keybindingSchema = {
-    $id: keybindingSchemaId,
-    type: 'array',
-    title: 'Keybinding Configuration File',
-    default: [],
-    definitions: {
-        key: { type: 'string', description: nls.localizeByDefault('Key or key sequence (separated by space)') },
-    },
-    items: {
-        type: 'object',
-        defaultSnippets: [{ body: { key: '$1', command: '$2', when: '$3' } }],
-        allOf: [
-            {
-                required: ['command'],
-                properties: {
-                    command: {
-                        anyOf: [{ type: 'string' }, { enum: <string[]>[], enumDescriptions: <string[]>[] }], description: nls.localizeByDefault('Name of the command to execute')
-                    },
-                    when: { type: 'string', description: nls.localizeByDefault('Condition when the key is active.') },
-                    args: { description: nls.localizeByDefault('Arguments to pass to the command to execute.') },
-                    context: {
-                        type: 'string',
-                        description: nls.localizeByDefault('Condition when the key is active.'),
-                        deprecationMessage: nls.localize('theia/keybinding-schema-updater/deprecation', 'Use `when` clause instead.')
-                    }
-                }
-            },
-            {
-                anyOf: [
-                    { required: ['key'], properties: { key: { $ref: '#/definitions/key' }, } },
-                    { required: ['keybinding'], properties: { keybinding: { $ref: '#/definitions/key' } } }
-                ]
-            }
-        ]
-    },
-    allowComments: true,
-    allowTrailingCommas: true,
-};
-
+// *****************************************************************************
+// Copyright (C) 2022 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { nls, CommandRegistry, InMemoryResources, deepClone } from '@theia/core/lib/common';
+import { JsonSchemaContribution, JsonSchemaRegisterContext } from '@theia/core/lib/browser/json-schema-store';
+import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+
+@injectable()
+export class KeybindingSchemaUpdater implements JsonSchemaContribution {
+    protected readonly uri = new URI(keybindingSchemaId);
+    @inject(CommandRegistry) protected readonly commandRegistry: CommandRegistry;
+    @inject(InMemoryResources) protected readonly inMemoryResources: InMemoryResources;
+
+    @postConstruct()
+    protected init(): void {
+        this.inMemoryResources.add(new URI(keybindingSchemaId), '');
+        this.updateSchema();
+        this.commandRegistry.onCommandsChanged(() => this.updateSchema());
+    }
+
+    registerSchemas(store: JsonSchemaRegisterContext): void {
+        store.registerSchema({
+            fileMatch: ['keybindings.json', 'keymaps.json'],
+            url: this.uri.toString(),
+        });
+    }
+
+    protected updateSchema(): void {
+        const schema = deepClone(keybindingSchema);
+        const enumValues = schema.items.allOf[0].properties!.command.anyOf[1].enum!;
+        const enumDescriptions = schema.items.allOf[0].properties!.command.anyOf[1].enumDescriptions!;
+        for (const command of this.commandRegistry.getAllCommands()) {
+            if (command.handlers.length > 0 && !command.id.startsWith('_')) {
+                enumValues.push(command.id);
+                enumDescriptions.push(command.label ?? '');
+            }
+        }
+        this.inMemoryResources.update(this.uri, JSON.stringify(schema));
+    }
+}
+
+const keybindingSchemaId = 'vscode://schemas/keybindings';
+export const keybindingSchema = {
+    $id: keybindingSchemaId,
+    type: 'array',
+    title: 'Keybinding Configuration File',
+    default: [],
+    definitions: {
+        key: { type: 'string', description: nls.localizeByDefault('Key or key sequence (separated by space)') },
+    },
+    items: {
+        type: 'object',
+        defaultSnippets: [{ body: { key: '$1', command: '$2', when: '$3' } }],
+        allOf: [
+            {
+                required: ['command'],
+                properties: {
+                    command: {
+                        anyOf: [{ type: 'string' }, { enum: <string[]>[], enumDescriptions: <string[]>[] }], description: nls.localizeByDefault('Name of the command to execute')
+                    },
+                    when: { type: 'string', description: nls.localizeByDefault('Condition when the key is active.') },
+                    args: { description: nls.localizeByDefault('Arguments to pass to the command to execute.') },
+                    context: {
+                        type: 'string',
+                        description: nls.localizeByDefault('Condition when the key is active.'),
+                        deprecationMessage: nls.localize('theia/keybinding-schema-updater/deprecation', 'Use `when` clause instead.')
+                    }
+                }
+            },
+            {
+                anyOf: [
+                    { required: ['key'], properties: { key: { $ref: '#/definitions/key' }, } },
+                    { required: ['keybinding'], properties: { keybinding: { $ref: '#/definitions/key' } } }
+                ]
+            }
+        ]
+    },
+    allowComments: true,
+    allowTrailingCommas: true,
+};
+