zotero-plugin-scaffold 0.0.4

package/dist/utils/log.js

@@ -0,0 +1,52 @@
+import chalk from "chalk";
+import { isCI } from "ci-info";
+var LOG_LEVEL;
+(function (LOG_LEVEL) {
+    LOG_LEVEL[LOG_LEVEL["trace"] = 0] = "trace";
+    LOG_LEVEL[LOG_LEVEL["debug"] = 1] = "debug";
+    LOG_LEVEL[LOG_LEVEL["info"] = 2] = "info";
+    LOG_LEVEL[LOG_LEVEL["warn"] = 3] = "warn";
+    LOG_LEVEL[LOG_LEVEL["error"] = 4] = "error";
+})(LOG_LEVEL || (LOG_LEVEL = {}));
+export default class Log {
+    logLevel;
+    constructor(config) {
+        if (config) {
+            this.logLevel = isCI ? 0 : LOG_LEVEL[config.logLevel];
+        }
+        else {
+            this.logLevel = 0;
+        }
+    }
+    // shouldLog(isExternal?: boolean) {
+    //   return this.verbosityLevel === 2 || (this.isVerbose && isExternal);
+    // }
+    log(...args) {
+        args = args.map((arg) => {
+            if (typeof arg == "object")
+                return JSON.stringify(arg, null, 2);
+            return arg;
+        });
+        console.log(...args);
+    }
+    error(...args) {
+        if (this.logLevel <= 4)
+            console.log(chalk.red("ERROR"), ...args);
+    }
+    warn(...args) {
+        if (this.logLevel <= 3)
+            this.log(chalk.yellow("WARNING"), ...args);
+    }
+    info(...args) {
+        if (this.logLevel <= 2)
+            this.log(chalk.green("INFO"), ...args);
+    }
+    debug(...args) {
+        if (this.logLevel <= 1)
+            this.log(chalk.grey("DEBUG"), ...args);
+    }
+    trace(...args) {
+        if (this.logLevel <= 0)
+            this.log(chalk.grey(...args));
+    }
+}

package/dist/utils/process.d.ts

@@ -0,0 +1 @@
+export declare function isRunning(query: string, cb: (status: boolean) => void): void;

package/dist/utils/process.js

@@ -0,0 +1,21 @@
+import { exec } from "child_process";
+export function isRunning(query, cb) {
+    const platform = process.platform;
+    let cmd = "";
+    switch (platform) {
+        case "win32":
+            cmd = `tasklist`;
+            break;
+        case "darwin":
+            cmd = `ps -ax | grep ${query}`;
+            break;
+        case "linux":
+            cmd = `ps -A`;
+            break;
+        default:
+            break;
+    }
+    exec(cmd, (err, stdout, stderr) => {
+        cb(stdout.toLowerCase().indexOf(query.toLowerCase()) > -1);
+    });
+}

package/dist/utils/string.d.ts

@@ -0,0 +1 @@
+export declare function dateFormat(fmt: string, date: Date): string;

package/dist/utils/string.js

