zotero-plugin-scaffold 0.8.2 → 0.8.4

package/README.md

@@ -1,7 +1,7 @@
 # Zotero Plugin Development Scaffold
 
-[![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 Version](https://img.shields.io/npm/v/zotero-plugin-scaffold)](https://npmx.dev/package/zotero-plugin-scaffold)
+[![NPM Downloads](https://img.shields.io/npm/dm/zotero-plugin-scaffold)](https://npmx.dev/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/zotero-plugin-dev/zotero-plugin-scaffold)
 [![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
@@ -30,8 +30,6 @@ 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

package/bin/zotero-plugin.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-import cli from "../dist/cli.mjs";
+import cli from "../dist/cli.js";
 
 cli();

package/dist/cli.d.ts

@@ -0,0 +1,9 @@
+import { n as OverrideConfig, t as Context } from "./shared/scaffold-index-BAX-e18l.mjs";
+import { t as Base } from "./shared/scaffold-base-DINIqpGc.mjs";
+
+//#region src/cli.d.ts
+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>;
+//#endregion
+export { mainWithErrorHandler as default, runCommand };

package/dist/cli.js

@@ -0,0 +1,100 @@
+import { l as logger } from "./shared/scaffold-replace-BTU0g6CT.mjs";
+import { a as Release, i as ExitSignals, n as Test, o as Build, r as Serve, t as Config } from "./shared/scaffold-src-BXURNLxp.mjs";
+import process from "node:process";
+import { readFile } from "node:fs/promises";
+import { Command } from "commander";
+import { pathExists } from "fs-extra";
+import tinyUpdateNotifier from "tiny-update-notifier";
+//#region package.json
+var name = "zotero-plugin-scaffold";
+var version = "0.8.4";
+//#endregion
+//#region src/utils/gitignore.ts
+async function checkGitIgnore() {
+	if (!pathExists(".git")) return;
+	if (!pathExists(".gitignore")) {
+		logger.warn("No .gitignore file found");
+		return;
+	}
+	const contents = await readFile(".gitignore", "utf-8");
+	const miss = [
+		"node_modules",
+		".env",
+		".scaffold"
+	].filter((ignore) => !contents.match(ignore));
+	if (miss.length !== 0) logger.warn(`We recommend adding the following to your .gitignore file: ${miss.join(", ")}`);
+}
+//#endregion
+//#region src/utils/updater.ts
+function updateNotifier(name, version) {
+	tinyUpdateNotifier({ pkg: {
+		name,
+		version
+	} }).then((update) => {
+		if (update) {
+			const notify = () => {
+				logger.newLine();
+				logger.info(`New version of ${update.name} available!`);
+				logger.info(`Update: ${update.current} → ${update.latest} (${update.type})`);
+				logger.newLine();
+			};
+			ExitSignals.forEach((sig) => process.once(sig, notify));
+		}
+	}).catch();
+}
+//#endregion
+//#region src/cli.ts
+async function main() {
+	updateNotifier(name, version);
+	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(async (options) => {
+		process.env.NODE_ENV = options.dev ? "development" : "production";
+		await runCommand(Build, { dist: options.dist });
+	});
+	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(async (options) => {
+		process.env.NODE_ENV = "test";
+		await runCommand(Test, { test: {
+			abortOnFail: options.abortOnFail,
+			watch: !options.exitOnFinish && options.watch
+		} });
+	});
+	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 (version, options) => {
+		process.env.NODE_ENV = "production";
+		await runCommand(Release, { release: { bumpp: {
+			release: version,
+			preid: options.preid,
+			confirm: !options.yes
+		} } });
+	});
+	cli.arguments("<command>").action((cmd) => {
+		cli.outputHelp();
+		logger.error(`Unknown command name "${cmd}".`);
+	});
+	cli.parse();
+}
+async function runCommand(CommandClass, config) {
+	const instance = new CommandClass(await Config.loadConfig(config));
+	process.on("SIGINT", instance.exit.bind(instance));
+	await instance.run();
+}
+async function mainWithErrorHandler() {
+	main().then(() => {
+		checkGitIgnore();
+	}).catch(onError);
+	process.on("uncaughtException", onError);
+}
+function onError(err) {
+	logger.error(err);
+	if (err.output) logger.log(err.output.stderr);
+	process.exit(1);
+}
+//#endregion
+export { mainWithErrorHandler as default, runCommand };

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import { n as OverrideConfig, r as UserConfig, t as Context } from "./shared/scaffold-index-BAX-e18l.mjs";
+import { t as Base } from "./shared/scaffold-base-DINIqpGc.mjs";
+
+//#region src/config.d.ts
+/**
+* Helper for user define configuration.
+*/
+declare function defineConfig(userConfig: UserConfig): UserConfig;
+/**
+* Loads config
+* @param [overrides] Highest Priority Configuration.
+* @returns Config with userDefined and defaultConfig merged.
+*/
+declare function loadConfig(overrides?: OverrideConfig): Promise<Context>;
+//#endregion
+//#region src/core/builder/index.d.ts
+declare class Build extends Base {
+  private buildTime;
+  constructor(ctx: Context);
+  /**
+  * Default build runner
+  */
+  run(): Promise<void>;
+  private prepareAssets;
+  bundle(): Promise<void>;
+  buildInProduction(): Promise<void>;
+  exit(): void;
+}
+//#endregion
+//#region src/core/releaser/index.d.ts
+declare class Release extends Base {
+  constructor(ctx: Context);
+  /**
+  * Runs release
+  *
+  * if is not CI，bump version, git add (package.json), git commit, git tag, git push;
+  * if is CI, do not bump version, do not run git, create release (tag is `v${version}`) and upload xpi,
+  *    then, create or update release (tag is "release"), update `update.json`.
+  */
+  run(): Promise<void>;
+  getChangelog(): Promise<string>;
+  private isEnabled;
+  exit(): void;
+  get resolvedCommitMessage(): string;
+}
+//#endregion
+//#region src/core/server.d.ts
+declare class Serve extends Base {
+  private builder;
+  private runner?;
+  private _zoteroBinPath?;
+  constructor(ctx: Context);
+  run(): Promise<void>;
+  /**
+  * watch source dir and build when file changed
+  */
+  watch(): Promise<void>;
+  reload(): Promise<void>;
+  exit: () => never;
+  private onZoteroExit;
+  get zoteroBinPath(): string;
+  get profilePath(): string | undefined;
+  get dataDir(): string | undefined;
+}
+//#endregion
+//#region src/core/tester/index.d.ts
+declare class Test extends Base {
+  private builder;
+  private zotero?;
+  private reporter;
+  private testBundler?;
+  constructor(ctx: Context);
+  run(): Promise<void>;
+  watch(): Promise<void>;
+  startZotero(): Promise<void>;
+  private onZoteroExit;
+  exit: (code?: string | number) => never;
+  private get zoteroBinPath();
+  private get prefs();
+}
+//#endregion
+//#region src/index.d.ts
+declare const Config: {
+  defineConfig: typeof defineConfig;
+  loadConfig: typeof loadConfig;
+};
+//#endregion
+export { Build, Config, Release, Serve, Test, defineConfig };

package/dist/index.js

@@ -0,0 +1,3 @@
+import "./shared/scaffold-replace-BTU0g6CT.mjs";
+import { a as Release, n as Test, o as Build, r as Serve, s as defineConfig, t as Config } from "./shared/scaffold-src-BXURNLxp.mjs";
+export { Build, Config, Release, Serve, Test, defineConfig };

package/dist/shared/scaffold-base-DINIqpGc.d.mts

@@ -0,0 +1,12 @@
+import { i as Logger, t as Context } from "./scaffold-index-BAX-e18l.mjs";
+
+//#region src/core/base.d.ts
+declare abstract class Base {
+  ctx: Context;
+  constructor(ctx: Context);
+  abstract run(): void | Promise<void>;
+  abstract exit(): void;
+  get logger(): Logger;
+}
+//#endregion
+export { Base as t };