zotero-plugin-scaffold 0.0.28 → 0.0.30

package/dist/cli.mjs

@@ -24,7 +24,7 @@ import 'chokidar';
 import 'process';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.0.28";
+const version = "0.0.30";
 const description = "A scaffold for Zotero plugin development.";
 const scripts = {
 	dev: "unbuild --stub",

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { VersionBumpOptions } from 'bumpp';
+import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
 import { Hookable } from 'hookable';
 import { ConsolaInstance } from 'consola';
@@ -71,9 +72,9 @@ interface Config$1 {
      *
      * 可以是多个目录，将在 `server` 运行时监听这些目录的变更。
      *
-     * @default ["src"]
+     * @default "src"
      */
-    source: string[];
+    source: string | string[];
     /**
      * The build directories.
      *
@@ -162,9 +163,11 @@ interface BuildConfig {
      *
      * @see {@link https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#pattern-syntax | Pattern syntax | 语法说明 }
      *
-     * @default `["src/**\/*.*", "!src/**\/*.ts"]` (no `\`)
+     * @example `["src/**\/*.*", "!src/**\/*.ts"]` (no `\`)
+     *
+     * @default "addon/**\/*.*" (no `\`)
      */
-    assets: string[];
+    assets: string | string[];
     /**
      * placeholders to replace in static assets
      *
@@ -363,7 +366,7 @@ declare abstract class Base {
     logger: ConsolaInstance;
     constructor(ctx: Context);
     get dist(): string;
-    get src(): string[];
+    get src(): string | string[];
     get version(): string;
     get name(): string;
     get id(): string;
@@ -397,7 +400,7 @@ declare class Build extends Base {
      */
     replaceString(): void;
     prepareLocaleFiles(): void;
-    esbuild(): void;
+    esbuild(): Promise<esbuild.BuildResult<esbuild.BuildOptions>[]> | undefined;
     makeUpdateJson(): void;
     pack(): Promise<void>;
 }
@@ -518,7 +521,7 @@ declare class Release extends Base {
             rocket: number;
         } | undefined;
     } | undefined>;
