fix: update and clean code comments

Author: northword

src/config.ts

@@ -19,7 +19,7 @@ export 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.
  */
 export async function loadConfig(overrides?: OverrideConfig): Promise<Context> {
@@ -146,5 +146,4 @@ const defaultConfig = {
     },
   },
   logLevel: "info",
-  dotEnvPath: ".env",
 } satisfies Config;

src/lib/build.ts

@@ -76,7 +76,7 @@ export default 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);
@@ -87,6 +87,12 @@ export default class Build extends Base {
     });
   }
 
+  /**
+   * Override user's manifest
+   *
+   * Write `applications.gecko` to `manifest.json`
+   *
+   */
   makeManifest() {
     if (!this.ctx.build.makeManifest.enable) return;
     const userData = fs.readJSONSync(

src/lib/run.ts

@@ -102,6 +102,9 @@ export default class Serve extends Base {
       });
   }
 
+  /**
+   * Starts zotero with plugins pre-installed as proxy file
+   */
   async startZotero() {
     let isZoteroReady = false;
     if (!fs.existsSync(this.zoteroBinPath)) {
@@ -174,7 +177,11 @@ export default class Serve extends Base {
       },
     );
   }
-
+  /**
+   * Preparing the development environment
+   *
+   * When asProxy=true, generate a proxy file to replace prefs.
+   */
   prepareDevEnv() {
     const addonProxyFilePath = path.join(
       this.profilePath,
@@ -320,11 +327,9 @@ export default class Serve extends Base {
   }
 
   private get zoteroBinPath() {
-    // this.logger.debug("zoteroBinPath", process.env.zoteroBinPath);
     return process.env.ZOTERO_PLUGIN_ZOTERO_BIN_PATH ?? "";
   }
   private get profilePath() {
-    // this.logger.debug("profilePath", process.env.profilePath);
     return process.env.ZOTERO_PLUGIN_PROFILE_PATH ?? "";
   }
   private get dataDir() {

src/lib/serve.ts

@@ -26,7 +26,7 @@ export interface Config {
    * 构建目录。
    *
    * 脚手架将在 `${dist}/addon` 存放构建后打包前的代码。
-   * 在 `${dist}/${package_json.name}.xpi` 存放打包结果。
+   * 在 `${dist}/${xpiName}.xpi` 存放打包结果。
    *
    * @default "build"
    */
@@ -50,7 +50,7 @@ export interface Config {
    *
    * 插件命名空间
    *
-   * @default _.kebabCase(name)
+   * @default _.dash(name)
    */
   namespace: string;
 
@@ -67,26 +67,29 @@ export interface Config {
    */
   updateURL: string;
 
+  /**
+   * 构建所需的配置
+   */
   build: BuildConfig;
+
+  /**
+   * serve 所需的配置
+   */
   server: ServerConfig;
 
   /**
    * TODO: 使用 addonLint 检查 XPI
    */
   addonLint: object;
-  /**
-   * .dotenv 文件路径
-   *
-   * @default `.env`
-   * @deprecated
-   */
-  dotEnvPath: string;
+
   /**
    * 发布相关配置
    *
    */
   release: {
-    // releaseIt: Partial<ReleaseItConfig>;
+    /**
+     * bumpp 配置
+     */
     bumpp: VersionBumpOptions;
   };
   /**
@@ -171,18 +174,18 @@ export 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",
      *     };
      *   };
@@ -201,7 +204,6 @@ export interface BuildConfig {
     /**
      * 是否启用
      *
-     *
      * @default true
      */
     enable: boolean | "only-production";
@@ -220,16 +222,7 @@ export interface BuildConfig {
     // tagName: "release" | "updater" | string;
   };
   /**
-   * 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>;
 }
@@ -275,8 +268,7 @@ export interface ServerConfig {
    */
   asProxy: boolean;
   /**
-   * The function called after Zotero started, before build-in watcher ready.
-   *
+   * The lifecycle hook.
    */
   hooks: Partial<ServeHooks>;
 }

src/types/config.ts

@@ -10,7 +10,11 @@ type RequiredRecursively<T> = {
 };
 
 interface OverrideConfig extends RecursivePartial<Config> {}
-
+/**
+ * User config
+ *
+ * 用户输入的配置，总配置全可选基础上添加部分为必填
+ */
 interface UserConfig extends RecursivePartial<Config> {
   name: string;
   id: string;