zotero-plugin-scaffold 0.1.6 → 0.1.7

package/dist/chunks/github.mjs

@@ -4,9 +4,8 @@ import fs from 'fs-extra';
 import { globbySync } from 'globby';
 import mime from 'mime';
 import { Octokit } from 'octokit';
-import { R as ReleaseBase } from '../shared/zotero-plugin-scaffold.3e58ced7.mjs';
-import 'std-env';
-import '../shared/zotero-plugin-scaffold.c7c8af0c.mjs';
+import { isCI } from 'std-env';
+import { a as Base } from '../shared/zotero-plugin-scaffold.b59b2bc7.mjs';
 import 'c12';
 import 'es-toolkit';
 import 'hookable';
@@ -17,11 +16,30 @@ import 'replace-in-file';
 import 'web-ext';
 import 'node:crypto';
 import 'node:child_process';
-import 'conventional-changelog';
 import 'bumpp';
 import 'chokidar';
 import 'node:fs';
 
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class ReleaseBase extends Base {
+  constructor(ctx) {
+    super(ctx);
+    __publicField$1(this, "isCI");
+    this.isCI = isCI;
+  }
+  checkFiles() {
+    const { dist } = this.ctx;
+    if (globbySync(`${dist}/*.xpi`).length === 0) {
+      throw new Error("No xpi file found, are you sure you have run build?");
+    }
+  }
+}
+
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => {

package/dist/cli.mjs

@@ -2,7 +2,7 @@
 import process, { exit, env } from 'node:process';
 import { Command } from '@commander-js/extra-typings';
 import updateNotifier from 'update-notifier';
-import { L as Log, C as Config, a as Build, S as Serve, R as Release } from './shared/zotero-plugin-scaffold.c7c8af0c.mjs';
+import { L as Log, C as Config, B as Build, S as Serve, R as Release } from './shared/zotero-plugin-scaffold.b59b2bc7.mjs';
 import 'node:path';
 import 'c12';
 import 'es-toolkit';
@@ -17,13 +17,12 @@ import 'replace-in-file';
 import 'web-ext';
 import 'node:crypto';
 import 'node:child_process';
-import 'conventional-changelog';
 import 'bumpp';
 import 'chokidar';
 import 'node:fs';
 
 const name = "zotero-plugin-scaffold";
-const version = "0.1.6";
+const version = "0.1.7";
 
 const logger = new Log();
 async function main() {

package/dist/index.d.mts

@@ -522,14 +522,19 @@ interface ReleaseConfig {
     /**
      * Changelog.
      *
-     * If a string is provided, it must be command line
-     * and with changelog output to stdout.
+     * - "conventional-changelog": use conventional-changelog with angular preset,
+     *    you must install "conventional-changelog" as an peer dependency.
+     * - string: a command line with changelog output to stdout.
      *
-     * 如果提供了字符串，则必须为命令行，且变更日志输出到stdout
+     * 变更日志。
+     *
+     * - "conventional-changelog": 使用约定式变更日志，使用 angular 预设，
+     *   你需要手动安装 conventional-changelog 作为依赖项。
+     * - string: 命令行，变更日志输出到 stdout
      *
      * @default "git log {{previousTag}}..{{currentTag}}"
      */
-    changelog: string | ((ctx: Context) => string);
+    changelog: "conventional-changelog" | string | ((ctx: Context) => string);
     /**
      * Release to GitHub.
      */
@@ -580,6 +585,8 @@ interface ReleaseConfig {
     };
     /**
      * Release to Gitee
+     *
+     * @todo Not implemented yet
      */
     gitee: ReleaseConfig["github"];
     hooks: Partial<ReleaseHooks>;
@@ -680,9 +687,9 @@ declare class Release extends Base {
      */
     run(): Promise<void>;
     getConventionalChangelog(): Promise<string>;
-    getGitLog(currentTag: string): string;
-    getFilteredChangelog(rawLog: string, commitMessage: string): string;
-    getChangelog(): string;
+    getGitLog(): string;
+    getFilteredChangelog(rawLog: string): string;
+    getChangelog(): Promise<string>;
     private isEnabled;
     get resolvedCommitMessage(): string;
 }

package/dist/index.d.ts

@@ -522,14 +522,19 @@ interface ReleaseConfig {
     /**
      * Changelog.
      *
-     * If a string is provided, it must be command line
-     * and with changelog output to stdout.
+     * - "conventional-changelog": use conventional-changelog with angular preset,
+     *    you must install "conventional-changelog" as an peer dependency.
+     * - string: a command line with changelog output to stdout.
      *
-     * 如果提供了字符串，则必须为命令行，且变更日志输出到stdout
+     * 变更日志。
+     *
+     * - "conventional-changelog": 使用约定式变更日志，使用 angular 预设，
+     *   你需要手动安装 conventional-changelog 作为依赖项。
+     * - string: 命令行，变更日志输出到 stdout
      *
      * @default "git log {{previousTag}}..{{currentTag}}"
      */
-    changelog: string | ((ctx: Context) => string);
+    changelog: "conventional-changelog" | string | ((ctx: Context) => string);
     /**
      * Release to GitHub.
      */
@@ -580,6 +585,8 @@ interface ReleaseConfig {
     };
     /**
      * Release to Gitee
+     *
+     * @todo Not implemented yet
      */
     gitee: ReleaseConfig["github"];
     hooks: Partial<ReleaseHooks>;
@@ -680,9 +687,9 @@ declare class Release extends Base {
      */
     run(): Promise<void>;
     getConventionalChangelog(): Promise<string>;
-    getGitLog(currentTag: string): string;
-    getFilteredChangelog(rawLog: string, commitMessage: string): string;
-    getChangelog(): string;
+    getGitLog(): string;
+    getFilteredChangelog(rawLog: string): string;
+    getChangelog(): Promise<string>;
     private isEnabled;
     get resolvedCommitMessage(): string;
 }

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { a as Build, C as Config, R as Release, S as Serve, d as defineConfig } from './shared/zotero-plugin-scaffold.c7c8af0c.mjs';
+export { B as Build, C as Config, R as Release, S as Serve, d as defineConfig } from './shared/zotero-plugin-scaffold.b59b2bc7.mjs';
 import 'node:path';
 import 'c12';
 import 'es-toolkit';
@@ -14,7 +14,6 @@ import 'replace-in-file';
 import 'web-ext';
 import 'node:crypto';
 import 'node:child_process';
-import 'conventional-changelog';
 import 'bumpp';
 import 'chokidar';
 import 'node:fs';

package/dist/shared/{zotero-plugin-scaffold.c7c8af0c.mjs → zotero-plugin-scaffold.b59b2bc7.mjs}

@@ -13,7 +13,6 @@ import { replaceInFileSync } from 'replace-in-file';
 import webext from 'web-ext';
 import * as crypto from 'node:crypto';
 import { execSync, spawn } from 'node:child_process';
-import conventionalChangelog from 'conventional-changelog';
 import { versionBump, ProgressEvent } from 'bumpp';
 import chokidar from 'chokidar';
 import { existsSync } from 'node:fs';
@@ -311,6 +310,14 @@ function generateHashSync(filePath, algorithm) {
   return `${algorithm}:${hash}`;
 }
 
+function getValidatedManifest(_sourceDir) {
+  return {
+    manifest_version: 2,
+    name: "zoterp-plugin-scaffold-fake-name",
+    version: "0.0.0.0"
+  };
+}
+
 var __defProp$5 = Object.defineProperty;
 var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$5 = (obj, key, value) => {
@@ -419,11 +426,6 @@ class Build extends Base {
         zotero: {
           id,
           update_url: updateURL
-        },
-        gecko: {
-          id,
-          update_url: updateURL,
-          strict_min_version: "102"
         }
       }
     };
@@ -581,6 +583,8 @@ class Build extends Base {
       artifactsDir: dist,
       filename: `${xpiName}.xpi`,
       overwriteDest: true
+    }, {
+      manifestData: getValidatedManifest()
     });
   }
 }
@@ -680,35 +684,33 @@ class Release extends Base {
     await this.ctx.hooks.callHook("release:init", this.ctx);
     await new Bump(this.ctx).run();
     await this.ctx.hooks.callHook("release:push", this.ctx);
-    this.ctx.release.changelog = this.getChangelog();
+    this.ctx.release.changelog = await this.getChangelog();
     if (isGitHubEnabled) {
       const { default: GitHub } = await import('../chunks/github.mjs');
       await new GitHub(this.ctx).run();
     }
-    if (isGiteeEnabled) {
-      const { default: Gitee } = await import('../chunks/gitee.mjs');
-      await new Gitee(this.ctx).run();
-    }
     await this.ctx.hooks.callHook("release:done", this.ctx);
     this.logger.success(
       `Done in ${(( new Date()).getTime() - t.getTime()) / 1e3} s.`
     );
   }
-  getConventionalChangelog() {
+  async getConventionalChangelog() {
     const { version } = this.ctx;
+    const { default: conventionalChangelog } = await import('conventional-changelog');
     return new Promise((resolve, reject) => {
       let changelog = "";
-      conventionalChangelog({ releaseCount: 2 }, { version }).on("data", (chunk) => {
+      conventionalChangelog({ releaseCount: 2, preset: "angular" }, { version }).on("data", (chunk) => {
         changelog += chunk.toString();
       }).on("end", () => {
-        this.logger.debug("changelog:", changelog.trim());
-        resolve(changelog.trim());
+        changelog = changelog.split("\n").filter((line) => !line.match(/^## .*/)).join("\n").trim();
+        resolve(changelog);
       }).on("error", (err) => {
         reject(err);
       });
     });
   }
-  getGitLog(currentTag) {
+  getGitLog() {
+    const currentTag = this.ctx.release.bumpp.tag;
     const tags = execSync("git tag -l --sort=v:refname").toString().trim().split("\n");
     const currentTagIndex = tags.indexOf(currentTag);
     if (currentTagIndex === -1)
@@ -733,25 +735,27 @@ class Release extends Base {
     else
       return execSync(`git log --pretty=format:"* %s (%h)" ${currentTag}`).toString().trim();
   }
-  getFilteredChangelog(rawLog, commitMessage) {
+  getFilteredChangelog(rawLog) {
+    const commitMessage = this.ctx.release.bumpp.commit;
     const filterRegex = new RegExp(escapeRegExp(commitMessage));
     const filteredLog = rawLog.split("\n").filter((line) => !filterRegex.test(line)).join("\n");
     if (filteredLog.replaceAll(" ", "") === "")
       return "_No significant changes._";
     return filteredLog;
   }
-  getChangelog() {
+  async getChangelog() {
     let changelog;
     const changelogConfig = this.ctx.release.changelog;
     if (typeof changelogConfig == "function") {
       changelog = changelogConfig(this.ctx);
+    } else if (!!changelogConfig && changelogConfig === "conventional-changelog") {
+      const rawLog = await this.getConventionalChangelog();
+      changelog = this.getFilteredChangelog(rawLog);
     } else if (!!changelogConfig && typeof changelogConfig == "string") {
       changelog = execSync(changelogConfig).toString().trim();
     } else {
-      const resolvedCurrentTag = this.ctx.release.bumpp.tag;
-      const rawLog = this.getGitLog(resolvedCurrentTag);
-      const resolvedCommitMessage = this.ctx.release.bumpp.commit;
-      changelog = this.getFilteredChangelog(rawLog, resolvedCommitMessage);
+      const rawLog = this.getGitLog();
+      changelog = this.getFilteredChangelog(rawLog);
     }
     this.logger.debug(`Got changelog:
 ${changelog}
@@ -1026,7 +1030,8 @@ class RunnerWebExt extends ServeBase {
         // These are non CLI related options for each function.
         // You need to specify this one so that your NodeJS application
         // can continue running after web-ext is finished.
-        shouldExitProgram: false
+        shouldExitProgram: false,
+        getValidatedManifest
       }
     );
     this._runner = runner;
@@ -1125,4 +1130,4 @@ const Config = {
   loadConfig
 };
 
-export { Base as B, Config as C, Log as L, Release as R, Serve as S, Build as a, defineConfig as d };
+export { Build as B, Config as C, Log as L, Release as R, Serve as S, Base as a, defineConfig as d };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zotero-plugin-scaffold",
   "type": "module",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "A scaffold for Zotero plugin development.",
   "author": "northword",
   "license": "AGPL-3.0-or-later",
@@ -50,18 +50,24 @@
     "lib": "dist",
     "doc": "docs"
   },
+  "peerDependencies": {
+    "conventional-changelog": "^6.0.0"
+  },
+  "peerDependenciesMeta": {
+    "conventional-changelog": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@commander-js/extra-typings": "^12.1.0",
-    "@gitee/typescript-sdk-v5": "^5.4.85",
-    "@inquirer/prompts": "^5.5.0",
-    "bumpp": "^9.6.1",
-    "c12": "^1.11.2",
+    "@inquirer/prompts": "^7.0.0",
+    "bumpp": "^9.7.1",
+    "c12": "^2.0.1",
     "chalk": "^5.3.0",
-    "chokidar": "^3.6.0",
+    "chokidar": "^4.0.1",
     "commander": "^12.1.0",
-    "conventional-changelog": "^6.0.0",
-    "es-toolkit": "^1.22.0",
-    "esbuild": "^0.23.1",
+    "es-toolkit": "^1.25.2",
+    "esbuild": "^0.24.0",
     "fs-extra": "^11.2.0",
     "globby": "^14.0.2",
     "hookable": "^5.5.3",
@@ -73,13 +79,13 @@
     "web-ext": "^8.3.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^3.7.3",
+    "@antfu/eslint-config": "^3.8.0",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.16.10",
+    "@types/node": "^20.16.12",
     "@types/update-notifier": "^6.0.8",
-    "eslint": "^9.11.1",
+    "eslint": "^9.12.0",
     "eslint-plugin-format": "^0.1.2",
-    "typescript": "^5.6.2",
+    "typescript": "^5.6.3",
     "unbuild": "^2.0.0"
   },
   "scripts": {

package/dist/chunks/gitee.mjs

@@ -1,127 +0,0 @@
-import fs from 'node:fs';
-import { join, basename } from 'node:path';
-import { env } from 'node:process';
-import { OpenAPI, RepositoriesService } from '@gitee/typescript-sdk-v5';
-import { globbySync } from 'globby';
-import { R as ReleaseBase } from '../shared/zotero-plugin-scaffold.3e58ced7.mjs';
-import 'std-env';
-import '../shared/zotero-plugin-scaffold.c7c8af0c.mjs';
-import 'c12';
-import 'es-toolkit';
-import 'fs-extra';
-import 'hookable';
-import 'node:readline';
-import 'chalk';
-import 'esbuild';
-import 'replace-in-file';
-import 'web-ext';
-import 'node:crypto';
-import 'node:child_process';
-import 'conventional-changelog';
-import 'bumpp';
-import 'chokidar';
-
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-class Gitee extends ReleaseBase {
-  constructor() {
-    super(...arguments);
-    __publicField(this, "client", RepositoriesService);
-  }
-  async run() {
-    OpenAPI.TOKEN = env.GITEE_TOKEN;
-    if (!OpenAPI.TOKEN)
-      throw new Error("No GITEE_TOKEN provided!");
-    this.checkFiles();
-    this.logger.info("Uploading XPI to Gitee...");
-    await this.uploadXPI();
-    this.logger.info("Refreshing update manifest...");
-    await this.refreshUpdateManifest();
-  }
-  async uploadXPI() {
-    const { version, dist, xpiName } = this.ctx;
-    const release = await this.refreshRelease(
-      this.ctx.release.bumpp.tag.toString().replaceAll("%s", version),
-      `Release v${version}`,
-      this.ctx.release.gitee.releaseNote(this.ctx)
-    );
-    await this.refreshAttach(release.id, join(dist, `${xpiName}.xpi`));
-  }
-  async refreshUpdateManifest() {
-    const updater = this.ctx.release.gitee.updater;
-    if (!updater) {
-      this.logger.debug(
-        `Skip refresh update.json because release.gitee.updater = false`
-      );
-      return;
-    }
-    const { dist, version } = this.ctx;
-    const assets = globbySync(`${dist}/update*.json`).map((p) => basename(p));
-    const release = await this.refreshRelease(
-      updater,
-      "Zotero Auto Update Manifest",
-      `This release is used to host \`update.json\`, Updated in UTC ${( new Date()).toISOString()} for v${version}.`,
-      true
-    );
-    for (const asset of assets)
-      await this.refreshAttach(release.id, join(dist, asset));
-  }
-  async refreshRelease(tag, name, body, prerelease = false) {
-    const old = await this.client.getV5ReposOwnerRepoReleasesTagsTag({
-      ...this.remote,
-      tag
-    });
-    if (old?.id) {
-      return this.client.patchV5ReposOwnerRepoReleasesId({
-        ...this.remote,
-        name,
-        body,
-        prerelease,
-        id: old.id,
-        tagName: tag
-      });
-    }
-    return this.client.postV5ReposOwnerRepoReleases({
-      ...this.remote,
-      name,
-      body,
-      prerelease,
-      tagName: tag,
-      targetCommitish: "main"
-    });
-  }
-  async refreshAttach(releaseId, file) {
-    const assets = await this.client.getV5ReposOwnerRepoReleasesReleaseIdAttachFiles({
-      ...this.remote,
-      releaseId
-    });
-    const fileBuffer = fs.readFileSync(file);
-    for (const asset of assets) {
-      if (asset.name === basename(file)) {
-        await this.client.deleteV5ReposOwnerRepoReleasesReleaseIdAttachFilesAttachFileId({
-          ...this.remote,
-          releaseId,
-          attachFileId: asset.id
-        }).catch((e) => this.logger.error(e));
-      }
-    }
-    this.client.postV5ReposOwnerRepoReleasesReleaseIdAttachFiles({
-      ...this.remote,
-      releaseId,
-      file: new File([fileBuffer], basename(file), { type: "application/octet-stream" })
-    });
-  }
-  get remote() {
-    const [owner, repo] = this.ctx.release.gitee.repository.split("/");
-    return {
-      owner,
-      repo
-    };
-  }
-}
-
-export { Gitee as default };

package/dist/shared/zotero-plugin-scaffold.3e58ced7.mjs

@@ -1,25 +0,0 @@
-import { globbySync } from 'globby';
-import { isCI } from 'std-env';
-import { B as Base } from './zotero-plugin-scaffold.c7c8af0c.mjs';
-
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-class ReleaseBase extends Base {
-  constructor(ctx) {
-    super(ctx);
-    __publicField(this, "isCI");
-    this.isCI = isCI;
-  }
-  checkFiles() {
-    const { dist } = this.ctx;
-    if (globbySync(`${dist}/*.xpi`).length === 0) {
-      throw new Error("No xpi file found, are you sure you have run build?");
-    }
-  }
-}
-
-export { ReleaseBase as R };