zotero-plugin-scaffold 0.2.0-beta.8 → 0.2.0

package/README.md

@@ -1,167 +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)
+Delivering a modern and elegant development experience for Zotero plugins.
 
-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.
+## Documentation
 
-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).
-
-## Using in a blank project
-
-<details>
-
-<summary>WIP: Not yet implemented</summary>
-
-```bash
-# npm
-npx zotero-plugin create
-# pnpm
-pnpm dlx zotero-plugin create
-```
-
-</details>
-
-## Using in an existing project
-
-### 01. Install
-
-#### From NPM
-
-```bash
-npm install -D zotero-plugin-scaffold
-
-yarn add -D zotero-plugin-scaffold
-
-pnpm add -D zotero-plugin-scaffold
-```
-
-#### From source code
-
-```bash
-# clone this repo
-git clone https://github.com/northword/zotero-plugin-scaffold.git zotero-plugin-scaffold/
-cd zotero-plugin-scaffold/
-
-# build
-pnpm install
-pnpm build # or pnpm dev
-
-# npm link
-cd your-plugin-work-dir/
-pnpm link ../zotero-plugin-scaffold
-```
-
-### 02. Create a config file
-
-The configuration file needs to be stored in the following location.
-
-```bash
-zotero-plugin.config.ts  # also avaliable in *.js  *.mjs  *.cjs  *.ts
-```
-
-You can import helper `defineConfig` to get type hints. If no value is specified for an optional property, the default value will be used.
-
-```ts
-import { defineConfig } from "zotero-plugin-scaffold";
-
-export default defineConfig({
-  name: "the plugin name",
-  id: "the plugin id",
-  namespace: "the plugin namespace",
-  build: {
-    esbuildOptions: [
-      {
-        entryPoints: ["src/index.ts"],
-        bundle: true,
-        target: "firefox115",
-      },
-    ],
-  },
-});
-```
-
-Full config please refrence in [src/types](./src/types/index.ts).
-
-### 03. Create a env file
-
-This file defines Zotero's runtime configuration such as binary paths, profile paths, and environment variables required for Node scripts to run.
-
-NOTE: Do not check-in this file to the repository!
-
-```bash
-.env
-```
-
-```ini
-# The path of the Zotero binary file.
-# The path is `*/Zotero.app/Contents/MacOS/zotero` for macOS.
-ZOTERO_PLUGIN_ZOTERO_BIN_PATH = /path/to/zotero.exe
-
-# The path of the profile used for development.
-# Start the profile manager by `/path/to/zotero.exe -p` to create a profile for development.
-# @see https://www.zotero.org/support/kb/profile_directory
-ZOTERO_PLUGIN_PROFILE_PATH = /path/to/profile
-```
-
-### 04. Add scripts to package.json
-
-```json
-{
-  "scripts": {
-    "start": "zotero-plugin serve",
-    "build": "zotero-plugin build",
-    "release": "zotero-plugin release"
-  }
-}
-```
-
-### 05. Run
-
-```bash
-pnpm run start
-pnpm run build
-```
-
-## Using in NodeJS code
-
-```ts
-import { Build, Config } from "zotero-plugin-scaffold";
-
-const config = await Config.loadConfig();
-
-const Builder = new Build(config);
-await Builder.run();
-```
-
-## 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
-
-# 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 { env } from 'node:process';
-import mime from 'mime';
+import { extname, join, basename } from 'node:path';
+import process from 'node:process';
 import { Octokit } from 'octokit';
 import { globSync, glob } from 'tinyglobby';
 import { isCI } from 'std-env';
