joplin/packages/generator-joplin

generator-joplin

Scaffolds out a new Joplin plugin

Installation

First, install Yeoman and generator-joplin using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-joplin

Then generate your new project:

yo joplin

Development

To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator This is a template to create a new Joplin plugin.

Structure

The main two files you will want to look at are:

• /src/index.ts, which contains the entry point for the plugin source code.
• /src/manifest.json, which is the plugin manifest. It contains information such as the plugin a name, version, etc.

Building the plugin

The plugin is built using Webpack, which creates the compiled code in /dist. A JPL archive will also be created at the root, which can use to distribute the plugin.

To build the plugin, simply run npm run dist.

The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.

Publishing the plugin

To publish the plugin, add it to npmjs.com by running npm publish. Later on, a script will pick up your plugin and add it automatically to the Joplin plugin repository as long as the package satisfies these conditions:

• In package.json, the name starts with "joplin-plugin-". For example, "joplin-plugin-toc".
• In package.json, the keywords include "joplin-plugin".
• In the publish/ directory, there should be a .jpl and .json file (which are built by npm run dist)

In general all this is done automatically by the plugin generator, which will set the name and keywords of package.json, and will put the right files in the "publish" directory. But if something doesn't work and your plugin doesn't appear in the repository, double-check the above conditions.

Updating the plugin framework

To update the plugin framework, run npm run update.

In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.

The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.

Content scripts

A plugin that uses content scripts must declare them under the content_scripts key of manifest.json.

Each entry must be a path relative to /src, and without extension. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.

For example, assuming these files:

/src
    index.ts                # Main plugin script
    myContentScript.js      # One content script (JS)
    otherContentScript.ts   # Another content script (TypeScript)
    vendor/
        test.ts             # Sub-directories are also supported

The manifest.json file would be:

{
    "manifest_version": 1,
    "name": "Testing Content Scripts",
    content_scripts: [
        "myContentScript",
        "otherContentScript",
        "vendor/test"
    ]
}

Note in particular how the file path is relative to /src and the extensions removed.

License

MIT © Laurent Cozic