-    creatRelease(options: Parameters<Octokit["rest"]["repos"]["createRelease"]>[0]): Promise<{
+    createRelease(options: Parameters<Octokit["rest"]["repos"]["createRelease"]>[0]): Promise<{
         url: string;
         html_url: string;
         assets_url: string;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { VersionBumpOptions } from 'bumpp';
+import * as esbuild from 'esbuild';
 import { BuildOptions } from 'esbuild';
 import { Hookable } from 'hookable';
 import { ConsolaInstance } from 'consola';
@@ -71,9 +72,9 @@ interface Config$1 {
      *
      * 可以是多个目录，将在 `server` 运行时监听这些目录的变更。
      *
-     * @default ["src"]
+     * @default "src"
      */
-    source: string[];
+    source: string | string[];
     /**
      * The build directories.
      *
@@ -162,9 +163,11 @@ interface BuildConfig {
      *
      * @see {@link https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#pattern-syntax | Pattern syntax | 语法说明 }
      *
-     * @default `["src/**\/*.*", "!src/**\/*.ts"]` (no `\`)
+     * @example `["src/**\/*.*", "!src/**\/*.ts"]` (no `\`)
+     *
+     * @default "addon/**\/*.*" (no `\`)
      */
-    assets: string[];
+    assets: string | string[];
     /**
      * placeholders to replace in static assets
      *
@@ -363,7 +366,7 @@ declare abstract class Base {
     logger: ConsolaInstance;
     constructor(ctx: Context);
     get dist(): string;
-    get src(): string[];
+    get src(): string | string[];
     get version(): string;
     get name(): string;
     get id(): string;
@@ -397,7 +400,7 @@ declare class Build extends Base {
      */
     replaceString(): void;
     prepareLocaleFiles(): void;
-    esbuild(): void;
+    esbuild(): Promise<esbuild.BuildResult<esbuild.BuildOptions>[]> | undefined;
     makeUpdateJson(): void;
     pack(): Promise<void>;
 }
@@ -518,7 +521,7 @@ declare class Release extends Base {
             rocket: number;
         } | undefined;
     } | undefined>;
-    creatRelease(options: Parameters<Octokit["rest"]["repos"]["createRelease"]>[0]): Promise<{
+    createRelease(options: Parameters<Octokit["rest"]["repos"]["createRelease"]>[0]): Promise<{
         url: string;
         html_url: string;
         assets_url: string;

package/dist/index.mjs

@@ -8,7 +8,7 @@ import { createHooks } from 'hookable';
 import path, { join, basename } from 'path';
 import { dash, template, assign, debounce } from 'radash';
 import * as crypto from 'crypto';
-import { buildSync } from 'esbuild';
+import { build } from 'esbuild';
 import glob from 'fast-glob';
 import replaceInFile from 'replace-in-file';
 import webext from 'web-ext';
@@ -76,6 +76,9 @@ function dateFormat(fmt, date) {
   }
   return fmt;
 }
+function toArray(value) {
+  return Array.isArray(value) ? value : [value];
+}
 
 const defineConfig = (userConfig) => {
   return userConfig;
@@ -123,15 +126,15 @@ function resolveConfig(config) {
 }
 const getDefaultConfig = () => defaultConfig;
 const defaultConfig = {
-  source: ["src"],
+  source: "src",
   dist: "build",
   name: "",
   id: "",
   namespace: "",
-  xpiDownloadLink: "https://github.com/{{owner}}/{{repo}}/release/download/v{{version}}/{{xpiName}}.xpi",
-  updateURL: "https://github.com/{{owner}}/{{repo}}/release/download/release/update.json",
+  xpiDownloadLink: "https://github.com/{{owner}}/{{repo}}/releases/download/v{{version}}/{{xpiName}}.xpi",
+  updateURL: "https://github.com/{{owner}}/{{repo}}/releases/download/release/update.json",
   build: {
-    assets: ["src/**/*.*", "!src/**/*.ts"],
+    assets: "addon/**/*.*",
     define: {},
     fluent: {
       prefixFluentMessages: true,
@@ -292,7 +295,7 @@ class Build extends Base {
     this.replaceString();
     await this.ctx.hooks.callHook("build:replace", this.ctx);
     this.logger.info("Running esbuild");
-    this.esbuild();
+    await this.esbuild();
     await this.ctx.hooks.callHook("build:bundle", this.ctx);
     this.logger.info("Addon prepare OK.");
     if (process.env.NODE_ENV === "production") {
@@ -314,7 +317,7 @@ class Build extends Base {
   copyAssets() {
     const files = glob.sync(this.ctx.build.assets);
     files.forEach((file) => {
-      const newPath = `${this.dist}/addon/${file.replace(new RegExp(this.src.join("|")), "")}`;
+      const newPath = `${this.dist}/addon/${file.replace(new RegExp(toArray(this.src).join("|")), "")}`;
       this.logger.debug(`Copy ${file} to ${newPath}`);
       fs.copySync(file, newPath);
     });
@@ -363,7 +366,9 @@ class Build extends Base {
     );
     this.logger.debug("replace map: ", replaceMap);
     const replaceResult = replaceInFile.sync({
-      files: this.ctx.build.assets.map((asset) => `${this.dist}/${asset}`),
+      files: toArray(this.ctx.build.assets).map(
+        (asset) => `${this.dist}/${asset}`
+      ),
       from: Array.from(replaceMap.keys()),
       to: Array.from(replaceMap.values()),
       countMatches: true
@@ -432,9 +437,11 @@ class Build extends Base {
   esbuild() {
     if (this.ctx.build.esbuildOptions.length == 0)
       return;
-    this.ctx.build.esbuildOptions.forEach(async (esbuildOption) => {
-      buildSync(esbuildOption);
-    });
+    return Promise.all(
+      this.ctx.build.esbuildOptions.map(
+        (esbuildOption) => build(esbuildOption)
+      )
+    );
   }
   makeUpdateJson() {
     const manifest = fs.readJSONSync(
@@ -538,7 +545,7 @@ class Release extends Base {
    * Create new release and upload XPI to asset
    */
   async uploadXPI() {
-    const release = await this.creatRelease({
+    const release = await this.createRelease({
       owner: this.owner,
       repo: this.repo,
       tag_name: this.ctx.release.bumpp.tag.toString().replaceAll("%s", this.version),
@@ -566,7 +573,7 @@ class Release extends Base {
       }
     });
   }
-  async creatRelease(options) {
+  async createRelease(options) {
     this.logger.debug("Creating release...", options);
     return await this.client.rest.repos.createRelease(options).catch((e) => {
       this.logger.error(e);
@@ -594,7 +601,7 @@ class Release extends Base {
   }
   async refreshUpdateManifest() {
     const assets = glob.globSync(`${this.dist}/*.json`).map((p) => basename(p));
-    const release = await this.getReleaseByTag("release") ?? await this.creatRelease({
+    const release = await this.getReleaseByTag("release") ?? await this.createRelease({
       owner: this.owner,
       repo: this.repo,
       tag_name: "release",
@@ -758,7 +765,7 @@ class Serve extends Base {
       try {
         await this.ctx.hooks.callHook("serve:onChanged", this.ctx, path2);
         if (path2.endsWith(".ts")) {
-          this.builder.esbuild();
+          await this.builder.esbuild();
         } else {
           await this.builder.run();
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin-scaffold",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "A scaffold for Zotero plugin development.",
   "type": "module",
   "exports": {