zotero-plugin-scaffold 0.0.14 → 0.0.16

package/dist/cli.mjs

@@ -2,6 +2,7 @@ import { Config, Build, Serve, Release } from './index.mjs';
 import { Command } from 'commander';
 import consola from 'consola';
 import updateNotifier from 'update-notifier';
+import 'bumpp';
 import 'c12';
 import 'fs-extra';
 import 'hookable';
@@ -14,7 +15,6 @@ import 'esbuild';
 import 'fast-glob';
 import 'replace-in-file';
 import 'web-ext';
-import 'bumpp';
 import 'conventional-changelog';
 import 'mime';
 import 'octokit';
@@ -23,7 +23,7 @@ import 'chokidar';
 import 'process';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.0.14";
+const version = "0.0.16";
 const description = "A scaffold for Zotero plugin development.";
 const scripts = {
 	dev: "unbuild --stub",

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;
@@ -359,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>;
@@ -388,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`
@@ -664,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;
@@ -359,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>;
@@ -388,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`
@@ -664,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

@@ -1,3 +1,5 @@
+import versionBump, { ProgressEvent } from 'bumpp';
+import consola, { createConsola } from 'consola';
 import { loadConfig as loadConfig$1 } from 'c12';
 import fs from 'fs-extra';
 import { createHooks } from 'hookable';
@@ -6,12 +8,10 @@ import { dash, template, assign, debounce } from 'radash';
 import * as crypto from 'crypto';
 import chalk from 'chalk';
 import { isCI, isWindows, isMacOS, isLinux } from 'std-env';
-import consola, { createConsola } from 'consola';
 import { buildSync } from 'esbuild';
 import glob from 'fast-glob';
 import replaceInFile from 'replace-in-file';
 import webext from 'web-ext';
-import versionBump from 'bumpp';
 import conventionalChangelog from 'conventional-changelog';
 import mime from 'mime';
 import { Octokit } from 'octokit';
@@ -19,6 +19,35 @@ import { execSync, spawn } from 'child_process';
 import chokidar from 'chokidar';
 import { exit } from 'process';
 
+function progress({
+  event,
+  script,
+  updatedFiles,
+  skippedFiles,
+  newVersion
+}) {
+  switch (event) {
+    case ProgressEvent.FileUpdated:
+      consola.success(`Updated ${updatedFiles.pop()} to ${newVersion}`);
+      break;
+    case ProgressEvent.FileSkipped:
+      consola.info(`${skippedFiles.pop()} did not need to be updated`);
+      break;
+    case ProgressEvent.GitCommit:
+      consola.success("Git commit");
+      break;
+    case ProgressEvent.GitTag:
+      consola.success("Git tag");
+      break;
+    case ProgressEvent.GitPush:
+      consola.success("Git push");
+      break;
+    case ProgressEvent.NpmScript:
+      consola.success(`Npm run ${script}`);
+      break;
+  }
+}
+
 function dateFormat(fmt, date) {
   let ret;
   const opt = {
@@ -145,16 +174,17 @@ const defaultConfig = {
   release: {
     bumpp: {
       release: "prompt",
+      confirm: true,
       preid: "beta",
       // execute: "npm run build",
       all: false,
-      commit: "Release v%s",
+      commit: "chore(publish): release v%s",
       tag: "v%s",
-      push: true
+      push: true,
+      progress
     }
   },
-  logLevel: "info",
-  dotEnvPath: ".env"
+  logLevel: "info"
 };
 
 function generateHashSync(filePath, algorithm) {
@@ -274,7 +304,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);
@@ -284,6 +314,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;
@@ -734,6 +770,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)) {
@@ -792,6 +831,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.14",
+  "version": "0.0.16",
   "description": "A scaffold for Zotero plugin development.",
   "type": "module",
   "exports": {