zotero-plugin-scaffold 0.0.4

package/dist/lib/build.js

@@ -0,0 +1,194 @@
+import { generateHashSync } from "../utils/crypto.js";
+import { LibBase } from "../utils/libBase.js";
+import { dateFormat } from "../utils/string.js";
+import chalk from "chalk";
+import { zip } from "compressing";
+import { buildSync } from "esbuild";
+import glob from "fast-glob";
+import fs from "fs-extra";
+import path from "path";
+import replaceInFile from "replace-in-file";
+const { replaceInFileSync } = replaceInFile;
+export default class Build extends LibBase {
+    buildTime;
+    isPreRelease;
+    constructor(config) {
+        super(config);
+        this.buildTime = "";
+        this.isPreRelease = this.version.includes("-");
+    }
+    /**
+     * Default build runner
+     */
+    async run() {
+        const t = new Date();
+        this.buildTime = dateFormat("YYYY-mm-dd HH:MM:SS", t);
+        this.logger.info(`Building version ${chalk.blue(this.version)} to ${chalk.blue(this.config.dist)} at ${chalk.blue(this.buildTime)} in ${chalk.blue(process.env.NODE_ENV)} mode.`);
+        fs.emptyDirSync(this.config.dist);
+        this.copyAssets();
+        this.logger.debug("Preparing manifest...");
+        this.makeManifest();
+        this.makebootstrap();
+        this.logger.debug("Preparing locale files...");
+        this.prepareLocaleFiles();
+        this.logger.debug("Replacing...");
+        this.replaceString();
+        this.logger.debug("Running esbuild...");
+        this.esbuild();
+        this.logger.debug("Running extra builder...");
+        await this.config.extraBuilder(this.config);
+        this.logger.debug("Addon prepare OK.");
+        /**======== build resolved ===========*/
+        if (process.env.NODE_ENV === "production") {
+            this.logger.debug("Packing Addon...");
+            await this.pack();
+            this.logger.debug("Preparing update.json...");
+            this.makeUpdateJson();
+        }
+        this.logger.info(`Build finished in ${(new Date().getTime() - t.getTime()) / 1000} s.`);
+    }
+    /**
+     * Copys files in `Config.assets` to `Config.dist`
+     */
+    copyAssets() {
+        const files = glob.sync(this.config.assets);
+        files.forEach((file) => {
+            const newPath = `${this.config.dist}/addon/${file.replace(new RegExp(this.config.source.join("|")), "")}`;
+            this.logger.trace(`Copy ${file} to ${newPath}`);
+            fs.copySync(file, newPath);
+        });
+    }
+    makeManifest() {
+        if (!this.config.makeManifest.enable)
+            return;
+        fs.outputJSONSync(`${this.config.dist}/addon/manifest.json`, this.config.makeManifest.template, { spaces: 2 });
+    }
+    makebootstrap() {
+        if (!this.config.makeBootstrap)
+            return;
+        fs.copySync(path.join(this.config.pkgAbsolute, "template/default/bootstrap.js"), `${this.config.dist}/addon/bootstrap.js`);
+    }
+    /**
+     * Replace all `placeholder.key` to `placeholder.value` for all files in `dist`
+     */
+    replaceString() {
+        const replaceFrom = [], replaceTo = [];
+        // Config.placeholders has the highest priority
+        replaceFrom.push(...Object.keys(this.config.define).map((k) => new RegExp(`__${k}__`, "g")));
+        replaceTo.push(...Object.values(this.config.define));
+        replaceFrom.push(/__buildTime__/g);
+        replaceTo.push(this.buildTime);
+        const replaceResult = replaceInFileSync({
+            files: this.config.assets.map((asset) => `${this.config.dist}/${asset}`),
+            from: replaceFrom,
+            to: replaceTo,
+            countMatches: true,
+        });
+        this.logger.debug("Run replace in ", replaceResult
+            .filter((f) => f.hasChanged)
+            .map((f) => `${f.file} : ${f.numReplacements} / ${f.numMatches}`));
+    }
+    prepareLocaleFiles() {
+        // Prefix Fluent messages in xhtml
+        const MessagesInHTML = new Set();
+        replaceInFileSync({
+            files: [
+                `${this.config.dist}/addon/**/*.xhtml`,
+                `${this.config.dist}/addon/**/*.html`,
+            ],
+            // @ts-expect-error ReplaceInFileConfig has processor
+            processor: (input) => {
+                const matchs = [...input.matchAll(/(data-l10n-id)="(\S*)"/g)];
+                matchs.map((match) => {
+                    input = input.replace(match[0], this.config.fluent.prefixFluentMessages == true
+                        ? `${match[1]}="${this.addonRef}-${match[2]}"`
+                        : match[0]);
+                    MessagesInHTML.add(match[2]);
+                });
+                return input;
+            },
+        });
+        // Walk the sub folders of `build/addon/locale`
+        const localeNames = glob
+            .sync(`${this.config.dist}/addon/locale/*/`, {})
+            .map((locale) => path.basename(locale));
+        for (const localeName of localeNames) {
+            // rename *.ftl to addonRef-*.ftl
+            if (this.config.fluent.prefixLocaleFiles == true) {
+                glob
+                    .sync(`${this.config.dist}/addon/locale/${localeName}/**/*.ftl`, {})
+                    .forEach((f) => {
+                    fs.moveSync(f, `${path.dirname(f)}/${this.addonRef}-${path.basename(f)}`);
+                });
+            }
+            // Prefix Fluent messages in each ftl
+            const MessageInThisLang = new Set();
+            replaceInFileSync({
+                files: [`${this.config.dist}/addon/locale/${localeName}/**/*.ftl`],
+                // @ts-expect-error ReplaceInFileConfig has processor
+                processor: (fltContent) => {
+                    const lines = fltContent.split("\n");
+                    const prefixedLines = lines.map((line) => {
+                        // https://regex101.com/r/lQ9x5p/1
+                        const match = line.match(/^(?<message>[a-zA-Z]\S*)([ ]*=[ ]*)(?<pattern>.*)$/m);
+                        if (match && match.groups) {
+                            MessageInThisLang.add(match.groups.message);
+                            return this.config.fluent.prefixFluentMessages
+                                ? `${this.addonRef}-${line}`
+                                : line;
+                        }
+                        else {
+                            return line;
+                        }
+                    });
+                    return prefixedLines.join("\n");
+                },
+            });
+            // If a message in xhtml but not in ftl of current language, log it
+            MessagesInHTML.forEach((message) => {
+                if (!MessageInThisLang.has(message)) {
+                    this.logger.error(`${message} don't exist in ${localeName}`);
+                }
+            });
+        }
+    }
+    esbuild() {
+        this.config.esbuildOptions.forEach(async (esbuildOption) => {
+            buildSync(esbuildOption);
+        });
+    }
+    makeUpdateJson() {
+        fs.writeJsonSync(`${this.config.dist}/update-beta.json`, this.config.makeUpdateJson.template, { spaces: 2 });
+        fs.writeJsonSync(`${this.config.dist}/update.json`, this.config.makeUpdateJson.template, { spaces: 2 });
+        const updateHash = generateHashSync(path.join(this.config.dist, `${this.xpiName}.xpi`), "sha512");
+        const replaceResult = replaceInFileSync({
+            files: [
+                `${this.config.dist}/update-beta.json`,
+                `${this.config.dist}/${this.isPreRelease ? "pass" : "update.json"}`,
+            ],
+            from: [
+                /__addonID__/g,
+                /__version__/g,
+                /__updateLink__/g,
+                /__updateHash__/g,
+            ],
+            to: [this.addonID, this.version, this.updateLink, updateHash],
+            countMatches: true,
+        });
+        this.logger.debug(`Prepare Update.json for ${this.isPreRelease
+            ? "\u001b[31m Prerelease \u001b[0m"
+            : "\u001b[32m Release \u001b[0m"}`, replaceResult
+            .filter((f) => f.hasChanged)
+            .map((f) => `${f.file} : ${f.numReplacements} / ${f.numMatches}`));
+    }
+    async pack() {
+        await zip.compressDir(path.join(this.config.dist, "addon"), path.join(this.config.dist, `${this.xpiName}.xpi`), {
+            ignoreBase: true,
+        });
+        // await webext.cmd.build({
+        //   sourceDir: `${this.config.dist}/addon`,
+        //   artifactsDir: this.config.dist,
+        //   filename: `${this.pkg.name ?? "name"}.xpi`,
+        // });
+    }
+}

