zotero-plugin-scaffold 0.0.7 → 0.0.9

package/README.md

@@ -8,7 +8,7 @@ This repository serves only as a proof-of-concept for the above.
 
 ## Using in a blank project
 
-> WIP
+> WIP: Not yet implemented
 
 ```bash
 # npm
@@ -40,7 +40,7 @@ cd zotero-plugin-scaffold/
 
 # build
 pnpm install
-pnpm run build
+pnpm build # or pnpm dev
 
 # npm link
 cd your-plugin-work-dir/
@@ -52,10 +52,7 @@ pnpm link ../zotero-plugin-scaffold
 The configuration file needs to be stored in the following location. If the configuration file is not found, an error will be thrown.
 
 ```bash
-zotero-plugin.config.ts
-# also avaliable in *.js  *.mjs  *.cjs  *.ts
-# Or The `zotero-plugin`` property in `package.json`
-# see https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#usage-for-end-users
+zotero-plugin.config.ts  # also avaliable in *.js  *.mjs  *.cjs  *.ts
 ```
 
 You can import `defineConfig` in js module to get type hints. If no value is specified for an optional property, the default value will be used.
@@ -64,18 +61,28 @@ You can import `defineConfig` in js module to get type hints. If no value is spe
 import { defineConfig } from "zotero-plugin-scaffold";
 
 export default defineConfig({
-  define: {
-    addonName: "Test Addon for Zotero",
-    addonID: "",
-    addonRef: "",
-    addonInstance: "",
-    updateJSON: "",
-    releasePage: ""
+  name: pkg.config.addonName,
+  id: pkg.config.addonID,
+  namespace: pkg.config.addonRef,
+  updateURL: `https://raw.githubusercontent.com/{{owner}}/{{repo}}/main/update.json`,
+  xpiDownloadLink:
+    "https://github.com/{{owner}}/{{repo}}/releases/download/v{{version}}/{{xpiName}}.xpi",
+  build: {
+    esbuildOptions: [
+      {
+        entryPoints: ["src/index.ts"],
+        define: {
+          __env__: `"${process.env.NODE_ENV}"`,
+        },
+        bundle: true,
+        target: "firefox115",
+      },
+    ],
   },
 });
 ```
 
-Full config please refrence in [src/types.ts](./src/types.ts).
+Full config please refrence in [src/types](./src/types/index.ts).
 
 ### 03. Create a env file
 
@@ -88,22 +95,15 @@ NOTE: Do not check-in this file to the repository!
 ```
 
 ```ini
-# Please input the path of the Zotero binary file in `zoteroBinPath`.
-# The path delimiter should be escaped as `\\` for win32. The path is `*/Zotero.app/Contents/MacOS/zotero` for MacOS.
-zoteroBinPath = /path/to/zotero.exe
-
-# Please input the path of the profile used for development in `profilePath`.
-# Start the profile manager by `/path/to/zotero.exe -p` to create a profile for development
-# https://www.zotero.org/support/kb/profile_directory
-profilePath = /path/to/profile
-
-# Please input the directory where the database is located in dataDir
-# If this field is kept empty, Zotero will start with the default data.
-# https://www.zotero.org/support/zotero_data
-dataDir =
-
-# Other environment variables (optional)
-# GITHUB_TOKEN =
+# The path of the Zotero binary file.
+# The path delimiter should be escaped as `\\` for win32.
+# 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
@@ -123,9 +123,6 @@ dataDir =
 ```bash
 pnpm run start
 pnpm run build
