Serialize the proper API object for the keymaps.json file

Fixes issue #9087 Contributed by STMicroelectronics Signed-off-by: Samuel HULTGREN <samuel.hultgren@st.com>
eclipse-theia · Feb 24, 2021 · d0265d6 · d0265d6
1 parent c5f3253
commit d0265d6
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/packages/core/src/common/keybinding.ts b/packages/core/src/common/keybinding.ts
@@ -51,21 +51,30 @@ export interface Keybinding {
 export namespace Keybinding {
 
     /**
-     * Returns with the string representation of the binding.
-     * Any additional properties which are not described on
-     * the `Keybinding` API will be ignored.
+     * Returns a new object only containing properties which
+     * are described on the `Keybinding` API.
      *
-     * @param binding the binding to stringify.
+     * @param binding the binding to create an API object for.
      */
-    export function stringify(binding: Keybinding): string {
-        const copy: Keybinding = {
+    export function apiObjectify(binding: Keybinding): Keybinding {
+        return {
             command: binding.command,
             keybinding: binding.keybinding,
             context: binding.context,
             when: binding.when,
             args: binding.args
         };
-        return JSON.stringify(copy);
+    }
+
+    /**
+     * Returns with the string representation of the binding.
+     * Any additional properties which are not described on
+     * the `Keybinding` API will be ignored.
+     *
+     * @param binding the binding to stringify.
+     */
+    export function stringify(binding: Keybinding): string {
+        return JSON.stringify(apiObjectify(binding));
     }
 
     /* Determine whether object is a KeyBinding */

diff --git a/packages/keymaps/src/browser/keymaps-service.ts b/packages/keymaps/src/browser/keymaps-service.ts
@@ -189,7 +189,7 @@ export class KeymapsService {
                 const textModel = model.textEditorModel;
                 const { insertSpaces, tabSize, defaultEOL } = textModel.getOptions();
                 const editOperations: monaco.editor.IIdentifiedSingleEditOperation[] = [];
-                for (const edit of jsoncparser.modify(content, [], keybindings, {
+                for (const edit of jsoncparser.modify(content, [], keybindings.map(binding => Keybinding.apiObjectify(binding)), {
                     formattingOptions: {
                         insertSpaces,
                         tabSize,