package/dist/lib/create.d.ts

@@ -0,0 +1,19 @@
+export default class Create {
+    run(): Promise<void>;
+    prompting(): Promise<{
+        plugin: {
+            name: string;
+            description: string;
+            id: string;
+        };
+        code: {
+            namespace: string;
+        };
+        user: {
+            name: string;
+            email: string;
+        };
+    }>;
+    downloadTemplate(): void;
+    parseTemplate(): void;
+}

package/dist/lib/create.js

@@ -0,0 +1,40 @@
+// npx 创建模板
+import { input } from "@inquirer/prompts";
+export default class Create {
+    async run() {
+        const answers = await this.prompting();
+        console.log(answers);
+    }
+    async prompting() {
+        const answers = {
+            plugin: {
+                name: await input({ message: "What's the name of plugin?" }),
+                description: await input({
+                    message: "What's description of plugin?",
+                }),
+                id: await input({ message: "What's the ID of plugin?" }),
+            },
+            code: {
+                namespace: await input({
+                    message: "What's the namespace of plugin?",
+                    default: "",
+                }),
+                // package manager select: npm yarn pnpm
+                // use typescript?
+                // use prettier and lint?
+            },
+            user: {
+                name: await input({ message: "What's your GitHub user ID?" }),
+                email: await input({ message: "What's your email?" }),
+            },
+            // install deps?
+        };
+        return answers;
+    }
+    downloadTemplate() {
+        //
+    }
+    parseTemplate() {
+        //
+    }
+}