-
-# Or, run cmd in terminal
-pnpm exec zotero-plugin build
 ```
 
 ## Using in NodeJS code
@@ -149,7 +146,8 @@ cd zotero-plugin-scaffold/
 # Install deps
 pnpm install
 
-# Watch
+# Development Mode
+# This command creates a js runtime using jiti, and the modified code does not need to be built again.
 pnpm run dev
 
 # Build

package/dist/cli.d.mts

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

package/dist/cli.d.ts

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

package/dist/cli.mjs

@@ -0,0 +1,211 @@
+import { Config, Build, Serve, Release } from './index.mjs';
+import { Command } from 'commander';
+import consola from 'consola';
+import updateNotifier from 'update-notifier';
+import 'c12';
+import 'fs-extra';
+import 'hookable';
+import 'path';
+import 'radash';
+import 'crypto';
+import 'chalk';
+import 'std-env';
+import 'esbuild';
+import 'fast-glob';
+import 'replace-in-file';
+import 'web-ext';
+import 'bumpp';
+import 'conventional-changelog';
+import 'mime';
+import 'octokit';
+import 'child_process';
+import 'chokidar';
+import 'process';
+
+const name = "zotero-plugin-scaffold";
+const version = "0.0.9";
+const description = "A scaffold for Zotero plugin development.";
+const scripts = {
+	dev: "unbuild --stub",
+	build: "tsc --noEmit && unbuild",
+	lint: "eslint --max-warnings=0 . && prettier --check .",
+	"lint:fix": "eslint --fix . && prettier --write .",
+	release: "release-it --only-version --preReleaseId=beta",
+	test: "echo \"Error: no test specified\" && exit 1"
+};
+const type = "module";
+const exports = {
+	".": {
+		types: "./dist/index.d.ts",
+		"import": "./dist/index.mjs"
+	}
+};
+const main$1 = "./dist/index.mjs";
+const module = "./dist/index.mjs";
+const types = "./dist/index.d.ts";
+const bin = {
+	"zotero-plugin": "./dist/cli.mjs"
+};
+const files = [
+	"dist"
+];
+const keywords = [
+	"zotero",
+	"plugin",
+	"developer",
+	"scaffold",
+	"web-ext"
+];
+const author = "northword";
+const license = "MIT";
+const repository = {
+	type: "git",
+	url: "https://github.com/northword/zotero-plugin-scaffold.git"
+};
+const bugs = {
+	url: "https://github.com/northword/zotero-plugin-scaffold/issues"
+};
+const homepage = "https://github.com/northword/zotero-plugin-scaffold#readme";
+const publishConfig = {
+	access: "public",
+	registry: "https://registry.npmjs.org"
+};
+const directories = {
+	lib: "dist",
+	doc: "docs"
+};
+const engines = {
+	node: ">=18"
+};
+const packageManager = "pnpm@8.15.5";
+const dependencies = {
+	"@inquirer/prompts": "4.3.1",
+	bumpp: "9.4.0",
+	c12: "1.10.0",
+	chalk: "5.3.0",
+	chokidar: "3.6.0",
+	commander: "12.0.0",
+	consola: "3.2.3",
+	"conventional-changelog": "5.1.0",
+	esbuild: "0.20.2",
+	"fast-glob": "3.3.2",
+	"fs-extra": "11.2.0",
+	hookable: "5.5.3",
+	mime: "4.0.1",
+	octokit: "3.1.2",
+	radash: "12.1.0",
+	"replace-in-file": "7.1.0",
+	"std-env": "3.7.0",
+	"update-notifier": "7.0.0",
+	"web-ext": "7.11.0"
+};
+const devDependencies = {
+	"@trivago/prettier-plugin-sort-imports": "4.3.0",
+	"@types/conventional-changelog": "3.1.5",
+	"@types/fs-extra": "11.0.4",
+	"@types/node": "20.12.2",
+	"@types/update-notifier": "6.0.8",
+	"@typescript-eslint/eslint-plugin": "7.4.0",
+	"@typescript-eslint/parser": "7.4.0",
+	eslint: "8.57.0",
+	"eslint-config-prettier": "9.1.0",
+	prettier: "3.2.5",
+	"release-it": "17.1.1",
+	typescript: "5.4.3",
+	unbuild: "2.0.0"
+};
+const pnpm = {
+	peerDependencyRules: {
+		allowAny: [
+			"node-fetch"
+		]
+	}
+};
+const pkg = {
+	name: name,
+	version: version,
+	description: description,
+	scripts: scripts,
+	type: type,
+	exports: exports,
+	main: main$1,
+	module: module,
+	types: types,
+	bin: bin,
+	files: files,
+	keywords: keywords,
+	author: author,
+	license: license,
+	repository: repository,
+	bugs: bugs,
+	homepage: homepage,
+	publishConfig: publishConfig,
+	directories: directories,
+	engines: engines,
+	packageManager: packageManager,
+	dependencies: dependencies,
+	devDependencies: devDependencies,
+	pnpm: pnpm,
+	"release-it": {
+	git: {
+		commitMessage: "chore(publish): release v${version}",
+		tagName: "v${version}"
+	},
+	npm: {
+		publish: false
+	},
+	github: {
+		release: false
+	}
+}
+};
+
+async function main() {
+  var _a;
+  updateNotifier({ pkg }).notify();
+  (_a = process.env).NODE_ENV ?? (_a.NODE_ENV = "development");
+  const cli = new Command();
+  cli.version(pkg.version).usage("<command> [options]");
+  cli.command("build").description("Build the plugin.").option("--dev", "Builds the plugin in dev mode.").option(
+    "--dist <dir>",
+    "the full path for the new output directory, relative to the current workspace (default: build)"
+  ).action(async (options) => {
+    process.env.NODE_ENV = options.dev ? "development" : "production";
+    const config = await Config.loadConfig({
+      dist: options.dist
+    });
+    new Build(config).run();
+  });
+  cli.command("serve").description("Start development server.").action(async (options) => {
+    const config = await Config.loadConfig({});
+    new Serve(config).run();
+  });
+  cli.command("create").description("Create the plugin template.").action((options) => {
+    consola.error("The create not yet implemented");
+  });
+  cli.command("release").description("Release.").action(async (options) => {
+    consola.error("The release not yet implemented");
+    process.env.NODE_ENV = "production";
+    const config = await Config.loadConfig({});
+    new Release(config).run();
+  });
+  cli.arguments("<command>").action((cmd) => {
+    cli.outputHelp();
+    consola.error(`Unknown command name=${cmd}.`);
+  });
+  cli.parse(process.argv);
+}
+main().catch((err) => {
+  console.log("");
+  consola.error(err);
+  console.log("");
+  process.exit(1);
+});
+process.on("unhandledRejection", (err) => {
+  console.log("");
+  consola.error(err);
+  console.log("");
+  process.exit(1);
+});
+
+export { main as default };