zotero-plugin-scaffold 0.0.5 → 0.0.7

package/README.md

@@ -23,8 +23,6 @@ pnpm dlx zotero-plugin create
 
 #### From NPM
 
-> WIP
-
 ```bash
 npm install -D zotero-plugin-scaffold
 
@@ -66,7 +64,7 @@ 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({
-  placeholders: {
+  define: {
     addonName: "Test Addon for Zotero",
     addonID: "",
     addonRef: "",
@@ -137,7 +135,7 @@ import { Build, Config } from "zotero-plugin-scaffold";
 
 const config = await Config.loadConfig();
 
-const Builder = new Build(config, "production");
+const Builder = new Build(config);
 await Builder.run();
 ```
 

package/dist/config.js

@@ -28,8 +28,7 @@ export async function loadConfig(file) {
     const dotenvResult = dotenv.config({
         path: path.resolve(process.cwd(), userConfig.dotEnvPath ?? ".env"),
     }).parsed;
-    if (!dotenvResult)
-        throw new Error(".env file not found");
+    // if (!dotenvResult) throw new Error(".env file not found");
     // Load user's package.json
     const pkg = fs.readJsonSync(path.join("package.json"), {
         encoding: "utf-8",
@@ -56,7 +55,7 @@ export async function loadConfig(file) {
             ghOwner: owner,
             ghRepo: repo,
             addonRef: pkg.config?.addonRef || _.kebabCase(addonName),
-            addonInstance: pkg.config?.addonInstence || _.camelCase(addonName),
+            addonInstance: pkg.config?.addonInstance || _.camelCase(addonName),
             prefsPrefix: `extensions.zotero.${addonRef}`,
             xpiName: xpiName,
             releasePage: releasePage,
@@ -135,19 +134,19 @@ export async function loadConfig(file) {
         extraBuilder: () => { },
         addonLint: {},
         release: {
-            releaseIt: {
-                preReleaseId: "beta",
-                git: {
-                    tagName: "v${version}",
-                    requireCleanWorkingDir: false,
-                },
-                npm: {
-                    publish: false,
-                },
-                github: {
-                    assets: [`${userConfig.dist}/*.xpi`],
-                },
-            },
+            // releaseIt: {
+            //   preReleaseId: "beta",
+            //   git: {
+            //     tagName: "v${version}",
+            //     requireCleanWorkingDir: false,
+            //   },
+            //   npm: {
+            //     publish: false,
+            //   },
+            //   github: {
+            //     assets: [`${userConfig.dist}/*.xpi`],
+            //   },
+            // },
             bumpp: {
                 release: "prompt",
                 preid: "beta",
@@ -160,11 +159,6 @@ export async function loadConfig(file) {
         },
         logLevel: "info",
         dotEnvPath: ".env",
-        cmd: {
-            zoteroBinPath: dotenvResult["zoteroBinPath"],
-            profilePath: dotenvResult["profilePath"],
-            dataDir: dotenvResult["dataDir"],
-        },
         pkgUser: pkg,
         pkgAbsolute: path.join(path.dirname(fileURLToPath(import.meta.url)), "../"),
     };

package/dist/{utils/libBase.d.ts → lib/base.d.ts}

@@ -1,6 +1,6 @@
 import { Config } from "../types.js";
-import Log from "./log.js";
-export declare abstract class LibBase {
+import Log from "../utils/log.js";
+export declare abstract class Base {
     config: Config;
     logger: InstanceType<typeof Log>;
     constructor(config: Config);

package/dist/{utils/libBase.js → lib/base.js}

@@ -1,5 +1,5 @@
-import Log from "./log.js";
-export class LibBase {
+import Log from "../utils/log.js";
+export class Base {
     config;
     logger;
     constructor(config) {

package/dist/lib/build.d.ts

@@ -1,6 +1,6 @@
 import { Config } from "../types.js";
-import { LibBase } from "../utils/libBase.js";
-export default class Build extends LibBase {
+import { Base } from "./base.js";
+export default class Build extends Base {
     private buildTime;
     private isPreRelease;
     constructor(config: Config);

package/dist/lib/build.js

@@ -1,6 +1,6 @@
 import { generateHashSync } from "../utils/crypto.js";
-import { LibBase } from "../utils/libBase.js";
 import { dateFormat } from "../utils/string.js";
+import { Base } from "./base.js";
 import chalk from "chalk";
 import { zip } from "compressing";
 import { buildSync } from "esbuild";
@@ -9,11 +9,12 @@ import fs from "fs-extra";
 import path from "path";
 import replaceInFile from "replace-in-file";
 const { replaceInFileSync } = replaceInFile;
-export default class Build extends LibBase {
+export default class Build extends Base {
     buildTime;
     isPreRelease;
     constructor(config) {
         super(config);
+        process.env.NODE_ENV ??= "production";
         this.buildTime = "";
         this.isPreRelease = this.version.includes("-");
     }

package/dist/lib/release.d.ts

@@ -1,7 +1,7 @@
 import { Config } from "../types.js";
-import { LibBase } from "../utils/libBase.js";
+import { Base } from "./base.js";
 import { Octokit } from "@octokit/rest";
-export default class Release extends LibBase {
+export default class Release extends Base {
     isCI: boolean;
     client: Octokit;
     constructor(config: Config);
@@ -22,7 +22,7 @@ export default class Release extends LibBase {
     /**
      * Create new release and upload XPI to asset
      */
-    uploadXPI(): void;
+    uploadXPI(): Promise<void>;
     getReleaseByTag(tag: string): Promise<{
         url: string;
         html_url: string;
@@ -249,6 +249,7 @@ export default class Release extends LibBase {
         } | null;
     }>;
     uploadUpdateJSON(): Promise<void>;
+    getChangelog(): Promise<unknown>;
     getClient(): Octokit;
     get owner(): string;
     get repo(): string;

package/dist/lib/release.js

@@ -1,13 +1,13 @@
-import { LibBase } from "../utils/libBase.js";
+import { Base } from "./base.js";
 import { Octokit } from "@octokit/rest";
+import versionBump from "bumpp";
 import ci from "ci-info";
+import conventionalChangelog from "conventional-changelog";
 import { default as glob } from "fast-glob";
 import fs from "fs-extra";
-import _ from "lodash";
 import mime from "mime";
 import path from "path";
-import releaseIt from "release-it";
-export default class Release extends LibBase {
+export default class Release extends Base {
     isCI;
     client;
     constructor(config) {
@@ -40,30 +40,38 @@ export default class Release extends LibBase {
      * release: bump version, run build, git add, git commit, git tag, git push
      */
     bump() {
-        // versionBump(this.config.release.bumpp);
-        const releaseItConfig = {
-            "only-version": true,
-        };
-        releaseIt(_.defaultsDeep(releaseItConfig, this.config.release.releaseIt));
+        versionBump(this.config.release.bumpp);
+        // const releaseItConfig: ReleaseItConfig = {
+        //   "only-version": true,
+        // };
+        // releaseIt(_.defaultsDeep(releaseItConfig, this.config.release.releaseIt));
     }
     /**
      * Create new release and upload XPI to asset
      */
-    uploadXPI() {
-        const releaseItConfig = {
-            increment: false,
-            git: {
-                commit: false,
-                tag: false,
-                push: false,
-            },
-            github: {
-                release: true,
-            },
-            verbose: 2,
-            ci: true,
-        };
-        releaseIt(_.defaultsDeep(releaseItConfig, this.config.release.releaseIt));
+    async uploadXPI() {
+        // const releaseItConfig: ReleaseItConfig = {
+        //   increment: false,
+        //   git: { commit: false, tag: false, push: false },
+        //   github: {
+        //     release: true,
+        //   },
+        //   verbose: 2,
+        //   ci: true,
+        // };
+        // releaseIt(_.defaultsDeep(releaseItConfig, this.config.release.releaseIt));
+        const release = await this.creatRelease({
+            owner: this.owner,
+            repo: this.repo,
+            tag_name: `v${this.version}`,
+            name: `Release v${this.version}`,
+            bofy: await this.getChangelog(),
+            prerelease: this.version.includes("-"),
+            make_latest: "true",
+        });
+        if (!release)
+            throw new Error("Creat release failed!");
+        this.uploadAsset(release.id, path.join(this.config.dist, `${this.xpiName}.xpi`));
     }
     async getReleaseByTag(tag) {
         return await this.client.repos
@@ -147,6 +155,21 @@ export default class Release extends LibBase {
             await this.uploadAsset(release.id, path.join(this.config.dist, asset));
         }
     }
+    getChangelog() {
+        return new Promise((resolve, reject) => {
+            let changelog = "";
+            conventionalChangelog({ releaseCount: 2 }, { version: this.version })
+                .on("data", (chunk) => {
+                changelog += chunk.toString();
+            })
+                .on("end", () => {
+                resolve(changelog);
+            })
+                .on("error", (err) => {
+                reject(err);
+            });
+        });
+    }
     getClient() {
         if (!process.env.GITHUB_TOKEN)
             throw new Error("No GITHUB_TOKEN.");

package/dist/lib/serve.d.ts

@@ -1,6 +1,7 @@
+/// <reference types="node" />
 import { Config } from "../types.js";
-import { LibBase } from "../utils/libBase.js";
-export default class Serve extends LibBase {
+import { Base } from "./base.js";
+export default class Serve extends Base {
     private builder;
     constructor(config: Config);
     run(): Promise<void>;
@@ -8,7 +9,7 @@ export default class Serve extends LibBase {
      * watch source dir and build when file changed
      */
     watch(): Promise<void>;
-    startZotero(): void;
+    startZotero(): Promise<import("child_process").ChildProcessWithoutNullStreams>;
     /**
      * start zotero with plugin installed and reload when dist changed
      */

package/dist/lib/serve.js

@@ -1,4 +1,4 @@
-import { LibBase } from "../utils/libBase.js";
+import { Base } from "./base.js";
 import Build from "./build.js";
 import { execSync, spawn } from "child_process";
 import chokidar from "chokidar";
@@ -7,18 +7,19 @@ import _ from "lodash";
 import path from "path";
 import { exit } from "process";
 import webext from "web-ext";
-export default class Serve extends LibBase {
+export default class Serve extends Base {
     builder;
     constructor(config) {
         super(config);
+        process.env.NODE_ENV ??= "development";
         this.builder = new Build(config);
     }
     async run() {
         // build
-        this.builder.run();
+        await this.builder.run();
         // start Zotero
-        // this.startZotero();
-        this.startZoteroWebExt();
+        this.startZotero();
+        // this.startZoteroWebExt();
         // watch
         await this.config.extraServer(this.config);
         await this.watch();
@@ -62,19 +63,33 @@ export default class Serve extends LibBase {
             this.logger.error("Server start failed!", err);
         });
     }
-    startZotero() {
+    async startZotero() {
+        let isZoteroReady = false;
         if (!fs.existsSync(this.zoteroBinPath)) {
             throw new Error("Zotero binary does not exist.");
         }
         if (!fs.existsSync(this.profilePath)) {
             throw new Error("The given Zotero profile does not exist.");
         }
+        this.prepareDevEnv();
         const zoteroProcess = spawn(this.zoteroBinPath, [
             "--debugger",
             "--purgecaches",
             "-profile",
             this.profilePath,
         ]);
+        zoteroProcess.stdout?.on("data", (data) => {
+            if (!isZoteroReady &&
+                data
+                    .toString()
+                    .includes(`Calling bootstrap method 'startup' for plugin ${this.addonID}`)) {
+                console.log(data.toString());
+                isZoteroReady = true;
+                setTimeout(() => {
+                    this.openDevTool();
+                }, 1000);
+            }
+        });
         zoteroProcess.on("close", (code) => {
             this.logger.info(`Zotero terminated with code ${code}.`);
             exit(0);
@@ -84,14 +99,15 @@ export default class Serve extends LibBase {
             zoteroProcess.kill();
             exit();
         });
+        return zoteroProcess;
     }
     /**
      * start zotero with plugin installed and reload when dist changed
      */
     async startZoteroWebExt() {
         await webext.cmd.run({
-            firefox: this.config.cmd.zoteroBinPath,
-            firefoxProfile: this.config.cmd.profilePath,
+            firefox: this.zoteroBinPath,
+            firefoxProfile: this.profilePath,
             sourceDir: path.resolve(`${this.config.dist}/addon`),
             keepProfileChanges: true,
             args: ["--debugger", "--purgecaches"],
@@ -220,11 +236,11 @@ export default class Serve extends LibBase {
         execSync(command);
     }
     get zoteroBinPath() {
-        this.logger.debug("zoteroBinPath", process.env.zoteroBinPath);
+        // this.logger.debug("zoteroBinPath", process.env.zoteroBinPath);
         return process.env.zoteroBinPath ?? "";
     }
     get profilePath() {
-        this.logger.debug("profilePath", process.env.profilePath);
+        // this.logger.debug("profilePath", process.env.profilePath);
         return process.env.profilePath ?? "";
     }
     get dataDir() {

package/dist/types.d.ts

@@ -271,7 +271,6 @@ export interface ConfigBase {
      * 发布相关配置
      */
     release: {
-        releaseIt: Partial<ReleaseItConfig>;
         bumpp: VersionBumpOptions;
     };
     /**
@@ -282,11 +281,6 @@ export interface ConfigBase {
     logLevel: "trace" | "debug" | "info" | "warn" | "error";
 }
 export interface Config extends ConfigBase {
-    cmd: {
-        zoteroBinPath: string;
-        profilePath: string;
-        dataDir: string;
-    };
     pkgUser: any;
     pkgAbsolute: string;
 }

package/dist/utils/log.js

@@ -42,8 +42,9 @@ export default class Log {
             this.log(chalk.green("INFO"), ...args);
     }
     debug(...args) {
+        // if (this.logLevel <= 1) this.log(chalk.grey("DEBUG"), ...args);
         if (this.logLevel <= 1)
-            this.log(chalk.grey("DEBUG"), ...args);
+            this.log(...args);
     }
     trace(...args) {
         if (this.logLevel <= 0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin-scaffold",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "A scaffold for Zotero plugin development.",
   "main": "dist/index.js",
   "bin": {
@@ -52,9 +52,12 @@
     "ci-info": "^4.0.0",
     "commander": "^11.1.0",
     "compressing": "^1.10.0",
+    "conventional-changelog": "^5.1.0",
+    "conventional-commits-detector": "^1.0.3",
     "cosmiconfig": "^9.0.0",
     "dotenv": "^16.4.1",
     "esbuild": "^0.19.12",
+    "execa": "^8.0.1",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
     "lodash": "^4.17.21",
@@ -67,12 +70,13 @@
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/conventional-changelog": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
     "@types/lodash": "^4.14.202",
-    "@types/node": "^20.11.9",
+    "@types/node": "^20.11.16",
     "@types/update-notifier": "^6.0.8",
-    "@typescript-eslint/eslint-plugin": "^6.19.1",
-    "@typescript-eslint/parser": "^6.19.1",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "prettier": "^3.2.4",