Developer documentation

Files And Debugging

Plugins can ask the user to pick text files, save text output, and write to the plugin debug console.

commands: {
  "import.pick": function(ctx) {
    return {
      __action: "pickTextFile",
      allowedExtensions: ["json", "txt"],
      nextCommand: "import.process"
    };
  },

  "import.process": function(ctx) {
    var text = ctx.file && ctx.file.text ? ctx.file.text : "";
    return { __action: "setPluginData", key: "import.lastFile", value: text };
  }
}

return {
  __action: "saveTextFile",
  filename: "buildaplugin-output.json",
  text: JSON.stringify(ctx.pluginData, null, 2)
};

return {
  __action: "debug.log",
  pluginId: "my-plugin",
  level: "info",
  message: "Command ran with URL " + ctx.dollar("#urlInput").val()
};