-import { a as Base } from '../shared/zotero-plugin-scaffold.dc0b582a.mjs';
+import { B as Base } from '../shared/zotero-plugin-scaffold.DoUCzsKc.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 undefined;
+}
+
 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() {
@@ -91,7 +91,7 @@ class GitHub extends ReleaseBase {
       tag
     }).catch((e) => {
       this.logger.debug(`Release with tag ${tag} not found. ${e}`);
-      return void 0;
+      return undefined;
     }).then((res) => {
       if (res && res.status === 200) {
         this.logger.debug(`Found release with tag "${tag}", id=${res.data.id}.`);
@@ -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"
     });
@@ -180,10 +180,10 @@ class GitHub extends ReleaseBase {
     return releaseNote(this.ctx);
   }
   getClient() {
-    if (!env.GITHUB_TOKEN)
+    if (!process.env.GITHUB_TOKEN)
       throw new Error("No GITHUB_TOKEN.");
     const client = new Octokit({
-      auth: env.GITHUB_TOKEN,
+      auth: process.env.GITHUB_TOKEN,
       userAgent: "zotero-plugin-scaffold"
     });
     return client;

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,8 +1,9 @@
-#!/usr/bin/env node
-import process, { exit, env } from 'node:process';
+import process from 'node:process';
 import { Command } from '@commander-js/extra-typings';
-import updateNotifier from 'update-notifier';
-import { L as Log, C as Config, B as Build, S as Serve, T as Test, R as Release } from './shared/zotero-plugin-scaffold.dc0b582a.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.DoUCzsKc.mjs';
+import { readFile, writeFile } from 'node:fs/promises';
+import { pathExists, ensureFile } from 'fs-extra';
+import tinyUpdateNotifier from 'tiny-update-notifier';
 import 'c12';
 import 'es-toolkit';
 import 'fs-extra/esm';
@@ -10,14 +11,13 @@ import 'hookable';
 import 'node:readline';
 import 'chalk';
 import 'std-env';
-import './shared/zotero-plugin-scaffold.77c9802c.mjs';
-import 'node:fs/promises';
+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';
@@ -30,15 +30,16 @@ import 'xvfb-ts';
 
 const name = "zotero-plugin-scaffold";
 const type = "module";
-const version = "0.2.0-beta.8";
-const packageManager = "pnpm@9.15.0";
+const version = "0.2.0";
+const packageManager = "pnpm@9.15.4";
 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"
@@ -55,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"
@@ -64,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 = {
@@ -75,10 +80,6 @@ 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"
 };
 const publishConfig = {
@@ -86,8 +87,7 @@ const publishConfig = {
 	registry: "https://registry.npmjs.org"
 };
 const directories = {
-	lib: "dist",
-	doc: "docs"
+	lib: "dist"
 };
 const peerDependencies = {
 	"conventional-changelog": "^6.0.0"
@@ -98,41 +98,26 @@ 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.10.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",
-	"fs-extra": "^11.2.0",
+	chalk: "^5.4.1",
+	chokidar: "^4.0.3",
+	commander: "^13.1.0",
+	"es-toolkit": "^1.31.0",
+	esbuild: "^0.24.2",
+	"fs-extra": "^11.3.0",
 	hookable: "^5.5.3",
-	mime: "^4.0.4",
-	octokit: "^4.0.2",
+	octokit: "^4.1.0",
 	"std-env": "^3.8.0",
+	"tiny-update-notifier": "^2.0.0",
 	tinyglobby: "^0.2.10",
-	"update-notifier": "^7.3.1",
 	"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",
-	"@types/update-notifier": "^6.0.8",
-	eslint: "^9.16.0",
-	"eslint-plugin-format": "^0.1.3",
-	typescript: "^5.7.2",
-	unbuild: "^2.0.0"
-};
-const pnpm = {
-	peerDependencyRules: {
-		allowAny: [
-			"node-fetch"
-		]
-	}
+	"@types/fs-extra": "^11.0.4"
 };
 const pkg = {
 	name: name,
@@ -159,21 +144,44 @@ const pkg = {
 	peerDependencies: peerDependencies,
 	peerDependenciesMeta: peerDependenciesMeta,
 	dependencies: dependencies,
-	devDependencies: devDependencies,
-	pnpm: pnpm
+	devDependencies: devDependencies
 };
 
-const logger = new Log();
+async function checkGitIgnore() {
+  if (!pathExists(".git"))
+    return;
+  await ensureFile(".gitignore");
+  const contents = (await readFile(".gitignore", "utf-8")).split("\n");
+  const ignores = ["node_modules", ".env", ".scaffold"];
+  ignores.forEach((ignore) => {
+    if (!contents.includes(ignore))
+      contents.push(ignore);
+  });
+  await writeFile(".gitignore", contents.join("\n"));
+}
+
+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} \u2192 ${update.latest} (${update.type})`);
+        logger.newLine();
+      };
+      ExitSignals.forEach((sig) => process.once(sig, notify));
+    }
+  }).catch();
+}
+
 async function main() {
-  var _a;
   const { name, version } = pkg;
-  updateNotifier({ pkg: { name, version } }).notify();
-  process.removeAllListeners("SIGINT");
-  (_a = env).NODE_ENV ?? (_a.NODE_ENV = "development");
+  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((options) => {
-    env.NODE_ENV = options.dev ? "development" : "production";
+    process.env.NODE_ENV = options.dev ? "development" : "production";
     Config.loadConfig({
       dist: options.dist
     }).then((ctx) => new Build(ctx).run());
@@ -182,7 +190,7 @@ async function main() {
     Config.loadConfig({}).then((ctx) => new Serve(ctx).run());
   });
   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").action((options) => {
-    env.NODE_ENV = "test";
+    process.env.NODE_ENV = "test";
     Config.loadConfig({}).then((ctx) => {
       if (options.abortOnFail) {
         ctx.test.abortOnFail = true;
@@ -197,7 +205,7 @@ async function main() {
     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) => {
-    env.NODE_ENV = "production";
+    process.env.NODE_ENV = "production";
     Config.loadConfig({
       release: {
         bumpp: {
@@ -214,11 +222,15 @@ async function main() {
   });
   cli.parse();
 }
-main().catch(onError);
-process.on("uncaughtException", onError);
+async function run() {
+  main().then(() => {
+    checkGitIgnore();
+  }).catch(onError);
+  process.on("uncaughtException", onError);
+}
 function onError(err) {
   logger.error(err);
-  exit(1);
+  process.exit(1);
 }
 
-export { main as default };
+export { run as default };