Types and tools for Joplin plugins.
This repository has a few packages managed as Yarn workspaces. These are the packages:
joplin
: The upstream Joplin package, as a Git submodule.extract
: A package that uses the TypeScript compilerjoplin
.joplin-plugin
: The only package in thisexample-*
: Example Joplin plugins used to test joplin-plugin
. Theyjoplin-plugin
specified as a relative path.To publish a new version of joplin-plugin
following a release of Joplin:
yarn install
.extract
package,
src/pipeline.ts
:
upstreamVersion
: The version of the Joplin source files.upstreamRef
: The GitHub reference from which to extract the sourceupstreamVersion
,packages/lib/package.json
has the samedownstreamVersion
: The version of @thejohnfreeman/joplin-plugin
upstreamVersion
suffixedyarn build
.yarn start
.example-*
package, test that it can be built with noyarn build
. If there are errors, it could be because the APIjoplin-plugin
package:
yarn version
.yarn publish
.