Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | import joplin from "api"; import { MenuItemLocation, ToolbarButtonLocation } from "api/types"; import { Parser } from "./parser"; import { DateAndTimeUtils } from "./utils/dateAndTime"; import { getFolderFromId, getSelectedFolder, getUserFolderSelection, Folder } from "./utils/folders"; import { getUserDefaultTemplateTypeSelection, setDefaultTemplate } from "./utils/defaultTemplates"; import { getTemplateFromId, getUserTemplateSelection, Note } from "./utils/templates"; import { setDefaultTemplatesView, DefaultTemplatesDisplayData, NotebookDefaultTemplatesDisplayData } from "./views/defaultTemplates"; import { TemplateAction, performAction } from "./actions"; import { loadLegacyTemplates } from "./legacyTemplates"; import { Logger } from "./logger"; import { PromiseGroup } from "./utils/promises"; import { PluginSettingsRegistry, DefaultNoteTemplateIdSetting, DefaultTodoTemplateIdSetting, DefaultTemplatesConfigSetting } from "./settings"; import { LocaleGlobalSetting, DateFormatGlobalSetting, TimeFormatGlobalSetting, ProfileDirGlobalSetting } from "./settings/global"; import { DefaultTemplatesConfig } from "./settings/defaultTemplatesConfig"; import { CommandsPanel } from "./views/commandsPanel"; const DOCUMENTATION_URL = "https://github.com/joplin/plugin-templates#readme"; const AI_ASSISTANT_URL = "https://joplin-templates-assistant.nishantwrp.com/"; joplin.plugins.register({ onStart: async function () { // Register setting section await PluginSettingsRegistry.registerSettings(); // Global variables const joplinGlobalApis = new PromiseGroup(); joplinGlobalApis.set("dialogViewHandle", joplin.views.dialogs.create("dialog")); joplinGlobalApis.set("templateSelectorHandle", joplin.views.dialogs.create("templateSelector")); joplinGlobalApis.set("folderSelectorHandle", joplin.views.dialogs.create("folderSelector")); joplinGlobalApis.set("templateTypeSelectorHandle", joplin.views.dialogs.create("templateTypeSelector")); joplinGlobalApis.set("userLocale", LocaleGlobalSetting.get()); joplinGlobalApis.set("userDateFormat", DateFormatGlobalSetting.get()); joplinGlobalApis.set("userTimeFormat", TimeFormatGlobalSetting.get()); joplinGlobalApis.set("profileDir", ProfileDirGlobalSetting.get()); const { dialogViewHandle, templateSelectorHandle, folderSelectorHandle, templateTypeSelectorHandle, userLocale, userDateFormat, userTimeFormat, profileDir } = await joplinGlobalApis.groupAll(); const dateAndTimeUtils = new DateAndTimeUtils(userLocale, userDateFormat, userTimeFormat); const logger = new Logger(profileDir); const parser = new Parser(dateAndTimeUtils, dialogViewHandle, logger); // Asynchronously load legacy templates const version = await joplin.versionInfo(); if (version.platform === "desktop") { loadLegacyTemplates(dateAndTimeUtils, profileDir); } else { logger.log("Legacy templates loading skipped on mobile"); } // Utility Functions const performActionWithParsedTemplate = async (action: TemplateAction, template: Note | null) => { const parsedTemplate = await parser.parseTemplate(template); Iif (parsedTemplate) { await performAction(action, parsedTemplate); } } const getTemplateAndPerformAction = async (action: TemplateAction) => { const template: Note = JSON.parse(await getUserTemplateSelection(templateSelectorHandle) || "null"); await performActionWithParsedTemplate(action, template); } const getNotebookDefaultTemplatesDisplayData = async (settings: DefaultTemplatesConfig): Promise<NotebookDefaultTemplatesDisplayData[]> => { const getDisplayDataForNotebook = async (notebookId: string, defaultTemplateNoteId: string | null, defaultTemplateTodoId: string | null): Promise<NotebookDefaultTemplatesDisplayData | null> => { const promiseGroup = new PromiseGroup(); promiseGroup.set("notebook", getFolderFromId(notebookId)); promiseGroup.set("noteTemplate", getTemplateFromId(defaultTemplateNoteId)); promiseGroup.set("todoTemplate", getTemplateFromId(defaultTemplateTodoId)); const { notebook, noteTemplate, todoTemplate } = await promiseGroup.groupAll(); Iif (notebook === null || (noteTemplate === null && todoTemplate === null)) { // Async remove of the obsolete config DefaultTemplatesConfigSetting.clearDefaultTemplates(notebookId); return null; } return { notebookTitle: notebook.title, defaultNoteTemplateTitle: noteTemplate ? noteTemplate.title : null, defaultTodoTemplateTitle: todoTemplate ? todoTemplate.title : null }; } const notebookDisplayDataPromiseGroup = new PromiseGroup(); for (const [notebookId, defaultTemplates] of Object.entries(settings)) { notebookDisplayDataPromiseGroup.add(getDisplayDataForNotebook( notebookId, defaultTemplates.defaultNoteTemplateId, defaultTemplates.defaultTodoTemplateId)); } return (await notebookDisplayDataPromiseGroup.groupAll())[PromiseGroup.UNNAMED_KEY].filter(x => x !== null); } // Register all commands const joplinCommands = new PromiseGroup(); joplinCommands.add(joplin.commands.register({ name: "createNoteFromTemplate", label: "Create note from template", iconName: "far fa-file-alt", execute: async () => { await getTemplateAndPerformAction(TemplateAction.NewNote); } })); joplin.views.toolbarButtons.create( "createNoteFromTemplateEditorToolbar", "createNoteFromTemplate", ToolbarButtonLocation.EditorToolbar ); joplinCommands.add(joplin.commands.register({ name: "createTodoFromTemplate", label: "Create to-do from template", execute: async () => { await getTemplateAndPerformAction(TemplateAction.NewTodo); } })); joplinCommands.add(joplin.commands.register({ name: "insertTemplate", label: "Insert template", execute: async () => { await getTemplateAndPerformAction(TemplateAction.InsertText); } })); joplinCommands.add(joplin.commands.register({ name: "showDefaultTemplates", label: "Show default templates", execute: async () => { const noteTemplate = await getTemplateFromId(await DefaultNoteTemplateIdSetting.get()); const todoTemplate = await getTemplateFromId(await DefaultTodoTemplateIdSetting.get()); const defaultTemplatesConfig = await DefaultTemplatesConfigSetting.get(); const globalDefaultTemplates: DefaultTemplatesDisplayData = { defaultNoteTemplateTitle: noteTemplate ? noteTemplate.title : null, defaultTodoTemplateTitle: todoTemplate ? todoTemplate.title : null }; const notebookDisplayData = await getNotebookDefaultTemplatesDisplayData(defaultTemplatesConfig); await setDefaultTemplatesView(dialogViewHandle, globalDefaultTemplates, notebookDisplayData); await joplin.views.dialogs.open(dialogViewHandle); } })); joplinCommands.add(joplin.commands.register({ name: "setDefaultTemplate", label: "Set default template", execute: async () => { const templateId = await getUserTemplateSelection(templateSelectorHandle, "id"); Iif (templateId === null) return; const defaultType = await getUserDefaultTemplateTypeSelection(templateTypeSelectorHandle); Iif (defaultType === null) return; await setDefaultTemplate(null, templateId, defaultType); await joplin.views.dialogs.showMessageBox("Default template set successfully!"); } })); joplinCommands.add(joplin.commands.register({ name: "setDefaultTemplateForNotebook", label: "Set default template for notebook", execute: async () => { const folder: Folder | null = JSON.parse(await getUserFolderSelection(folderSelectorHandle) || "null"); Iif (folder === null) return; const templateId = await getUserTemplateSelection(templateSelectorHandle, "id", `Default template for "${folder.title}":`); Iif (templateId === null) return; const defaultType = await getUserDefaultTemplateTypeSelection(templateTypeSelectorHandle); Iif (defaultType === null) return; await setDefaultTemplate(folder.id, templateId, defaultType); await joplin.views.dialogs.showMessageBox(`Default template set for "${folder.title}" successfully!`); } })); joplinCommands.add(joplin.commands.register({ name: "clearDefaultTemplatesForNotebook", label: "Clear default templates for notebook", execute: async () => { const folder: Folder | null = JSON.parse(await getUserFolderSelection(folderSelectorHandle) || "null"); Iif (folder === null) return; await DefaultTemplatesConfigSetting.clearDefaultTemplates(folder.id); await joplin.views.dialogs.showMessageBox(`Default templates for "${folder.title}" cleared successfully!`); } })); joplinCommands.add(joplin.commands.register({ name: "createNoteFromDefaultTemplate", label: "Create note from default template", execute: async () => { let defaultTemplate: Note | null = null; const defaultTemplatesConfig = await DefaultTemplatesConfigSetting.get(); const currentFolderId = await getSelectedFolder(); Iif (currentFolderId in defaultTemplatesConfig) { defaultTemplate = await getTemplateFromId(defaultTemplatesConfig[currentFolderId].defaultNoteTemplateId); } Iif (defaultTemplate === null) { defaultTemplate = await getTemplateFromId(await DefaultNoteTemplateIdSetting.get()); } Iif (defaultTemplate) { return await performActionWithParsedTemplate(TemplateAction.NewNote, defaultTemplate); } await joplin.views.dialogs.showMessageBox("No default note template is set."); } })); joplinCommands.add(joplin.commands.register({ name: "createTodoFromDefaultTemplate", label: "Create to-do from default template", execute: async () => { let defaultTemplate: Note | null = null; const defaultTemplatesConfig = await DefaultTemplatesConfigSetting.get(); const currentFolderId = await getSelectedFolder(); Iif (currentFolderId in defaultTemplatesConfig) { defaultTemplate = await getTemplateFromId(defaultTemplatesConfig[currentFolderId].defaultTodoTemplateId); } Iif (defaultTemplate === null) { defaultTemplate = await getTemplateFromId(await DefaultTodoTemplateIdSetting.get()); } Iif (defaultTemplate) { return await performActionWithParsedTemplate(TemplateAction.NewTodo, defaultTemplate); } await joplin.views.dialogs.showMessageBox("No default to-do template is set."); } })); joplinCommands.add(joplin.commands.register({ name: "showAIAssistant", label: "AI Assistant", execute: async () => { await joplin.commands.execute("openItem", AI_ASSISTANT_URL); } })); joplinCommands.add(joplin.commands.register({ name: "showPluginDocumentation", label: "Help", execute: async () => { await joplin.commands.execute("openItem", DOCUMENTATION_URL); } })); joplinCommands.add(joplin.commands.register({ name: "copyFolderID", label: "Copy notebook ID", execute: async (folderId: string) => { Iif (typeof folderId === "undefined") { const selectedFolder = await joplin.workspace.selectedFolder(); folderId = selectedFolder.id; } await joplin.clipboard.writeText(folderId); await joplin.commands.execute("editor.focus"); } })); // Create templates menu await joplin.views.menus.create("templates", "Templates", [ { commandName: "createNoteFromTemplate", accelerator: "Alt+Ctrl+Shift+N" }, { commandName: "createNoteFromDefaultTemplate", accelerator: "Alt+Shift+N" }, { commandName: "createTodoFromTemplate", accelerator: "Alt+Ctrl+Shift+T" }, { commandName: "createTodoFromDefaultTemplate", accelerator: "Alt+Shift+T" }, { commandName: "insertTemplate", accelerator: "Alt+Ctrl+I" }, { label: "Default templates", submenu: [ { commandName: "showDefaultTemplates" }, { commandName: "setDefaultTemplate" }, { commandName: "setDefaultTemplateForNotebook" }, { commandName: "clearDefaultTemplatesForNotebook" }, ] }, { commandName: "showAIAssistant" }, { commandName: "showPluginDocumentation" } ]); await joplinCommands.groupAll(); // Folder context menu await joplin.views.menuItems.create("templates_folderid", "copyFolderID", MenuItemLocation.FolderContextMenu); Iif (version.platform === "mobile") { const commandsPanel = new CommandsPanel([ { label: "Create note from template", command: "createNoteFromTemplate" }, { label: "Create note from default template", command: "createNoteFromDefaultTemplate" }, { label: "Create to-do from template", command: "createTodoFromTemplate" }, { label: "Create to-do from default template", command: "createTodoFromDefaultTemplate" }, { label: "Insert template", command: "insertTemplate" }, { label: "Show default templates", command: "showDefaultTemplates" }, { label: "Set default template", command: "setDefaultTemplate" }, { label: "Set default template for notebook", command: "setDefaultTemplateForNotebook" }, { label: "Clear default templates for notebook", command: "clearDefaultTemplatesForNotebook" }, { label: "AI Assistant", command: "showAIAssistant" }, { label: "Help", command: "showPluginDocumentation" } ]); await commandsPanel.create(); } }, }); |