zotero-plugin-scaffold 0.0.13 → 0.0.15

package/dist/cli.mjs

@@ -23,14 +23,14 @@ import 'chokidar';
 import 'process';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.0.13";
+const version = "0.0.15";
 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",
+	release: "bumpp --commit \"chore(release): publish v%s\"",
 	test: "echo \"Error: no test specified\" && exit 1"
 };
 const type = "module";
@@ -110,7 +110,6 @@ const devDependencies = {
 	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"
 };
@@ -145,19 +144,7 @@ const pkg = {
 	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
-	}
-}
+	pnpm: pnpm
 };
 
 async function main() {

package/dist/index.d.mts

@@ -83,7 +83,7 @@ interface Config$1 {
      * 构建目录。
      *
      * 脚手架将在 `${dist}/addon` 存放构建后打包前的代码。
-     * 在 `${dist}/${package_json.name}.xpi` 存放打包结果。
+     * 在 `${dist}/${xpiName}.xpi` 存放打包结果。
      *
      * @default "build"
      */
@@ -106,7 +106,7 @@ interface Config$1 {
      *
      * 插件命名空间
      *
-     * @default _.kebabCase(name)
+     * @default _.dash(name)
      */
     namespace: string;
     /**
@@ -121,24 +121,26 @@ interface Config$1 {
      * @default `https://github.com/{{owner}}/{{repo}}/release/download/release/update.json`
      */
     updateURL: string;
+    /**
+     * 构建所需的配置
+     */
     build: BuildConfig;
+    /**
+     * serve 所需的配置
+     */
     server: ServerConfig;
     /**
      * TODO: 使用 addonLint 检查 XPI
      */
     addonLint: object;
-    /**
-     * .dotenv 文件路径
-     *
-     * @default `.env`
-     * @deprecated
-     */
-    dotEnvPath: string;
     /**
      * 发布相关配置
      *
      */
     release: {
+        /**
+         * bumpp 配置
+         */
         bumpp: VersionBumpOptions;
     };
     /**
@@ -221,18 +223,18 @@ interface BuildConfig {
          * ```json
          * {
          *   manifest_version: 2,
-         *   name: "__addonName__",
-         *   version: "__buildVersion__",
+         *   name: "${name}",
+         *   version: "${version}",
          *   applications: {
          *     zotero: {
-         *       id: "__addonID__",
-         *       update_url: "__updateURL__",
+         *       id: "${id}",
+         *       update_url: "${updateURL}",
          *       strict_min_version: "6.999",
          *       strict_max_version: "7.0.*",
          *     },
          *     gecko: {
-         *       id: "__addonID__",
-         *       update_url: "__updateURL__",
+         *       id: "${id}",
+         *       update_url: "${updateURL}",
          *       strict_min_version: "102",
          *     };
          *   };
@@ -251,7 +253,6 @@ interface BuildConfig {
         /**
          * 是否启用
          *
-         *
          * @default true
          */
         enable: boolean | "only-production";
@@ -269,16 +270,7 @@ interface BuildConfig {
         hash: boolean;
     };
     /**
-     * The function called when build-in build resolved.
-     *
-     * Usually some extra build process.
-     * All configurations will be parameterized to this function.
-     *
-     * 在默认构建步骤执行结束后执行的函数.
-     *
-     * 通常是一些额外的构建流程.
-     * 所有的配置将作为参数传入此函数.
-     *
+     * The lifecycle hooks.
      */
     hooks: Partial<BuildHooks>;
 }
@@ -321,8 +313,7 @@ interface ServerConfig {
      */
     asProxy: boolean;
     /**
-     * The function called after Zotero started, before build-in watcher ready.
-     *
+     * The lifecycle hook.
      */
     hooks: Partial<ServeHooks>;
 }
@@ -332,6 +323,11 @@ type RecursivePartial<T> = {
 };
 interface OverrideConfig extends RecursivePartial<Config$1> {
 }
+/**
+ * User config
+ *
+ * 用户输入的配置，总配置全可选基础上添加部分为必填
+ */
 interface UserConfig extends RecursivePartial<Config$1> {
     name: string;
     id: string;
@@ -341,6 +337,7 @@ interface UserConfig extends RecursivePartial<Config$1> {
 }
 interface Context extends Config$1 {
     pkgUser: any;
+    xpiName: string;
     version: string;
     hooks: Hookable<Hooks>;
     templateDate: {
@@ -358,7 +355,7 @@ interface Context extends Config$1 {
 declare const defineConfig: (userConfig: UserConfig) => UserConfig;
 /**
  * Loads config
- * @param [file="zotero-plugin.config.{ts,js,mjs,cjs}"] The path of config file.
+ * @param [override={}] Highest Priority Configuration.
  * @returns Config with userDefined and defaultConfig merged.
  */
 declare function loadConfig(overrides?: OverrideConfig): Promise<Context>;
@@ -375,7 +372,7 @@ declare abstract class Base {
     get namespace(): string;
     get updateLink(): string;
     get updateURL(): string;
-    get xpiName(): unknown;
+    get xpiName(): string;
 }
 
 declare class Build extends Base {
@@ -387,9 +384,15 @@ declare class Build extends Base {
      */
     run(): Promise<void>;
     /**
-     * Copys files in `Config.assets` to `Config.dist`
+     * Copys files in `Config.build.assets` to `Config.dist`
      */
     copyAssets(): void;
+    /**
+     * Override user's manifest
+     *
+     * Write `applications.gecko` to `manifest.json`
+     *
+     */
     makeManifest(): void;
     /**
      * Replace all `placeholder.key` to `placeholder.value` for all files in `dist`
@@ -663,11 +666,19 @@ declare class Serve extends Base {
      * watch source dir and build when file changed
      */
     watch(): Promise<void>;
+    /**
+     * Starts zotero with plugins pre-installed as proxy file
+     */
     startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
     /**
      * start zotero with plugin installed and reload when dist changed
      */
     startZoteroWebExt(): Promise<any>;
+    /**
+     * Preparing the development environment
+     *
+     * When asProxy=true, generate a proxy file to replace prefs.
+     */
     prepareDevEnv(): void;
     reload(): void;
     openDevTool(): void;

package/dist/index.d.ts

@@ -83,7 +83,7 @@ interface Config$1 {
      * 构建目录。
      *
      * 脚手架将在 `${dist}/addon` 存放构建后打包前的代码。
-     * 在 `${dist}/${package_json.name}.xpi` 存放打包结果。
+     * 在 `${dist}/${xpiName}.xpi` 存放打包结果。
      *
      * @default "build"
      */
@@ -106,7 +106,7 @@ interface Config$1 {
      *
      * 插件命名空间
      *
-     * @default _.kebabCase(name)
+     * @default _.dash(name)
      */
     namespace: string;
     /**
@@ -121,24 +121,26 @@ interface Config$1 {
      * @default `https://github.com/{{owner}}/{{repo}}/release/download/release/update.json`
      */
     updateURL: string;
+    /**
+     * 构建所需的配置
+     */
     build: BuildConfig;
+    /**
+     * serve 所需的配置
+     */
     server: ServerConfig;
     /**
      * TODO: 使用 addonLint 检查 XPI
      */
     addonLint: object;
-    /**
-     * .dotenv 文件路径
-     *
-     * @default `.env`
-     * @deprecated
-     */
-    dotEnvPath: string;
     /**
      * 发布相关配置
      *
      */
     release: {
+        /**
+         * bumpp 配置
+         */
         bumpp: VersionBumpOptions;
     };
     /**
@@ -221,18 +223,18 @@ interface BuildConfig {
          * ```json
          * {
          *   manifest_version: 2,
-         *   name: "__addonName__",
-         *   version: "__buildVersion__",
+         *   name: "${name}",
+         *   version: "${version}",
          *   applications: {
          *     zotero: {
-         *       id: "__addonID__",
-         *       update_url: "__updateURL__",
+         *       id: "${id}",
+         *       update_url: "${updateURL}",
          *       strict_min_version: "6.999",
          *       strict_max_version: "7.0.*",
          *     },
          *     gecko: {
-         *       id: "__addonID__",
-         *       update_url: "__updateURL__",
+         *       id: "${id}",
+         *       update_url: "${updateURL}",
          *       strict_min_version: "102",
          *     };
          *   };
@@ -251,7 +253,6 @@ interface BuildConfig {
         /**
          * 是否启用
          *
-         *
          * @default true
          */
         enable: boolean | "only-production";
@@ -269,16 +270,7 @@ interface BuildConfig {
         hash: boolean;
     };
     /**
-     * The function called when build-in build resolved.
-     *
-     * Usually some extra build process.
-     * All configurations will be parameterized to this function.
-     *
-     * 在默认构建步骤执行结束后执行的函数.
-     *
-     * 通常是一些额外的构建流程.
-     * 所有的配置将作为参数传入此函数.
-     *
+     * The lifecycle hooks.
      */
     hooks: Partial<BuildHooks>;
 }
@@ -321,8 +313,7 @@ interface ServerConfig {
      */
     asProxy: boolean;
     /**
-     * The function called after Zotero started, before build-in watcher ready.
-     *
+     * The lifecycle hook.
      */
     hooks: Partial<ServeHooks>;
 }
@@ -332,6 +323,11 @@ type RecursivePartial<T> = {
 };
 interface OverrideConfig extends RecursivePartial<Config$1> {
 }
+/**
+ * User config
+ *
+ * 用户输入的配置，总配置全可选基础上添加部分为必填
+ */
 interface UserConfig extends RecursivePartial<Config$1> {
     name: string;
     id: string;
@@ -341,6 +337,7 @@ interface UserConfig extends RecursivePartial<Config$1> {
 }
 interface Context extends Config$1 {
     pkgUser: any;
+    xpiName: string;
     version: string;
     hooks: Hookable<Hooks>;
     templateDate: {
@@ -358,7 +355,7 @@ interface Context extends Config$1 {
 declare const defineConfig: (userConfig: UserConfig) => UserConfig;
 /**
  * Loads config
- * @param [file="zotero-plugin.config.{ts,js,mjs,cjs}"] The path of config file.
+ * @param [override={}] Highest Priority Configuration.
  * @returns Config with userDefined and defaultConfig merged.
  */
 declare function loadConfig(overrides?: OverrideConfig): Promise<Context>;
@@ -375,7 +372,7 @@ declare abstract class Base {
     get namespace(): string;
     get updateLink(): string;
     get updateURL(): string;
-    get xpiName(): unknown;
+    get xpiName(): string;
 }
 
 declare class Build extends Base {
@@ -387,9 +384,15 @@ declare class Build extends Base {
      */
     run(): Promise<void>;
     /**
-     * Copys files in `Config.assets` to `Config.dist`
+     * Copys files in `Config.build.assets` to `Config.dist`
      */
     copyAssets(): void;
+    /**
+     * Override user's manifest
+     *
+     * Write `applications.gecko` to `manifest.json`
+     *
+     */
     makeManifest(): void;
     /**
      * Replace all `placeholder.key` to `placeholder.value` for all files in `dist`
@@ -663,11 +666,19 @@ declare class Serve extends Base {
      * watch source dir and build when file changed
      */
     watch(): Promise<void>;
+    /**
+     * Starts zotero with plugins pre-installed as proxy file
+     */
     startZotero(): Promise<child_process.ChildProcessWithoutNullStreams>;
     /**
      * start zotero with plugin installed and reload when dist changed
      */
     startZoteroWebExt(): Promise<any>;
+    /**
+     * Preparing the development environment
+     *
+     * When asProxy=true, generate a proxy file to replace prefs.
+     */
     prepareDevEnv(): void;
     reload(): void;
     openDevTool(): void;

package/dist/index.mjs

@@ -71,6 +71,7 @@ function resolveConfig(config) {
   const ctx = {
     ...config,
     pkgUser: pkg,
+    xpiName: dash(config.name),
     version: pkg.version,
     hooks: createHooks(),
     templateDate: data
@@ -152,8 +153,7 @@ const defaultConfig = {
       push: true
     }
   },
-  logLevel: "info",
-  dotEnvPath: ".env"
+  logLevel: "info"
 };
 
 function generateHashSync(filePath, algorithm) {
@@ -212,7 +212,7 @@ class Base {
     return this.ctx.updateURL;
   }
   get xpiName() {
-    return this.ctx.build.define.xpiName;
+    return this.ctx.xpiName;
   }
 }
 
@@ -273,7 +273,7 @@ class Build extends Base {
     );
   }
   /**
-   * Copys files in `Config.assets` to `Config.dist`
+   * Copys files in `Config.build.assets` to `Config.dist`
    */
   copyAssets() {
     const files = glob.sync(this.ctx.build.assets);
@@ -283,6 +283,12 @@ class Build extends Base {
       fs.copySync(file, newPath);
     });
   }
+  /**
+   * Override user's manifest
+   *
+   * Write `applications.gecko` to `manifest.json`
+   *
+   */
   makeManifest() {
     if (!this.ctx.build.makeManifest.enable)
       return;
@@ -399,7 +405,7 @@ class Build extends Base {
       `${this.dist}/addon/manifest.json`
     ), min = manifest.applications?.zotero?.strict_min_version, max = manifest.applications?.zotero?.strict_max_version;
     const updateHash = generateHashSync(
-      path.join(this.dist, `${this.ctx.templateDate.xpiName}.xpi`),
+      path.join(this.dist, `${this.xpiName}.xpi`),
       "sha512"
     );
     const data = {
@@ -434,7 +440,7 @@ class Build extends Base {
     await webext.cmd.build({
       sourceDir: `${this.dist}/addon`,
       artifactsDir: this.dist,
-      filename: `${this.ctx.templateDate.xpiName}.xpi`,
+      filename: `${this.xpiName}.xpi`,
       overwriteDest: true
     });
   }
@@ -733,6 +739,9 @@ ${path2} changed`);
       this.logger.error("Server start failed!", err);
     });
   }
+  /**
+   * Starts zotero with plugins pre-installed as proxy file
+   */
   async startZotero() {
     let isZoteroReady = false;
     if (!fs.existsSync(this.zoteroBinPath)) {
@@ -791,6 +800,11 @@ ${path2} changed`);
       }
     );
   }
+  /**
+   * Preparing the development environment
+   *
+   * When asProxy=true, generate a proxy file to replace prefs.
+   */
   prepareDevEnv() {
     const addonProxyFilePath = path.join(
       this.profilePath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin-scaffold",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "A scaffold for Zotero plugin development.",
   "type": "module",
   "exports": {
@@ -79,28 +79,15 @@
     "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"
   },
-  "release-it": {
-    "git": {
-      "commitMessage": "chore(publish): release v${version}",
-      "tagName": "v${version}"
-    },
-    "npm": {
-      "publish": false
-    },
-    "github": {
-      "release": false
-    }
-  },
   "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",
+    "release": "bumpp --commit \"chore(release): publish v%s\"",
     "test": "echo \"Error: no test specified\" && exit 1"
   }
 }