package/dist/lib/lint.d.ts

@@ -0,0 +1,6 @@
+import { Config } from "../types.js";
+export default class Lint {
+    options: Config;
+    constructor(options: Config);
+    lint(): void;
+}

package/dist/lib/lint.js

@@ -0,0 +1,9 @@
+export default class Lint {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    lint() {
+        // webext.cmd.lint({});
+    }
+}

package/dist/lib/release.d.ts

@@ -0,0 +1,255 @@
+import { Config } from "../types.js";
+import { LibBase } from "../utils/libBase.js";
+import { Octokit } from "@octokit/rest";
+export default class Release extends LibBase {
+    isCI: boolean;
+    client: Octokit;
+    constructor(config: Config);
+    /**
+     * Runs release
+     *
+     * if is not CI，bump version, git add (package.json), git commit, git tag, git push;
+     * if is CI, do not bump version, do not run git, create release (tag is `v${version}`) and upload xpi,
+     *    then, create or update release (tag is "release"), update `update.json`.
+     */
+    run(): Promise<void>;
+    /**
+     * Bumps release
+     *
+     * release: bump version, run build, git add, git commit, git tag, git push
+     */
+    bump(): void;
+    /**
+     * Create new release and upload XPI to asset
+     */
+    uploadXPI(): void;
+    getReleaseByTag(tag: string): Promise<{
+        url: string;
+        html_url: string;
+        assets_url: string;
+        upload_url: string;
+        tarball_url: string | null;
+        zipball_url: string | null;
+        id: number;
+        node_id: string;
+        tag_name: string;
+        target_commitish: string;
+        name: string | null;
+        body?: string | null | undefined;
+        draft: boolean;
+        prerelease: boolean;
+        created_at: string;
+        published_at: string | null;
+        author: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+            login: string;
+            id: number;
+            node_id: string;
+            avatar_url: string;
+            gravatar_id: string | null;
+            url: string;
+            html_url: string;
+            followers_url: string;
+            following_url: string;
+            gists_url: string;
+            starred_url: string;
+            subscriptions_url: string;
+            organizations_url: string;
+            repos_url: string;
+            events_url: string;
+            received_events_url: string;
+            type: string;
+            site_admin: boolean;
+            starred_at?: string | undefined;
+        };
+        assets: {
+            url: string;
+            browser_download_url: string;
+            id: number;
+            node_id: string;
+            name: string;
+            label: string | null;
+            state: "uploaded" | "open";
+            content_type: string;
+            size: number;
+            download_count: number;
+            created_at: string;
+            updated_at: string;
+            uploader: {
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+                login: string;
+                id: number;
+                node_id: string;
+                avatar_url: string;
+                gravatar_id: string | null;
+                url: string;
+                html_url: string;
+                followers_url: string;
+                following_url: string;
+                gists_url: string;
+                starred_url: string;
+                subscriptions_url: string;
+                organizations_url: string;
+                repos_url: string;
+                events_url: string;
+                received_events_url: string;
+                type: string;
+                site_admin: boolean;
+                starred_at?: string | undefined;
+            } | null;
+        }[];
+        body_html?: string | undefined;
+        body_text?: string | undefined;
+        mentions_count?: number | undefined;
+        discussion_url?: string | undefined;
+        reactions?: {
+            url: string;
+            total_count: number;
+            "+1": number;
+            "-1": number;
+            laugh: number;
+            confused: number;
+            heart: number;
+            hooray: number;
+            eyes: number;
+            rocket: number;
+        } | undefined;
+    } | undefined>;
+    creatRelease(options: Parameters<Octokit["repos"]["createRelease"]>[0]): Promise<{
+        url: string;
+        html_url: string;
+        assets_url: string;
+        upload_url: string;
+        tarball_url: string | null;
+        zipball_url: string | null;
+        id: number;
+        node_id: string;
+        tag_name: string;
+        target_commitish: string;
+        name: string | null;
+        body?: string | null | undefined;
+        draft: boolean;
+        prerelease: boolean;
+        created_at: string;
+        published_at: string | null;
+        author: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+            login: string;
+            id: number;
+            node_id: string;
+            avatar_url: string;
+            gravatar_id: string | null;
+            url: string;
+            html_url: string;
+            followers_url: string;
+            following_url: string;
+            gists_url: string;
+            starred_url: string;
+            subscriptions_url: string;
+            organizations_url: string;
+            repos_url: string;
+            events_url: string;
+            received_events_url: string;
+            type: string;
+            site_admin: boolean;
+            starred_at?: string | undefined;
+        };
+        assets: {
+            url: string;
+            browser_download_url: string;
+            id: number;
+            node_id: string;
+            name: string;
+            label: string | null;
+            state: "uploaded" | "open";
+            content_type: string;
+            size: number;
+            download_count: number;
+            created_at: string;
+            updated_at: string;
+            uploader: {
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+                login: string;
+                id: number;
+                node_id: string;
+                avatar_url: string;
+                gravatar_id: string | null;
+                url: string;
+                html_url: string;
+                followers_url: string;
+                following_url: string;
+                gists_url: string;
+                starred_url: string;
+                subscriptions_url: string;
+                organizations_url: string;
+                repos_url: string;
+                events_url: string;
+                received_events_url: string;
+                type: string;
+                site_admin: boolean;
+                starred_at?: string | undefined;
+            } | null;
+        }[];
+        body_html?: string | undefined;
+        body_text?: string | undefined;
+        mentions_count?: number | undefined;
+        discussion_url?: string | undefined;
+        reactions?: {
+            url: string;
+            total_count: number;
+            "+1": number;
+            "-1": number;
+            laugh: number;
+            confused: number;
+            heart: number;
+            hooray: number;
+            eyes: number;
+            rocket: number;
+        } | undefined;
+    } | undefined>;
+    uploadAsset(releaseID: number, asset: string): Promise<{
+        url: string;
+        browser_download_url: string;
+        id: number;
+        node_id: string;
+        name: string;
+        label: string | null;
+        state: "uploaded" | "open";
+        content_type: string;
+        size: number;
+        download_count: number;
+        created_at: string;
+        updated_at: string;
+        uploader: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+            login: string;
+            id: number;
+            node_id: string;
+            avatar_url: string;
+            gravatar_id: string | null;
+            url: string;
+            html_url: string;
+            followers_url: string;
+            following_url: string;
+            gists_url: string;
+            starred_url: string;
+            subscriptions_url: string;
+            organizations_url: string;
+            repos_url: string;
+            events_url: string;
+            received_events_url: string;
+            type: string;
+            site_admin: boolean;
+            starred_at?: string | undefined;
+        } | null;
+    }>;
+    uploadUpdateJSON(): Promise<void>;
+    getClient(): Octokit;
+    get owner(): string;
+    get repo(): string;
+}

