| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| import { Path } from './types'; | ||
| /** | ||
| * This module provides access to the Joplin data API: https://joplinapp.org/api/references/rest_api/ | ||
| * This is the main way to retrieve data, such as notes, notebooks, tags, etc. | ||
| * or to update them or delete them. | ||
| * | ||
| * This is also what you would use to search notes, via the `search` endpoint. | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/simple) | ||
| * | ||
| * In general you would use the methods in this class as if you were using a REST API. There are four methods that map to GET, POST, PUT and DELETE calls. | ||
| * And each method takes these parameters: | ||
| * | ||
| * * `path`: This is an array that represents the path to the resource in the form `["resouceName", "resourceId", "resourceLink"]` (eg. ["tags", ":id", "notes"]). The "resources" segment is the name of the resources you want to access (eg. "notes", "folders", etc.). If not followed by anything, it will refer to all the resources in that collection. The optional "resourceId" points to a particular resources within the collection. Finally, an optional "link" can be present, which links the resource to a collection of resources. This can be used in the API for example to retrieve all the notes associated with a tag. | ||
| * * `query`: (Optional) The query parameters. In a URL, this is the part after the question mark "?". In this case, it should be an object with key/value pairs. | ||
| * * `data`: (Optional) Applies to PUT and POST calls only. The request body contains the data you want to create or modify, for example the content of a note or folder. | ||
| * * `files`: (Optional) Used to create new resources and associate them with files. | ||
| * | ||
| * Please refer to the [Joplin API documentation](https://joplinapp.org/api/references/rest_api/) for complete details about each call. As the plugin runs within the Joplin application **you do not need an authorisation token** to use this API. | ||
| * | ||
| * For example: | ||
| * | ||
| * ```typescript | ||
| * // Get a note ID, title and body | ||
| * const noteId = 'some_note_id'; | ||
| * const note = await joplin.data.get(['notes', noteId], { fields: ['id', 'title', 'body'] }); | ||
| * | ||
| * // Get all folders | ||
| * const folders = await joplin.data.get(['folders']); | ||
| * | ||
| * // Set the note body | ||
| * await joplin.data.put(['notes', noteId], null, { body: "New note body" }); | ||
| * | ||
| * // Create a new note under one of the folders | ||
| * await joplin.data.post(['notes'], null, { body: "my new note", title: "some title", parent_id: folders[0].id }); | ||
| * ``` | ||
| */ | ||
| export default class JoplinData { | ||
| private api_; | ||
| private pathSegmentRegex_; | ||
| private serializeApiBody; | ||
| private pathToString; | ||
| get(path: Path, query?: any): Promise<any>; | ||
| post(path: Path, query?: any, body?: any, files?: any[]): Promise<any>; | ||
| put(path: Path, query?: any, body?: any, files?: any[]): Promise<any>; | ||
| delete(path: Path, query?: any): Promise<any>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /** | ||
| * @ignore | ||
| * | ||
| * Not sure if it's the best way to hook into the app | ||
| * so for now disable filters. | ||
| */ | ||
| export default class JoplinFilters { | ||
| on(name: string, callback: Function): Promise<void>; | ||
| off(name: string, callback: Function): Promise<void>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import { ExportModule, ImportModule } from './types'; | ||
| /** | ||
| * Provides a way to create modules to import external data into Joplin or to export notes into any arbitrary format. | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/json_export) | ||
| * | ||
| * To implement an import or export module, you would simply define an object with various event handlers that are called | ||
| * by the application during the import/export process. | ||
| * | ||
| * See the documentation of the [[ExportModule]] and [[ImportModule]] for more information. | ||
| * | ||
| * You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/references/rest_api/ | ||
| */ | ||
| export default class JoplinInterop { | ||
| registerExportModule(module: ExportModule): Promise<void>; | ||
| registerImportModule(module: ImportModule): Promise<void>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import Plugin from '../Plugin'; | ||
| import { ContentScriptType, Script } from './types'; | ||
| /** | ||
| * This class provides access to plugin-related features. | ||
| */ | ||
| export default class JoplinPlugins { | ||
| private plugin; | ||
| constructor(plugin: Plugin); | ||
| /** | ||
| * Registers a new plugin. This is the entry point when creating a plugin. You should pass a simple object with an `onStart` method to it. | ||
| * That `onStart` method will be executed as soon as the plugin is loaded. | ||
| * | ||
| * ```typescript | ||
| * joplin.plugins.register({ | ||
| * onStart: async function() { | ||
| * // Run your plugin code here | ||
| * } | ||
| * }); | ||
| * ``` | ||
| */ | ||
| register(script: Script): Promise<void>; | ||
| /** | ||
| * @deprecated Use joplin.contentScripts.register() | ||
| */ | ||
| registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; | ||
| /** | ||
| * Gets the plugin own data directory path. Use this to store any | ||
| * plugin-related data. Unlike [[installationDir]], any data stored here | ||
| * will be persisted. | ||
| */ | ||
| dataDir(): Promise<string>; | ||
| /** | ||
| * Gets the plugin installation directory. This can be used to access any | ||
| * asset that was packaged with the plugin. This directory should be | ||
| * considered read-only because any data you store here might be deleted or | ||
| * re-created at any time. To store new persistent data, use [[dataDir]]. | ||
| */ | ||
| installationDir(): Promise<string>; | ||
| /** | ||
| * @deprecated Use joplin.require() | ||
| */ | ||
| require(_path: string): any; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| import Plugin from '../Plugin'; | ||
| import { SettingItem, SettingSection } from './types'; | ||
| export interface ChangeEvent { | ||
| /** | ||
| * Setting keys that have been changed | ||
| */ | ||
| keys: string[]; | ||
| } | ||
| export declare type ChangeHandler = (event: ChangeEvent)=> void; | ||
| /** | ||
| * This API allows registering new settings and setting sections, as well as getting and setting settings. Once a setting has been registered it will appear in the config screen and be editable by the user. | ||
| * | ||
| * Settings are essentially key/value pairs. | ||
| * | ||
| * Note: Currently this API does **not** provide access to Joplin's built-in settings. This is by design as plugins that modify user settings could give unexpected results | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/settings) | ||
| */ | ||
| export default class JoplinSettings { | ||
| private plugin_; | ||
| constructor(plugin: Plugin); | ||
| private get keyPrefix(); | ||
| private namespacedKey; | ||
| /** | ||
| * Registers new settings. | ||
| * Note that registering a setting item is dynamic and will be gone next time Joplin starts. | ||
| * What it means is that you need to register the setting every time the plugin starts (for example in the onStart event). | ||
| * The setting value however will be preserved from one launch to the next so there is no risk that it will be lost even if for some | ||
| * reason the plugin fails to start at some point. | ||
| */ | ||
| registerSettings(settings: Record<string, SettingItem>): Promise<void>; | ||
| /** | ||
| * @deprecated Use joplin.settings.registerSettings() | ||
| * | ||
| * Registers a new setting. | ||
| */ | ||
| registerSetting(key: string, settingItem: SettingItem): Promise<void>; | ||
| /** | ||
| * Registers a new setting section. Like for registerSetting, it is dynamic and needs to be done every time the plugin starts. | ||
| */ | ||
| registerSection(name: string, section: SettingSection): Promise<void>; | ||
| /** | ||
| * Gets a setting value (only applies to setting you registered from your plugin) | ||
| */ | ||
| value(key: string): Promise<any>; | ||
| /** | ||
| * Sets a setting value (only applies to setting you registered from your plugin) | ||
| */ | ||
| setValue(key: string, value: any): Promise<void>; | ||
| /** | ||
| * Gets a global setting value, including app-specific settings and those set by other plugins. | ||
| * | ||
| * The list of available settings is not documented yet, but can be found by looking at the source code: | ||
| * | ||
| * https://github.com/laurent22/joplin/blob/dev/packages/lib/models/Setting.ts#L142 | ||
| */ | ||
| globalValue(key: string): Promise<any>; | ||
| /** | ||
| * Called when one or multiple settings of your plugin have been changed. | ||
| * - For performance reasons, this event is triggered with a delay. | ||
| * - You will only get events for your own plugin settings. | ||
| */ | ||
| onChange(handler: ChangeHandler): Promise<void>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import Plugin from '../Plugin'; | ||
| import JoplinViewsDialogs from './JoplinViewsDialogs'; | ||
| import JoplinViewsMenuItems from './JoplinViewsMenuItems'; | ||
| import JoplinViewsMenus from './JoplinViewsMenus'; | ||
| import JoplinViewsToolbarButtons from './JoplinViewsToolbarButtons'; | ||
| import JoplinViewsPanels from './JoplinViewsPanels'; | ||
| /** | ||
| * This namespace provides access to view-related services. | ||
| * | ||
| * All view services provide a `create()` method which you would use to create the view object, whether it's a dialog, a toolbar button or a menu item. | ||
| * In some cases, the `create()` method will return a [[ViewHandle]], which you would use to act on the view, for example to set certain properties or call some methods. | ||
| */ | ||
| export default class JoplinViews { | ||
| private store; | ||
| private plugin; | ||
| private dialogs_; | ||
| private panels_; | ||
| private menuItems_; | ||
| private menus_; | ||
| private toolbarButtons_; | ||
| private implementation_; | ||
| constructor(implementation: any, plugin: Plugin, store: any); | ||
| get dialogs(): JoplinViewsDialogs; | ||
| get panels(): JoplinViewsPanels; | ||
| get menuItems(): JoplinViewsMenuItems; | ||
| get menus(): JoplinViewsMenus; | ||
| get toolbarButtons(): JoplinViewsToolbarButtons; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import Plugin from '../Plugin'; | ||
| import { ButtonSpec, ViewHandle, DialogResult } from './types'; | ||
| /** | ||
| * Allows creating and managing dialogs. A dialog is modal window that | ||
| * contains a webview and a row of buttons. You can update the update the | ||
| * webview using the `setHtml` method. Dialogs are hidden by default and | ||
| * you need to call `open()` to open them. Once the user clicks on a | ||
| * button, the `open` call will return an object indicating what button was | ||
| * clicked on. | ||
| * | ||
| * ## Retrieving form values | ||
| * | ||
| * If your HTML content included one or more forms, a `formData` object | ||
| * will also be included with the key/value for each form. | ||
| * | ||
| * ## Special button IDs | ||
| * | ||
| * The following buttons IDs have a special meaning: | ||
| * | ||
| * - `ok`, `yes`, `submit`, `confirm`: They are considered "submit" buttons | ||
| * - `cancel`, `no`, `reject`: They are considered "dismiss" buttons | ||
| * | ||
| * This information is used by the application to determine what action | ||
| * should be done when the user presses "Enter" or "Escape" within the | ||
| * dialog. If they press "Enter", the first "submit" button will be | ||
| * automatically clicked. If they press "Escape" the first "dismiss" button | ||
| * will be automatically clicked. | ||
| * | ||
| * [View the demo | ||
| * plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/dialog) | ||
| */ | ||
| export default class JoplinViewsDialogs { | ||
| private store; | ||
| private plugin; | ||
| private implementation_; | ||
| constructor(implementation: any, plugin: Plugin, store: any); | ||
| private controller; | ||
| /** | ||
| * Creates a new dialog | ||
| */ | ||
| create(id: string): Promise<ViewHandle>; | ||
| /** | ||
| * Displays a message box with OK/Cancel buttons. Returns the button index that was clicked - "0" for OK and "1" for "Cancel" | ||
| */ | ||
| showMessageBox(message: string): Promise<number>; | ||
| /** | ||
| * Sets the dialog HTML content | ||
| */ | ||
| setHtml(handle: ViewHandle, html: string): Promise<string>; | ||
| /** | ||
| * Adds and loads a new JS or CSS files into the dialog. | ||
| */ | ||
| addScript(handle: ViewHandle, scriptPath: string): Promise<void>; | ||
| /** | ||
| * Sets the dialog buttons. | ||
| */ | ||
| setButtons(handle: ViewHandle, buttons: ButtonSpec[]): Promise<ButtonSpec[]>; | ||
| /** | ||
| * Opens the dialog | ||
| */ | ||
| open(handle: ViewHandle): Promise<DialogResult>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import { CreateMenuItemOptions, MenuItemLocation } from './types'; | ||
| import Plugin from '../Plugin'; | ||
| /** | ||
| * Allows creating and managing menu items. | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/register_command) | ||
| */ | ||
| export default class JoplinViewsMenuItems { | ||
| private store; | ||
| private plugin; | ||
| constructor(plugin: Plugin, store: any); | ||
| /** | ||
| * Creates a new menu item and associate it with the given command. You can specify under which menu the item should appear using the `location` parameter. | ||
| */ | ||
| create(id: string, commandName: string, location?: MenuItemLocation, options?: CreateMenuItemOptions): Promise<void>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import { MenuItem, MenuItemLocation } from './types'; | ||
| import Plugin from '../Plugin'; | ||
| /** | ||
| * Allows creating menus. | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/menu) | ||
| */ | ||
| export default class JoplinViewsMenus { | ||
| private store; | ||
| private plugin; | ||
| constructor(plugin: Plugin, store: any); | ||
| private registerCommandAccelerators; | ||
| /** | ||
| * Creates a new menu from the provided menu items and place it at the given location. As of now, it is only possible to place the | ||
| * menu as a sub-menu of the application build-in menus. | ||
| */ | ||
| create(id: string, label: string, menuItems: MenuItem[], location?: MenuItemLocation): Promise<void>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| import Plugin from '../Plugin'; | ||
| import { ViewHandle } from './types'; | ||
| /** | ||
| * Allows creating and managing view panels. View panels currently are | ||
| * displayed at the right of the sidebar and allows displaying any HTML | ||
| * content (within a webview) and update it in real-time. For example it | ||
| * could be used to display a table of content for the active note, or | ||
| * display various metadata or graph. | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/toc) | ||
| */ | ||
| export default class JoplinViewsPanels { | ||
| private store; | ||
| private plugin; | ||
| constructor(plugin: Plugin, store: any); | ||
| private controller; | ||
| /** | ||
| * Creates a new panel | ||
| */ | ||
| create(id: string): Promise<ViewHandle>; | ||
| /** | ||
| * Sets the panel webview HTML | ||
| */ | ||
| setHtml(handle: ViewHandle, html: string): Promise<string>; | ||
| /** | ||
| * Adds and loads a new JS or CSS files into the panel. | ||
| */ | ||
| addScript(handle: ViewHandle, scriptPath: string): Promise<void>; | ||
| /** | ||
| * Called when a message is sent from the webview (using postMessage). | ||
| * | ||
| * To post a message from the webview to the plugin use: | ||
| * | ||
| * ```javascript | ||
| * const response = await webviewApi.postMessage(message); | ||
| * ``` | ||
| * | ||
| * - `message` can be any JavaScript object, string or number | ||
| * - `response` is whatever was returned by the `onMessage` handler | ||
| * | ||
| * Using this mechanism, you can have two-way communication between the | ||
| * plugin and webview. | ||
| * | ||
| * See the [postMessage | ||
| * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages) for more details. | ||
| * | ||
| */ | ||
| onMessage(handle: ViewHandle, callback: Function): Promise<void>; | ||
| /** | ||
| * Shows the panel | ||
| */ | ||
| show(handle: ViewHandle, show?: boolean): Promise<void>; | ||
| /** | ||
| * Hides the panel | ||
| */ | ||
| hide(handle: ViewHandle): Promise<void>; | ||
| /** | ||
| * Tells whether the panel is visible or not | ||
| */ | ||
| visible(handle: ViewHandle): Promise<boolean>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import { ToolbarButtonLocation } from './types'; | ||
| import Plugin from '../Plugin'; | ||
| /** | ||
| * Allows creating and managing toolbar buttons. | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/register_command) | ||
| */ | ||
| export default class JoplinViewsToolbarButtons { | ||
| private store; | ||
| private plugin; | ||
| constructor(plugin: Plugin, store: any); | ||
| /** | ||
| * Creates a new toolbar button and associate it with the given command. | ||
| */ | ||
| create(id: string, commandName: string, location: ToolbarButtonLocation): Promise<void>; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import { FolderEntity } from '../../database/types'; | ||
| import { Disposable } from './types'; | ||
| declare enum ItemChangeEventType { | ||
| Create = 1, | ||
| Update = 2, | ||
| Delete = 3, | ||
| } | ||
| interface ItemChangeEvent { | ||
| id: string; | ||
| event: ItemChangeEventType; | ||
| } | ||
| interface SyncStartEvent { | ||
| withErrors: boolean; | ||
| } | ||
| declare type ItemChangeHandler = (event: ItemChangeEvent)=> void; | ||
| declare type SyncStartHandler = (event: SyncStartEvent)=> void; | ||
| /** | ||
| * The workspace service provides access to all the parts of Joplin that | ||
| * are being worked on - i.e. the currently selected notes or notebooks as | ||
| * well as various related events, such as when a new note is selected, or | ||
| * when the note content changes. | ||
| * | ||
| * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins) | ||
| */ | ||
| export default class JoplinWorkspace { | ||
| private store; | ||
| constructor(store: any); | ||
| /** | ||
| * Called when a new note or notes are selected. | ||
| */ | ||
| onNoteSelectionChange(callback: Function): Promise<Disposable>; | ||
| /** | ||
| * Called when the content of a note changes. | ||
| * @deprecated Use `onNoteChange()` instead, which is reliably triggered whenever the note content, or any note property changes. | ||
| */ | ||
| onNoteContentChange(callback: Function): Promise<void>; | ||
| /** | ||
| * Called when the content of the current note changes. | ||
| */ | ||
| onNoteChange(handler: ItemChangeHandler): Promise<Disposable>; | ||
| /** | ||
| * Called when an alarm associated with a to-do is triggered. | ||
| */ | ||
| onNoteAlarmTrigger(handler: Function): Promise<Disposable>; | ||
| /** | ||
| * Called when the synchronisation process is starting. | ||
| */ | ||
| onSyncStart(handler: SyncStartHandler): Promise<Disposable>; | ||
| /** | ||
| * Called when the synchronisation process has finished. | ||
| */ | ||
| onSyncComplete(callback: Function): Promise<Disposable>; | ||
| /** | ||
| * Gets the currently selected note | ||
| */ | ||
| selectedNote(): Promise<any>; | ||
| /** | ||
| * Gets the currently selected folder. In some cases, for example during | ||
| * search or when viewing a tag, no folder is actually selected in the user | ||
| * interface. In that case, that function would return the last selected | ||
| * folder. | ||
| */ | ||
| selectedFolder(): Promise<FolderEntity>; | ||
| /** | ||
| * Gets the IDs of the selected notes (can be zero, one, or many). Use the data API to retrieve information about these notes. | ||
| */ | ||
| selectedNoteIds(): Promise<string[]>; | ||
| } | ||
| export {}; |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import type Joplin from './Joplin'; | ||
|
|
||
| declare const joplin: Joplin; | ||
|
|
||
| export default joplin; |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "name": "joplin-plugin-load-css-demo", | ||
| "version": "1.0.0", | ||
| "scripts": { | ||
| "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive", | ||
| "prepare": "npm run dist", | ||
| "update": "npm install -g generator-joplin && yo joplin --update" | ||
| }, | ||
| "license": "MIT", | ||
| "keywords": [ | ||
| "joplin-plugin" | ||
| ], | ||
| "devDependencies": { | ||
| "@types/node": "^14.0.14", | ||
| "chalk": "^4.1.0", | ||
| "copy-webpack-plugin": "^6.1.0", | ||
| "fs-extra": "^9.0.1", | ||
| "glob": "^7.1.6", | ||
| "on-build-webpack": "^0.1.0", | ||
| "tar": "^6.0.5", | ||
| "ts-loader": "^7.0.5", | ||
| "typescript": "^3.9.3", | ||
| "webpack": "^4.43.0", | ||
| "webpack-cli": "^3.3.11", | ||
| "yargs": "^16.2.0" | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "extraScripts": [] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| .folders { | ||
| border: 1px solid red; | ||
| } | ||
|
|
||
| .cm-strong { | ||
| border: 1px solid green; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import joplin from 'api'; | ||
|
|
||
| joplin.plugins.register({ | ||
| onStart: async function() { | ||
| const installDir = await joplin.plugins.installationDir(); | ||
| const chromeCssFilePath = installDir + '/chrome.css'; | ||
| const noteCssFilePath = installDir + '/note.css'; | ||
| await (joplin as any).window.loadChromeCssFile(chromeCssFilePath); | ||
| await (joplin as any).window.loadNoteCssFile(noteCssFilePath); | ||
| }, | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "manifest_version": 1, | ||
| "id": "org.joplinapp.plugins.LoadCssDemo", | ||
| "app_min_version": "2.0", | ||
| "version": "1.0.0", | ||
| "name": "Load CSS Demo", | ||
| "description": "", | ||
| "author": "", | ||
| "homepage_url": "", | ||
| "repository_url": "", | ||
| "keywords": [] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| strong { | ||
| border: 1px solid red; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "outDir": "./dist/", | ||
| "module": "commonjs", | ||
| "target": "es2015", | ||
| "jsx": "react", | ||
| "allowJs": true, | ||
| "baseUrl": "." | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,281 @@ | ||
| // ----------------------------------------------------------------------------- | ||
| // This file is used to build the plugin file (.jpl) and plugin info (.json). It | ||
| // is recommended not to edit this file as it would be overwritten when updating | ||
| // the plugin framework. If you do make some changes, consider using an external | ||
| // JS file and requiring it here to minimize the changes. That way when you | ||
| // update, you can easily restore the functionality you've added. | ||
| // ----------------------------------------------------------------------------- | ||
|
|
||
| const path = require('path'); | ||
| const crypto = require('crypto'); | ||
| const fs = require('fs-extra'); | ||
| const chalk = require('chalk'); | ||
| const CopyPlugin = require('copy-webpack-plugin'); | ||
| const WebpackOnBuildPlugin = require('on-build-webpack'); | ||
| const tar = require('tar'); | ||
| const glob = require('glob'); | ||
| const execSync = require('child_process').execSync; | ||
|
|
||
| const rootDir = path.resolve(__dirname); | ||
| const userConfigFilename = './plugin.config.json'; | ||
| const userConfigPath = path.resolve(rootDir, userConfigFilename); | ||
| const distDir = path.resolve(rootDir, 'dist'); | ||
| const srcDir = path.resolve(rootDir, 'src'); | ||
| const publishDir = path.resolve(rootDir, 'publish'); | ||
|
|
||
| const userConfig = Object.assign({}, { | ||
| extraScripts: [], | ||
| }, fs.pathExistsSync(userConfigPath) ? require(userConfigFilename) : {}); | ||
|
|
||
| const manifestPath = `${srcDir}/manifest.json`; | ||
| const packageJsonPath = `${rootDir}/package.json`; | ||
| const manifest = readManifest(manifestPath); | ||
| const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); | ||
| const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); | ||
|
|
||
| function validatePackageJson() { | ||
| const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); | ||
| if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { | ||
| console.warn(chalk.yellow(`WARNING: To publish the plugin, the package name should start with "joplin-plugin-" (found "${content.name}") in ${packageJsonPath}`)); | ||
| } | ||
|
|
||
| if (!content.keywords || content.keywords.indexOf('joplin-plugin') < 0) { | ||
| console.warn(chalk.yellow(`WARNING: To publish the plugin, the package keywords should include "joplin-plugin" (found "${JSON.stringify(content.keywords)}") in ${packageJsonPath}`)); | ||
| } | ||
|
|
||
| if (content.scripts && content.scripts.postinstall) { | ||
| console.warn(chalk.yellow(`WARNING: package.json contains a "postinstall" script. It is recommended to use a "prepare" script instead so that it is executed before publish. In ${packageJsonPath}`)); | ||
| } | ||
| } | ||
|
|
||
| function fileSha256(filePath) { | ||
| const content = fs.readFileSync(filePath); | ||
| return crypto.createHash('sha256').update(content).digest('hex'); | ||
| } | ||
|
|
||
| function currentGitInfo() { | ||
| try { | ||
| let branch = execSync('git rev-parse --abbrev-ref HEAD', { stdio: 'pipe' }).toString().trim(); | ||
| const commit = execSync('git rev-parse HEAD', { stdio: 'pipe' }).toString().trim(); | ||
| if (branch === 'HEAD') branch = 'master'; | ||
| return `${branch}:${commit}`; | ||
| } catch (error) { | ||
| const messages = error.message ? error.message.split('\n') : ['']; | ||
| console.info(chalk.cyan('Could not get git commit (not a git repo?):', messages[0].trim())); | ||
| console.info(chalk.cyan('Git information will not be stored in plugin info file')); | ||
| return ''; | ||
| } | ||
| } | ||
|
|
||
| function readManifest(manifestPath) { | ||
| const content = fs.readFileSync(manifestPath, 'utf8'); | ||
| const output = JSON.parse(content); | ||
| if (!output.id) throw new Error(`Manifest plugin ID is not set in ${manifestPath}`); | ||
| return output; | ||
| } | ||
|
|
||
| function createPluginArchive(sourceDir, destPath) { | ||
| const distFiles = glob.sync(`${sourceDir}/**/*`, { nodir: true }) | ||
| .map(f => f.substr(sourceDir.length + 1)); | ||
|
|
||
| if (!distFiles.length) throw new Error('Plugin archive was not created because the "dist" directory is empty'); | ||
| fs.removeSync(destPath); | ||
|
|
||
| tar.create( | ||
| { | ||
| strict: true, | ||
| portable: true, | ||
| file: destPath, | ||
| cwd: sourceDir, | ||
| sync: true, | ||
| }, | ||
| distFiles | ||
| ); | ||
|
|
||
| console.info(chalk.cyan(`Plugin archive has been created in ${destPath}`)); | ||
| } | ||
|
|
||
| function createPluginInfo(manifestPath, destPath, jplFilePath) { | ||
| const contentText = fs.readFileSync(manifestPath, 'utf8'); | ||
| const content = JSON.parse(contentText); | ||
| content._publish_hash = `sha256:${fileSha256(jplFilePath)}`; | ||
| content._publish_commit = currentGitInfo(); | ||
| fs.writeFileSync(destPath, JSON.stringify(content, null, '\t'), 'utf8'); | ||
| } | ||
|
|
||
| function onBuildCompleted() { | ||
| try { | ||
| fs.removeSync(path.resolve(publishDir, 'index.js')); | ||
| createPluginArchive(distDir, pluginArchiveFilePath); | ||
| createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); | ||
| validatePackageJson(); | ||
| } catch (error) { | ||
| console.error(chalk.red(error.message)); | ||
| } | ||
| } | ||
|
|
||
| const baseConfig = { | ||
| mode: 'production', | ||
| target: 'node', | ||
| stats: 'errors-only', | ||
| module: { | ||
| rules: [ | ||
| { | ||
| test: /\.tsx?$/, | ||
| use: 'ts-loader', | ||
| exclude: /node_modules/, | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
|
|
||
| const pluginConfig = Object.assign({}, baseConfig, { | ||
| entry: './src/index.ts', | ||
| resolve: { | ||
| alias: { | ||
| api: path.resolve(__dirname, 'api'), | ||
| }, | ||
| // JSON files can also be required from scripts so we include this. | ||
| // https://github.com/joplin/plugin-bibtex/pull/2 | ||
| extensions: ['.tsx', '.ts', '.js', '.json'], | ||
| }, | ||
| output: { | ||
| filename: 'index.js', | ||
| path: distDir, | ||
| }, | ||
| plugins: [ | ||
| new CopyPlugin({ | ||
| patterns: [ | ||
| { | ||
| from: '**/*', | ||
| context: path.resolve(__dirname, 'src'), | ||
| to: path.resolve(__dirname, 'dist'), | ||
| globOptions: { | ||
| ignore: [ | ||
| // All TypeScript files are compiled to JS and | ||
| // already copied into /dist so we don't copy them. | ||
| '**/*.ts', | ||
| '**/*.tsx', | ||
| ], | ||
| }, | ||
| }, | ||
| ], | ||
| }), | ||
| ], | ||
| }); | ||
|
|
||
| const extraScriptConfig = Object.assign({}, baseConfig, { | ||
| resolve: { | ||
| alias: { | ||
| api: path.resolve(__dirname, 'api'), | ||
| }, | ||
| extensions: ['.tsx', '.ts', '.js', '.json'], | ||
| }, | ||
| }); | ||
|
|
||
| const createArchiveConfig = { | ||
| stats: 'errors-only', | ||
| entry: './dist/index.js', | ||
| output: { | ||
| filename: 'index.js', | ||
| path: publishDir, | ||
| }, | ||
| plugins: [new WebpackOnBuildPlugin(onBuildCompleted)], | ||
| }; | ||
|
|
||
| function resolveExtraScriptPath(name) { | ||
| const relativePath = `./src/${name}`; | ||
|
|
||
| const fullPath = path.resolve(`${rootDir}/${relativePath}`); | ||
| if (!fs.pathExistsSync(fullPath)) throw new Error(`Could not find extra script: "${name}" at "${fullPath}"`); | ||
|
|
||
| const s = name.split('.'); | ||
| s.pop(); | ||
| const nameNoExt = s.join('.'); | ||
|
|
||
| return { | ||
| entry: relativePath, | ||
| output: { | ||
| filename: `${nameNoExt}.js`, | ||
| path: distDir, | ||
| library: 'default', | ||
| libraryTarget: 'commonjs', | ||
| libraryExport: 'default', | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| function buildExtraScriptConfigs(userConfig) { | ||
| if (!userConfig.extraScripts.length) return []; | ||
|
|
||
| const output = []; | ||
|
|
||
| for (const scriptName of userConfig.extraScripts) { | ||
| const scriptPaths = resolveExtraScriptPath(scriptName); | ||
| output.push(Object.assign({}, extraScriptConfig, { | ||
| entry: scriptPaths.entry, | ||
| output: scriptPaths.output, | ||
| })); | ||
| } | ||
|
|
||
| return output; | ||
| } | ||
|
|
||
| function main(processArgv) { | ||
| const yargs = require('yargs/yargs'); | ||
| const argv = yargs(processArgv).argv; | ||
|
|
||
| const configName = argv['joplin-plugin-config']; | ||
| if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag'); | ||
|
|
||
| // Webpack configurations run in parallel, while we need them to run in | ||
| // sequence, and to do that it seems the only way is to run webpack multiple | ||
| // times, with different config each time. | ||
|
|
||
| const configs = { | ||
| // Builds the main src/index.ts and copy the extra content from /src to | ||
| // /dist including scripts, CSS and any other asset. | ||
| buildMain: [pluginConfig], | ||
|
|
||
| // Builds the extra scripts as defined in plugin.config.json. When doing | ||
| // so, some JavaScript files that were copied in the previous might be | ||
| // overwritten here by the compiled version. This is by design. The | ||
| // result is that JS files that don't need compilation, are simply | ||
| // copied to /dist, while those that do need it are correctly compiled. | ||
| buildExtraScripts: buildExtraScriptConfigs(userConfig), | ||
|
|
||
| // Ths config is for creating the .jpl, which is done via the plugin, so | ||
| // it doesn't actually need an entry and output, however webpack won't | ||
| // run without this. So we give it an entry that we know is going to | ||
| // exist and output in the publish dir. Then the plugin will delete this | ||
| // temporary file before packaging the plugin. | ||
| createArchive: [createArchiveConfig], | ||
| }; | ||
|
|
||
| // If we are running the first config step, we clean up and create the build | ||
| // directories. | ||
| if (configName === 'buildMain') { | ||
| fs.removeSync(distDir); | ||
| fs.removeSync(publishDir); | ||
| fs.mkdirpSync(publishDir); | ||
| } | ||
|
|
||
| return configs[configName]; | ||
| } | ||
|
|
||
| let exportedConfigs = []; | ||
|
|
||
| try { | ||
| exportedConfigs = main(process.argv); | ||
| } catch (error) { | ||
| console.error(chalk.red(error.message)); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| if (!exportedConfigs.length) { | ||
| // Nothing to do - for example where there are no external scripts to | ||
| // compile. | ||
| process.exit(0); | ||
| } | ||
|
|
||
| module.exports = exportedConfigs; |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| import Plugin from '../Plugin'; | ||
| import * as fs from 'fs-extra'; | ||
|
|
||
| export interface Implementation { | ||
| injectCustomStyles(elementId: string, cssFilePath: string): Promise<void>; | ||
| } | ||
|
|
||
| export default class JoplinWindow { | ||
|
|
||
| private plugin_: Plugin; | ||
| private store_: any; | ||
| private implementation_: Implementation; | ||
|
|
||
| public constructor(implementation: Implementation, plugin: Plugin, store: any) { | ||
| this.implementation_ = implementation; | ||
| this.plugin_ = plugin; | ||
| this.store_ = store; | ||
| } | ||
|
|
||
| /** | ||
| * Loads a chrome CSS file. It will apply to the window UI elements, except | ||
| * for the note viewer. It is the same as the "Custom stylesheet for | ||
| * Joplin-wide app styles" setting. See the [Load CSS Demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/load_css) | ||
| * for an example. | ||
| */ | ||
| public async loadChromeCssFile(filePath: string) { | ||
| await this.implementation_.injectCustomStyles(`pluginStyles_${this.plugin_.id}`, filePath); | ||
| } | ||
|
|
||
| /** | ||
| * Loads a note CSS file. It will apply to the note viewer, as well as any | ||
| * exported or printed note. It is the same as the "Custom stylesheet for | ||
| * rendered Markdown" setting. See the [Load CSS Demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/load_css) | ||
| * for an example. | ||
| */ | ||
| public async loadNoteCssFile(filePath: string) { | ||
| const cssString = await fs.readFile(filePath, 'utf8'); | ||
|
|
||
| this.store_.dispatch({ | ||
| type: 'CUSTOM_CSS_APPEND', | ||
| css: cssString, | ||
| }); | ||
| } | ||
|
|
||
| } |