zotero-plugin-scaffold 0.2.0-beta.12 → 0.2.0-beta.14

package/README.md

@@ -1,56 +1,10 @@
 # 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 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).
+Delivering a modern and elegant development experience for Zotero plugins.
 
 ## 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
-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
-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
-```
+[Read the Docs to Learn More](https://northword.github.io/zotero-plugin-scaffold).
 
 ## License
 

package/bin/zotero-plugin.mjs

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

package/dist/chunks/github.mjs

@@ -1,22 +1,21 @@
 import { readFile, stat } from 'node:fs/promises';
-import { join, basename } from 'node:path';
+import { extname, join, basename } from 'node:path';
 import process from 'node:process';
-import mime from 'mime';
 import { Octokit } from 'octokit';
 import { globSync, glob } from 'tinyglobby';
 import { isCI } from 'std-env';
-import { B as Base } from '../shared/zotero-plugin-scaffold.af8d03c3.mjs';
+import { B as Base } from '../shared/zotero-plugin-scaffold.rCsToUj_.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'fs-extra/esm';
 import 'hookable';
 import 'node:readline';
 import 'chalk';
-import '../shared/zotero-plugin-scaffold.77c9802c.mjs';
+import '../shared/zotero-plugin-scaffold.v8dJZZ-v.mjs';
+import 'node:fs';
 import 'adm-zip';
 import 'esbuild';
 import 'node:crypto';
-import 'node:fs';
 import 'node:child_process';
 import 'bumpp';
 import 'chokidar';
@@ -27,16 +26,23 @@ import 'node:events';
 import 'node:http';
 import 'xvfb-ts';
 
-var __defProp$1 = Object.defineProperty;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
+const mimeTypes = {
+  "application/json": ["json"],
+  "application/x-xpinstall": ["xpi"]
 };
+function getMimeTypeByFileName(filename) {
+  const ext = extname(filename);
+  for (const type in mimeTypes) {
+    if (mimeTypes[type].includes(ext))
+      return type;
+  }
+  return void 0;
+}
+
 class ReleaseBase extends Base {
+  isCI;
   constructor(ctx) {
     super(ctx);
-    __publicField$1(this, "isCI");
     this.isCI = isCI;
   }
   checkFiles() {
@@ -47,16 +53,10 @@ class ReleaseBase extends Base {
   }
 }
 
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class GitHub extends ReleaseBase {
+  client;
   constructor(ctx) {
     super(ctx);
-    __publicField(this, "client");
     this.client = this.getClient();
   }
   async run() {
@@ -118,7 +118,7 @@ class GitHub extends ReleaseBase {
       release_id: releaseID,
       data: await readFile(asset),
       headers: {
-        "content-type": mime.getType(asset) || "application/octet-stream",
+        "content-type": getMimeTypeByFileName(asset) || "application/octet-stream",
         "content-length": (await stat(asset)).size
       },
       name: basename(asset)
@@ -168,7 +168,7 @@ class GitHub extends ReleaseBase {
       release_id: release.id,
       name: "Release Manifest",
       body: `This release is used to host \`update.json\`, please do not delete or modify it! 
- Updated in UTC ${( new Date()).toISOString()} for version ${version}`,
+ Updated in UTC ${(/* @__PURE__ */ new Date()).toISOString()} for version ${version}`,
       prerelease: true,
       make_latest: "false"
     });

package/dist/cli.d.mts

@@ -1,3 +1,3 @@
-declare function main(): Promise<void>;
+declare function run(): Promise<void>;
 
-export { main as default };
+export { run as default };

package/dist/cli.d.ts

@@ -1,3 +1,3 @@
-declare function main(): Promise<void>;
+declare function run(): Promise<void>;
 
-export { main as default };
+export { run as default };

package/dist/cli.mjs

@@ -1,7 +1,6 @@
-#!/usr/bin/env node
 import process from 'node:process';
 import { Command } from '@commander-js/extra-typings';
-import { E as ExitSignals, l as logger, C as Config, a as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.af8d03c3.mjs';
+import { E as ExitSignals, l as logger, C as Config, a as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.rCsToUj_.mjs';
 import { readFile, writeFile } from 'node:fs/promises';
 import { pathExists, ensureFile } from 'fs-extra';
 import tinyUpdateNotifier from 'tiny-update-notifier';
@@ -12,13 +11,13 @@ import 'hookable';
 import 'node:readline';
 import 'chalk';
 import 'std-env';
-import './shared/zotero-plugin-scaffold.77c9802c.mjs';
+import './shared/zotero-plugin-scaffold.v8dJZZ-v.mjs';
 import 'tinyglobby';
+import 'node:fs';
 import 'node:path';
 import 'adm-zip';
 import 'esbuild';
 import 'node:crypto';
-import 'node:fs';
 import 'node:child_process';
 import 'bumpp';
 import 'chokidar';
@@ -31,15 +30,16 @@ import 'xvfb-ts';
 
 const name = "zotero-plugin-scaffold";
 const type = "module";
-const version = "0.2.0-beta.12";
-const packageManager = "pnpm@9.15.0";
+const version = "0.2.0-beta.14";
+const packageManager = "pnpm@9.15.2";
 const description = "A scaffold for Zotero plugin development.";
 const author = "northword";
 const license = "AGPL-3.0-or-later";
 const homepage = "https://github.com/northword/zotero-plugin-scaffold#readme";
 const repository = {
 	type: "git",
-	url: "https://github.com/northword/zotero-plugin-scaffold.git"
+	url: "https://github.com/northword/zotero-plugin-scaffold.git",
+	directory: "packages/scaffold"
 };
 const bugs = {
 	url: "https://github.com/northword/zotero-plugin-scaffold/issues"
@@ -56,6 +56,9 @@ const exports = {
 		types: "./dist/index.d.ts",
 		"import": "./dist/index.mjs"
 	},
+	"./cli": {
+		"import": "./dist/cli.mjs"
+	},
 	"./vendor": {
 		types: "./dist/vendor/index.d.ts",
 		"import": "./dist/vendor/index.mjs"
@@ -65,9 +68,10 @@ const main$1 = "./dist/index.mjs";
 const module = "./dist/index.mjs";
 const types = "./dist/index.d.ts";
 const bin = {
-	"zotero-plugin": "./dist/cli.mjs"
+	"zotero-plugin": "./bin/zotero-plugin.mjs"
 };
 const files = [
+	"bin",
 	"dist"
 ];
 const engines = {
@@ -76,22 +80,14 @@ const engines = {
 const scripts = {
 	dev: "unbuild --stub",
 	build: "tsc --noEmit && unbuild",
-	"lint:check": "eslint .",
-	"lint:fix": "eslint . --fix",
-	release: "bumpp --commit \"chore(release): publish v%s\"",
-	"update:deps": "pnpx taze minor -w -f -l",
-	test: "echo \"Error: no test specified\" && exit 1",
-	"docs:dev": "vitepress dev docs",
-	"docs:build": "vitepress build docs",
-	"docs:preview": "vitepress preview docs"
+	test: "echo \"Error: no test specified\" && exit 1"
 };
 const publishConfig = {
 	access: "public",
 	registry: "https://registry.npmjs.org"
 };
 const directories = {
-	lib: "dist",
-	doc: "docs"
+	lib: "dist"
 };
 const peerDependencies = {
 	"conventional-changelog": "^6.0.0"
@@ -102,18 +98,17 @@ const peerDependenciesMeta = {
 	}
 };
 const dependencies = {
-	"@commander-js/extra-typings": "^12.1.0",
+	"@commander-js/extra-typings": "^13.0.0",
 	"adm-zip": "^0.5.16",
-	bumpp: "^9.9.1",
+	bumpp: "^9.9.2",
 	c12: "^2.0.1",
-	chalk: "^5.3.0",
-	chokidar: "^4.0.1",
-	commander: "^12.1.0",
-	"es-toolkit": "^1.29.0",
-	esbuild: "^0.24.0",
+	chalk: "^5.4.1",
+	chokidar: "^4.0.3",
+	commander: "^13.0.0",
+	"es-toolkit": "^1.31.0",
+	esbuild: "^0.24.2",
 	"fs-extra": "^11.2.0",
 	hookable: "^5.5.3",
-	mime: "^4.0.4",
 	octokit: "^4.0.2",
 	"std-env": "^3.8.0",
 	"tiny-update-notifier": "^2.0.0",
@@ -121,15 +116,8 @@ const dependencies = {
 	"xvfb-ts": "^1.1.0"
 };
 const devDependencies = {
-	"@antfu/eslint-config": "^3.11.2",
 	"@types/adm-zip": "^0.5.7",
-	"@types/fs-extra": "^11.0.4",
-	"@types/node": "^22.10.2",
-	eslint: "^9.16.0",
-	"eslint-plugin-format": "^0.1.3",
-	typescript: "^5.7.2",
-	unbuild: "^2.0.0",
-	vitepress: "^1.5.0"
+	"@types/fs-extra": "^11.0.4"
 };
 const pkg = {
 	name: name,
@@ -187,10 +175,9 @@ function updateNotifier(name, version) {
 }
 
 async function main() {
-  var _a;
   const { name, version } = pkg;
   updateNotifier(name, version);
-  (_a = process.env).NODE_ENV ?? (_a.NODE_ENV = "development");
+  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) => {
@@ -235,13 +222,15 @@ async function main() {
   });
   cli.parse();
 }
-main().then(() => {
-  checkGitIgnore();
-}).catch(onError);
-process.on("uncaughtException", onError);
+async function run() {
+  main().then(() => {
+    checkGitIgnore();
+  }).catch(onError);
+  process.on("uncaughtException", onError);
+}
 function onError(err) {
   logger.error(err);
   process.exit(1);
 }
 
-export { main as default };
+export { run as default };

package/dist/index.d.mts

@@ -301,6 +301,40 @@ interface BuildConfig {
          */
         prefixFluentMessages: boolean;
     };
+    prefs: {
+        /**
+         * Prefixes the keys of preferences in `prefs.js` and
+         * the value of the `preference` attribute in XHTML files.
+         *
+         * 为 `prefs.js` 中的首选项键和 XHTML 文件中的 `preference` 属性的值
+         * 添加前缀。
+         *
+         * @default true
+         */
+        prefixPrefKeys: boolean;
+        /**
+         * Prefixes for Preference Keys, no dot at the end.
+         *
+         * 首选项键的前缀，结尾不需要加点号。
+         *
+         * @default 'extensions.${namespace}'
+         */
+        prefix: string;
+        /**
+         * Generate prefs.d.ts form prefs.js.
+         *
+         * - false: disable
+         * - string: path of dts file
+         *
+         * 为首选项生成类型声明文件。
+         *
+         * - false: 禁用
+         * - string：dts 文件路径
+         *
+         * @default 'typings/prefs.d.ts'
+         */
+        dts: false | string;
+    };
     /**
      * Configurations of esbuild.
      *
@@ -426,6 +460,8 @@ interface ServerConfig {
      * @default false
      */
     asProxy: boolean;
+    prebuild: boolean;
+    createProfileIfMissing: boolean;
     /**
      * The lifecycle hook.
      */
@@ -726,6 +762,7 @@ interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks, TestHooks {
 type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends object ? RecursivePartial<T[P]> : T[P];
 };
+
 /**
  * User config
  */
@@ -789,6 +826,7 @@ declare class Build extends Base {
      */
     makeManifest(): Promise<void>;
     prepareLocaleFiles(): Promise<void>;
+    preparePrefs(): Promise<void>;
     esbuild(): Promise<esbuild.BuildResult<esbuild.BuildOptions>[]> | undefined;
     makeUpdateJson(): Promise<void>;
     pack(): Promise<void>;
@@ -816,7 +854,6 @@ declare class Serve extends Base {
     private builder;
     private runner?;
     private _zoteroBinPath?;
-    private _profilePath?;
     constructor(ctx: Context);
     run(): Promise<void>;
     /**
@@ -828,8 +865,8 @@ declare class Serve extends Base {
     exit: () => never;
     private onZoteroExit;
     get zoteroBinPath(): string;
-    get profilePath(): string;
-    get dataDir(): string;
+    get profilePath(): string | undefined;
+    get dataDir(): string | undefined;
 }
 
 declare class Test extends Base {

package/dist/index.d.ts

@@ -301,6 +301,40 @@ interface BuildConfig {
          */
         prefixFluentMessages: boolean;
     };
+    prefs: {
+        /**
+         * Prefixes the keys of preferences in `prefs.js` and
+         * the value of the `preference` attribute in XHTML files.
+         *
+         * 为 `prefs.js` 中的首选项键和 XHTML 文件中的 `preference` 属性的值
+         * 添加前缀。
+         *
+         * @default true
+         */
+        prefixPrefKeys: boolean;
+        /**
+         * Prefixes for Preference Keys, no dot at the end.
+         *
+         * 首选项键的前缀，结尾不需要加点号。
+         *
+         * @default 'extensions.${namespace}'
+         */
+        prefix: string;
+        /**
+         * Generate prefs.d.ts form prefs.js.
+         *
+         * - false: disable
+         * - string: path of dts file
+         *
+         * 为首选项生成类型声明文件。
+         *
+         * - false: 禁用
+         * - string：dts 文件路径
+         *
+         * @default 'typings/prefs.d.ts'
+         */
+        dts: false | string;
+    };
     /**
      * Configurations of esbuild.
      *
@@ -426,6 +460,8 @@ interface ServerConfig {
      * @default false
      */
     asProxy: boolean;
+    prebuild: boolean;
+    createProfileIfMissing: boolean;
     /**
      * The lifecycle hook.
      */
@@ -726,6 +762,7 @@ interface Hooks extends BuildHooks, ServeHooks, ReleaseHooks, TestHooks {
 type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends object ? RecursivePartial<T[P]> : T[P];
 };
+
 /**
  * User config
  */
@@ -789,6 +826,7 @@ declare class Build extends Base {
      */
     makeManifest(): Promise<void>;
     prepareLocaleFiles(): Promise<void>;
+    preparePrefs(): Promise<void>;
     esbuild(): Promise<esbuild.BuildResult<esbuild.BuildOptions>[]> | undefined;
     makeUpdateJson(): Promise<void>;
     pack(): Promise<void>;
@@ -816,7 +854,6 @@ declare class Serve extends Base {
     private builder;
     private runner?;
     private _zoteroBinPath?;
-    private _profilePath?;
     constructor(ctx: Context);
     run(): Promise<void>;
     /**
@@ -828,8 +865,8 @@ declare class Serve extends Base {
     exit: () => never;
     private onZoteroExit;
     get zoteroBinPath(): string;
-    get profilePath(): string;
-    get dataDir(): string;
+    get profilePath(): string | undefined;
+    get dataDir(): string | undefined;
 }
 
 declare class Test extends Base {

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { a as Build, C as Config, R as Release, S as Serve, T as Test, d as defineConfig } from './shared/zotero-plugin-scaffold.af8d03c3.mjs';
+export { a as Build, C as Config, R as Release, S as Serve, T as Test, d as defineConfig } from './shared/zotero-plugin-scaffold.rCsToUj_.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'fs-extra/esm';
@@ -7,14 +7,14 @@ import 'node:process';
 import 'node:readline';
 import 'chalk';
 import 'std-env';
-import './shared/zotero-plugin-scaffold.77c9802c.mjs';
+import './shared/zotero-plugin-scaffold.v8dJZZ-v.mjs';
 import 'node:fs/promises';
 import 'tinyglobby';
+import 'node:fs';
 import 'node:path';
 import 'adm-zip';
 import 'esbuild';
 import 'node:crypto';
-import 'node:fs';
 import 'node:child_process';
 import 'bumpp';
 import 'chokidar';