tiddlywiki-plugin-dev

中文README

Tiddlywiki plugin development tool, working with Modern.TiddlyDev.

This is a npm CLI tool, helping developers to develop and build TiddlyWiki plugins with TypeScript (If you don't know TypeScript, you can also use it as a handy plug-in development tool.)

Usage

This tool needs to be used with Modern.TiddlyDev, so it is not introduced here, please refer to the Document of Modern.TiddlyDev for detailed usage.

ESM Build Notes

The package is published as native ESM ("type": "module").

• Source files in src/ keep extensionless TypeScript imports (for better DX).
• During modern build, a compile-time Babel plugin rewrites only relative imports in emitted JS to include .js extensions.
• CLI usage is unchanged: npx tiddlywiki-plugin-dev ....

help

npx tiddlywiki-plugin-dev help

output:

Usage: tiddlywiki-plugin-dev [options] [command]

Options:
  -h, --help       display help for command

Commands:
  dev              Develop yout plugins with Modern.TiddlyDev
  build [options]  Build plugins for Modern.TiddlyDev
  help [command]   display help for command

Developing plugins

Start a TiddlyWiki server with your plugin(s) for test. It will always watch the file changes in the plugin folder(s) and wiki folder, then refresh the browser page automatically.

npx tiddlywiki-plugin-dev dev

output:

Compiling...
████████████████████████████████████████ 100% | plugin-name

 syncer-server-filesystem: Dispatching 'save' task: $:/StoryList
Serving on http://127.0.0.1:8080
(press ctrl-C to exit)

Build plugins

Build plugins alone

npx tiddlywiki-plugin-dev build

output:

Compiling...
████████████████████████████████████████ 100% | plugin-name

 Minimized plugins
   2.02 KiB   $:/plugins/your-name/plugin-name

Build with a plugin library (publishing to your subscribers)

npx tiddlywiki-plugin-dev build --library

output:

Compiling...
████████████████████████████████████████ 100% | plugin-name

 Minimized plugins
   2.02 KiB   $:/plugins/your-name/plugin-name

Generating plugin library...
 syncer-server-filesystem: Dispatching 'save' task: $:/StoryList
 syncer-server-filesystem: Dispatching 'save' task: $:/UpgradeLibrary/List
 syncer-server-filesystem: Dispatching 'delete' task: $:/UpgradeLibrary
 syncer-server-filesystem: Dispatching 'delete' task: $:/UpgradeLibrary/List