@@ -0,0 +1,18 @@
+export function dateFormat(fmt, date) {
+    let ret;
+    const opt = {
+        "Y+": date.getFullYear().toString(),
+        "m+": (date.getMonth() + 1).toString(),
+        "d+": date.getDate().toString(),
+        "H+": date.getHours().toString(),
+        "M+": date.getMinutes().toString(),
+        "S+": date.getSeconds().toString(),
+    };
+    for (const k in opt) {
+        ret = new RegExp("(" + k + ")").exec(fmt);
+        if (ret) {
+            fmt = fmt.replace(ret[1], ret[1].length == 1 ? opt[k] : opt[k].padStart(ret[1].length, "0"));
+        }
+    }
+    return fmt;
+}

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "zotero-plugin-scaffold",
+  "version": "0.0.4",
+  "description": "A scaffold for Zotero plugin development.",
+  "main": "dist/index.js",
+  "bin": {
+    "zotero-plugin": "bin/zotero-plugin.mjs"
+  },
+  "type": "module",
+  "keywords": [
+    "zotero",
+    "plugin",
+    "developer",
+    "scaffold",
+    "web-ext"
+  ],
+  "author": "northword",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/northword/zotero-plugin-scaffold.git"
+  },
+  "bugs": {
+    "url": "https://github.com/northword/zotero-plugin-scaffold/issues"
+  },
+  "homepage": "https://github.com/northword/zotero-plugin-scaffold#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "files": [
+    "bin/**/*",
+    "dist/**/*.d.ts",
+    "dist/**/*.js",
+    "docs/**/*",
+    "types/**/*.d.ts"
+  ],
+  "directories": {
+    "lib": "dist",
+    "doc": "docs"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "packageManager": "pnpm@8.14.0",
+  "dependencies": {
+    "@inquirer/prompts": "^3.3.2",
+    "@octokit/rest": "^20.0.2",
+    "bumpp": "^9.3.0",
+    "chalk": "^5.3.0",
+    "chokidar": "^3.5.3",
+    "ci-info": "^4.0.0",
+    "commander": "^11.1.0",
+    "compressing": "^1.10.0",
+    "cosmiconfig": "^9.0.0",
+    "dotenv": "^16.4.1",
+    "esbuild": "^0.19.12",
+    "fast-glob": "^3.3.2",
+    "fs-extra": "^11.2.0",
+    "lodash": "^4.17.21",
+    "mime": "^4.0.1",
+    "ora": "^8.0.1",
+    "release-it": "^17.0.3",
+    "replace-in-file": "^7.1.0",
+    "update-notifier": "^7.0.0",
+    "web-ext": "^7.11.0"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/fs-extra": "^11.0.4",
+    "@types/lodash": "^4.14.202",
+    "@types/node": "^20.11.9",
+    "@types/update-notifier": "^6.0.8",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "^3.2.4",
+    "typescript": "^5.3.3"
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore(publish): release v${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": false
+    },
+    "github": {
+      "release": false
+    }
+  },
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc",
+    "lint": "eslint --max-warnings=0 . && prettier --check .",
+    "lint:fix": "eslint --fix . && prettier --write .",
+    "release": "release-it --only-version --preReleaseId=beta",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/types/release-it.d.ts

@@ -0,0 +1,104 @@
+declare module "release-it" {
+  export default function runTasks(
+    opts: ReleaseItConfig,
+    di?: any,
+  ): Promise<ReleaseItRunTaskResult>;
+  export const Config: any;
+  export const Plugin: any;
+}
+
+interface ReleaseItRunTaskResult {
+  name: string;
+  changelog: any;
+  lastestVersion: any;
+  version: any;
+}
+
+/**
+ * Release it
+ * @see https://github.com/release-it/release-it/blob/main/README.md
+ */
+interface ReleaseItConfigBase {
+  hooks?: Record<string, string | string[]>;
+  git?: {
+    changelog?: string;
+    requireCleanWorkingDir?: boolean;
+    requireBranch?: boolean;
+    requireUpstream?: boolean;
+    requireCommits?: boolean;
+    requireCommitsFail?: boolean;
+    commitsPath?: string;
+    addUntrackedFiles?: boolean;
+    commit?: boolean;
+    commitMessage?: string;
+    commitArgs?: [];
+    tag?: boolean;
+    tagExclude?: null;
+    tagName?: string;
+    tagMatch?: string;
+    getLatestTagFromAllRefs?: boolean;
+    tagAnnotation?: string;
+    tagArgs?: string[];
+    push?: boolean;
+    pushArgs?: string[];
+    pushRepo?: string;
+  };
+  npm?: {
+    publish?: boolean;
+    publishPath?: string;
+    publishArgs?: string[];
+    tag?: null;
+    otp?: null;
+    ignoreVersion?: boolean;
+    allowSameVersion?: boolean;
+    versionArgs?: string[];
+    skipChecks?: boolean;
+    timeout?: number;
+  };
+  github?: {
+    release?: boolean;
+    releaseName?: string;
+    releaseNotes?: null;
+    autoGenerate?: boolean;
+    preRelease?: boolean;
+    draft?: boolean;
+    tokenRef?: string;
+    assets?: string[];
+    host?: string;
+    timeout?: number;
+    proxy?: null;
+    skipChecks?: false;
+    web?: boolean;
+    comments?: {
+      submit?: boolean;
+      issue?: string;
+      pr?: string;
+    };
+  };
+  gitlab?: {
+    release?: boolean;
+    releaseName?: string;
+    releaseNotes?: null;
+    milestones?: [];
+    tokenRef?: string;
+    tokenHeader?: string;
+    certificateAuthorityFile?: null;
+    assets?: string[];
+    origin?: null;
+    skipChecks?: boolean;
+  };
+}
+
+interface ReleaseItConfigConstructor {
+  "dry-run"?: boolean;
+  "only-version"?: boolean;
+  increment?: boolean;
+  preReleaseId?: "alpha" | "beta" | "next" | "rc" | string;
+  ci?: boolean;
+  changelog?: boolean;
+  verbose?: boolean | number;
+}
+
+interface ReleaseItConfig
+  extends ReleaseItConfigConstructor,
+    ReleaseItConfigBase {}

package/types/web-ext.d.ts

@@ -0,0 +1,54 @@
+declare module "web-ext" {
+  export default webext = {
+    cmd,
+    main,
+  };
+  export const cmd: {
+    build(
+      params: {
+        sourceDir: string;
+        artifactsDir: string;
+        /**
+         * @default false
+         */
+        asNeeded?: boolean;
+        /**
+         * @default false
+         */
+        overwriteDest?: boolean;
+        /**
+         * @default []
+         */
+        ignoreFiles?: string[];
+        /**
+         * @default '{name}-{version}.zip'
+         */
+        filename?: string;
+      },
+      options?: any,
+    ): Promise<any>;
+
+    lint(params: LintParams, options?: any): Promise<any>;
+    run(params: any, options?: any): Promise<any>;
+    sign(params: any, options?: any): Promise<any>;
+    docs(params: any, options?: any): Promise<any>;
+  };
+  export const main: {
+    //
+  };
+}
+
+interface LintParams {
+  artifactsDir: string;
+  boring: string;
+  firefoxPreview?: any[];
+  ignoreFiles: any;
+  metadata: any;
+  output: any;
+  pretty: any;
+  privileged: any;
+  sourceDir: any;
+  selfHosted: any;
+  verbose: any;
+  warningsAsErrors: any;
+}