Update settings from the clipboard

[Fred-Vatin]

As I don’t understand the goal of the built-in command ;pj [Restore settings data from clipboard] defined here, and it doesn’t work as I expect, I wrote my own function to update the SurfingKeys settings from the clipboard.

Prerequisite

Warning

In your settings add this line at the very top

// SK Settings

Add this command to your settings and save

mapkey(";pj", "#11Update settings from clipboard", function () {
  Clipboard.read(function (cbData) {
    if (isSettings(cbData.data)) {
      runtime("updateSettings", { settings: { snippets: cbData.data } }, (response) => {
        console.info(response);
      });

      console.info(`[SK] Settings updated`);
      Front.showPopup("Settings updated. Refresh the page to apply.");
    } else {
      const warnMsg = `[SK] your clipboard content is not a string or doesn’t contain "SK Settings" in the firt line. It can not be used to update the settings.`;
not be used to update the settings.`;
      Front.showPopup(warnMsg);
      console.warn(warnMsg);
    }
  });
});

function isSettings(clipboardData) {
  const isString = typeof clipboardData === "string";
  console.info(`[SK] type of clipboard content:`, typeof clipboardData);
  if (!isString) {
    console.warn("`[SK] clipboard content is not a string. Settings can not be updated.");
    return;
  }

  const firstLine = clipboardData.split("\n")[0];
  const containsSKSettings = firstLine.includes("SK Settings");

  console.info(`[SK] does clipboard contains settings ?`, containsSKSettings);
  return containsSKSettings;
}

Usage

Pretty simple. When you have finished to polish your new feature in your favorite code editor:

• copy all the content with Ctrl+A, Ctrl+V
• return to your browser with Alt+tab
• run the command ;pj
• read the notification message.
• if error
  • open the console and read the messages. Your can’t filter with [SK].
  • be sure the clipboard content is OK. Fix it if it is not and run the command again.
• if no error: refresh the page to apply

Warning

If new settings has error, you will need to fix it and update the fixed settings via the normal way.