package/dist/lib/release.js

@@ -0,0 +1,165 @@
+import { LibBase } from "../utils/libBase.js";
+import { Octokit } from "@octokit/rest";
+import ci from "ci-info";
+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 {
+    isCI;
+    client;
+    constructor(config) {
+        super(config);
+        this.isCI = ci.isCI;
+        this.client = this.getClient();
+    }
+    /**
+     * Runs release
+     *
+     * if is not CI，bump version, git add (package.json), git commit, git tag, git push;
+     * if is CI, do not bump version, do not run git, create release (tag is `v${version}`) and upload xpi,
+     *    then, create or update release (tag is "release"), update `update.json`.
+     */
+    async run() {
+        if (!this.isCI) {
+            this.bump();
+        }
+        else {
+            if (glob.globSync(`${this.config.dist}/*.xpi`).length == 0) {
+                this.logger.error("No xpi file found, are you sure you have run the build?");
+            }
+            this.uploadXPI();
+            this.uploadUpdateJSON();
+        }
+    }
+    /**
+     * Bumps release
+     *
+     * 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));
+    }
+    /**
+     * 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 getReleaseByTag(tag) {
+        return await this.client.repos
+            .getReleaseByTag({
+            owner: this.owner,
+            repo: this.repo,
+            tag: tag,
+        })
+            .then((res) => {
+            if (res.status == 200) {
+                return res.data;
+            }
+        })
+            .catch((err) => {
+            this.logger.debug(err);
+            return undefined;
+        });
+    }
+    async creatRelease(options) {
+        return await this.client.repos
+            .createRelease(options)
+            .then((res) => {
+            if (res.status == 201) {
+                return res.data;
+            }
+        })
+            .catch((err) => {
+            this.logger.debug(err);
+            return undefined;
+        });
+    }
+    async uploadAsset(releaseID, asset) {
+        return await this.client.repos
+            .uploadReleaseAsset({
+            owner: this.owner,
+            repo: this.repo,
+            release_id: releaseID,
+            data: fs.readFileSync(asset),
+            headers: {
+                "content-type": mime.getType(asset) || "application/octet-stream",
+                "content-length": fs.statSync(asset).size,
+            },
+            name: path.basename(asset),
+        })
+            .then((res) => {
+            return res.data;
+        });
+    }
+    async uploadUpdateJSON() {
+        const assets = ["update.json", "update-beta.json"];
+        const release = (await this.getReleaseByTag("release")) ??
+            (await this.creatRelease({
+                owner: this.owner,
+                repo: this.repo,
+                tag_name: "release",
+                name: "Release Manifest",
+                body: `This release is used to host \`update.json\`, please do not delete or modify it! \n Updated in UTC ${new Date().toISOString()} for version ${this.version}`,
+                make_latest: "false",
+            }));
+        if (!release)
+            throw new Error("Get or create 'release' failed.");
+        const existAssets = await this.client.repos
+            .listReleaseAssets({
+            owner: this.owner,
+            repo: this.repo,
+            release_id: release.id,
+        })
+            .then((res) => {
+            return res.data.filter((asset) => assets.includes(asset.name));
+        });
+        if (existAssets) {
+            for (const existAsset of existAssets) {
+                await this.client.repos.deleteReleaseAsset({
+                    owner: this.owner,
+                    repo: this.repo,
+                    asset_id: existAsset.id,
+                });
+            }
+        }
+        for (const asset of assets) {
+            await this.uploadAsset(release.id, path.join(this.config.dist, asset));
+        }
+    }
+    getClient() {
+        if (!process.env.GITHUB_TOKEN)
+            throw new Error("No GITHUB_TOKEN.");
+        const client = new Octokit({
+            auth: process.env.GITHUB_TOKEN,
+            userAgent: `zotero-plugin-scaffold/${this.version}`,
+        });
+        return client;
+    }
+    get owner() {
+        return this.config.define.ghOwner;
+    }
+    get repo() {
+        return this.config.define.ghRepo;
+    }
+}