zotero-plugin-scaffold 0.6.0 → 0.7.0

package/README.md

@@ -1,11 +1,57 @@
 # Zotero Plugin Development Scaffold
 
-Delivering a modern and elegant development experience for Zotero plugins.
+[![NPM Version](https://img.shields.io/npm/v/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)
+[![NPM Downloads](https://img.shields.io/npm/dm/zotero-plugin-scaffold)](https://www.npmjs.com/package/zotero-plugin-scaffold)
+![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/zotero-plugin-scaffold)
+![GitHub License](https://img.shields.io/github/license/northword/zotero-plugin-scaffold)
+[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
+
+This is an npm package designed to assist in the development of Zotero plugins. It provides features such as compiling plugins, starting Zotero and installing plugins from source code, reloading plugins when the source code changes, and releasing plugins, and so on.
+
+Initially, the code of this package was part of the [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template) repository. To allow downstream developers to easily stay up-to-date, we have abstracted these scripts into a standalone npm package.
+
+This project is under active development, and some APIs may change. However, it is ready for production and has been [used in several projects](https://github.com/northword/zotero-plugin-scaffold/network/dependents).
+
+For best practices regarding this package, please refer to [zotero-plugin-template](https://github.com/windingwind/zotero-plugin-template).
 
 ## Documentation
 
 [Read the Docs to Learn More](https://northword.github.io/zotero-plugin-scaffold).
 
+## Contributing
+
+```bash
+# Git Clone
+git clone https://github.com/northword/zotero-plugin-scaffold.git zotero-plugin-scaffold
+cd zotero-plugin-scaffold/
+
+# Install deps
+corepack enable
+pnpm install
+
+# Development Mode
+# This command creates a typescript runtime using jiti,
+# and the modified code does not need to be built again.
+pnpm run dev
+
+# link local scaffold to your plugin
+cd your-plugin-work-dir/
+pnpm link ../zotero-plugin-scaffold/packages/scaffold/
+cd zotero-plugin-scaffold/
+```
+
+Now you can make changes to Scaffold and test them in your plugin.
+
+When you're done modifying, make sure that you can pass the build and that the code style meets the requirements of this repository.
+
+```bash
+# Build
+pnpm run build
+
+# ES Lint
+pnpm run lint:fix
+```
+
 ## License
 
 GNU Affero General Public License Version 3.

package/dist/cli.d.mts

@@ -1,3 +1,9 @@
+import { B as Base, C as Context, O as OverrideConfig } from './shared/zotero-plugin-scaffold.DmiRKKLw.mjs';
+import 'hookable';
+import 'esbuild';
+
+type Constructor<T> = new (ctx: Context) => T;
+declare function runCommand<T extends Base>(CommandClass: Constructor<T>, config: OverrideConfig): Promise<void>;
 declare function mainWithErrorHandler(): Promise<void>;
 
-export { mainWithErrorHandler as default };
+export { mainWithErrorHandler as default, runCommand };

package/dist/cli.mjs

@@ -1,28 +1,31 @@
 import process from 'node:process';
 import { Command } from 'commander';
-import { l as logger, E as ExitSignals, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.C-SXQX4J.mjs';
+import { E as ExitSignals, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.D2qdHZn7.mjs';
 import { readFile } from 'node:fs/promises';
 import { pathExists } from 'fs-extra';
+import { l as logger } from './shared/zotero-plugin-scaffold.CzBjWbS8.mjs';
 import tinyUpdateNotifier from 'tiny-update-notifier';
 import 'c12';
 import 'es-toolkit';
 import 'fs-extra/esm';
 import 'hookable';
-import 'node:readline';
-import 'node:util';
-import 'std-env';
-import './shared/zotero-plugin-scaffold.v8dJZZ-v.mjs';
 import 'tinyglobby';
 import 'node:path';
-import 'adm-zip';
 import 'esbuild';
-import 'node:crypto';
-import 'node:fs';
 import '@fluent/syntax';
+import 'node:fs';
 import '@swc/core';
+import 'node:crypto';
+import 'adm-zip';
 import 'node:child_process';
+import 'std-env';
 import 'bumpp';
 import 'octokit';
+import 'node:os';
+import 'node:url';
+import 'node:assert';
+import 'node:v8';
+import 'node:util';
 import 'chokidar';
 import 'node:net';
 import 'node:buffer';
@@ -30,9 +33,10 @@ import 'node:domain';
 import 'node:events';
 import 'xvfb-ts';
 import 'node:http';
+import 'node:readline';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.6.0";
+const version = "0.7.0";
 const pkg = {
 	name: name,
 	version: version};
@@ -71,32 +75,30 @@ async function main() {
   process.env.NODE_ENV ??= "development";
   const cli = new Command();
   cli.version(version).usage("<command> [options]");
-  cli.command("build").description("Build the plugin").option("--dev", "Builds the plugin in dev mode").option("--dist <dir>", "The relative path for the new output directory (default: build)").action((options) => {
+  cli.command("build").description("Build the plugin").option("--dev", "Builds the plugin in dev mode").option("--dist <dir>", "The relative path for the new output directory (default: build)").action(async (options) => {
     process.env.NODE_ENV = options.dev ? "development" : "production";
-    Config.loadConfig({
+    await runCommand(Build, {
       dist: options.dist
-    }).then((ctx) => new Build(ctx).run());
+    });
   });
-  cli.command("serve").alias("dev").description("Start development server").action((_options) => {
-    Config.loadConfig({}).then((ctx) => new Serve(ctx).run());
+  cli.command("serve").alias("dev").description("Start development server").action(async (_options) => {
+    await runCommand(Serve, {});
   });
-  cli.command("test").description("Run tests").option("--abort-on-fail", "Abort the test suite on first failure").option("--exit-on-finish", "Exit the test suite after all tests have run").option("--no-watch", "Exit the test suite after all tests have run").action((options) => {
+  cli.command("test").description("Run tests").option("--abort-on-fail", "Abort the test suite on first failure").option("--exit-on-finish", "Exit the test suite after all tests have run").option("--no-watch", "Exit the test suite after all tests have run").action(async (options) => {
     process.env.NODE_ENV = "test";
-    Config.loadConfig({
+    await runCommand(Test, {
       test: {
         abortOnFail: options.abortOnFail,
         watch: !options.exitOnFinish && options.watch
       }
-    }).then((ctx) => {
-      new Test(ctx).run();
     });
   });
-  cli.command("create").description("Create the plugin template").action((_options) => {
+  cli.command("create").description("Create the plugin template").action(async (_options) => {
     logger.error("The create not yet implemented");
   });
   cli.command("release").description("Release the plugin").argument("[version]", "Target version: major, minor, patch, pre*, or specify version").option("--preid <preid>", "ID for prerelease").option("-y, --yes", "Skip confirmation").action(async (version2, options) => {
     process.env.NODE_ENV = "production";
-    Config.loadConfig({
+    await runCommand(Release, {
       release: {
         bumpp: {
           release: version2,
@@ -104,7 +106,7 @@ async function main() {
           confirm: !options.yes
         }
       }
-    }).then((ctx) => new Release(ctx).run());
+    });
   });
   cli.arguments("<command>").action((cmd) => {
     cli.outputHelp();
@@ -112,6 +114,12 @@ async function main() {
   });
   cli.parse();
 }
+async function runCommand(CommandClass, config) {
+  const ctx = await Config.loadConfig(config);
+  const instance = new CommandClass(ctx);
+  process.on("SIGINT", instance.exit.bind(instance));
+  await instance.run();
+}
 async function mainWithErrorHandler() {
   main().then(() => {
     checkGitIgnore();
@@ -126,4 +134,4 @@ function onError(err) {
   process.exit(1);
 }
 
-export { mainWithErrorHandler as default };
+export { mainWithErrorHandler as default, runCommand };