chore: add plugin pack command (Experimental)

jest.config.js

@@ -5,6 +5,7 @@ const config = {
   testPathIgnorePatterns: [
     "<rootDir>/node_modules/",
     "<rootDir>/src/__tests__/setup.ts",
+    "<rootDir>/src/plugin/packer/__tests__/helpers/",
     "fixtures",
   ],
 };

license-manager.config.js

@@ -57,6 +57,14 @@ const OVERRIDE_LICENSES_TEXT = {
     licensePageUrl:
       "https://raw.githubusercontent.com/dominictarr/through/master/LICENSE.MIT",
   },
+  "node-rsa": {
+    // License text is written in README.md
+    licenseText: "See https://github.com/rzcoder/node-rsa#license",
+  },
+  "stream-buffers": {
+    licensePageUrl:
+      "https://raw.githubusercontent.com/samcday/node-stream-buffer/refs/heads/main/UNLICENSE",
+  },
 };
 
 module.exports = config;

package.json

@@ -76,10 +76,15 @@
     "@cybozu/eslint-config": "^24.0.0-beta.0",
     "@cybozu/license-manager": "^1.2.1",
     "@octokit/rest": "^20.1.1",
+    "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.14",
     "@types/node": "^18.19.59",
+    "@types/node-rsa": "^1.1.4",
     "@types/rollup-plugin-auto-external": "^2.0.5",
+    "@types/stream-buffers": "^3.0.7",
     "@types/yargs": "^17.0.33",
+    "@types/yauzl": "^2.10.3",
+    "@types/yazl": "^2.4.5",
     "@vercel/ncc": "^0.38.2",
     "ajv": "^8.17.1",
     "allure-commandline": "^2.31.0",
@@ -101,13 +106,22 @@
   },
   "dependencies": {
     "@inquirer/prompts": "^5.3.8",
+    "@kintone/plugin-manifest-validator": "^10.2.2",
     "@kintone/rest-api-client": "^5.5.2",
     "chalk": "4.1.2",
+    "chokidar": "^4.0.1",
     "csv-parse": "^4.16.3",
     "csv-stringify": "5.6.5",
+    "debug": "^4.3.7",
+    "execa": "^9.4.1",
     "https-proxy-agent": "^7.0.5",
     "iconv-lite": "^0.6.3",
-    "yargs": "^17.7.2"
+    "mkdirp": "^3.0.1",
+    "node-rsa": "^1.1.1",
+    "stream-buffers": "^3.0.3",
+    "yargs": "^17.7.2",
+    "yauzl": "^3.1.3",
+    "yazl": "^3.1.0"
   },
   "packageManager": "[email protected]",
   "pnpm": {

src/cli/main.ts

@@ -1,11 +1,14 @@
 import yargs from "yargs";
 import { recordCommand } from "./record";
+import { pluginCommand } from "./plugin";
 import packageJson from "../../package.json";
 import { logHandler, logOptions } from "./logOption";
 
 // eslint-disable-next-line no-unused-expressions
 yargs
   .command(recordCommand)
+  // NOTE: Hide the plugin command because it's in very early development.
+  .command({ ...pluginCommand, describe: false })
   .options(logOptions)
   .middleware(logHandler)
   .demandCommand()

src/cli/plugin/index.ts

@@ -0,0 +1,22 @@
+import type { CommandModule } from "yargs";
+import type yargs from "yargs";
+import { packCommand } from "./pack";
+import { emitExperimentalWarning } from "../../utils/stability";
+
+const command = "plugin";
+
+const describe = "[Experimental] Commands for kintone plugin";
+
+const builder = (args: yargs.Argv) => args.command(packCommand).demandCommand();
+
+const handler = () => {
+  emitExperimentalWarning("This feature is under early development");
+  /** noop **/
+};
+
+export const pluginCommand: CommandModule = {
+  command,
+  describe,
+  builder,
+  handler,
+};

src/cli/plugin/pack.ts

@@ -0,0 +1,59 @@
+import type yargs from "yargs";
+import type { CommandModule } from "yargs";
+import cli from "../../plugin/packer/cli";
+import { emitExperimentalWarning } from "../../utils/stability";
+
+const command = "pack";
+
+const describe = "[Experimental] Packaging plugin project to a zip file";
+
+const builder = (args: yargs.Argv) =>
+  args
+    .option("input", {
+      describe: "The input plugin project directory",
+      type: "string",
+      demandOption: true,
+      requiresArg: true,
+    })
+    .option("output", {
+      describe:
+        "The destination path of generated plugin file\nDefault to plugin.zip on current directory",
+      type: "string",
+      default: "plugin.zip",
+      requiresArg: true,
+    })
+    .option("private-key", {
+      describe:
+        "The path of private key file\nIf omitted, new private key will be generated.",
+      type: "string",
+      requiresArg: true,
+    })
+    .option("watch", {
+      describe: "run in watch mode",
+      type: "boolean",
+    });
+
+type Args = yargs.Arguments<
+  ReturnType<typeof builder> extends yargs.Argv<infer U> ? U : never
+>;
+
+const handler = async (args: Args) => {
+  emitExperimentalWarning("This feature is under early development");
+  const flags = {
+    ppk: args["private-key"],
+    out: args.output,
+    watch: args.watch,
+  };
+  if (process.env.NODE_ENV === "test") {
+    console.log(JSON.stringify({ pluginDir: args.input, flags: flags }));
+  } else {
+    await cli(args.input, flags);
+  }
+};
+
+export const packCommand: CommandModule<{}, Args> = {
+  command,
+  describe,
+  builder,
+  handler,
+};

src/cli/record.ts → src/cli/record/index.ts

@@ -1,8 +1,8 @@
 import type { CommandModule } from "yargs";
 import type yargs from "yargs";
-import { exportCommand } from "./record/export";
-import { importCommand } from "./record/import";
-import { deleteCommand } from "./record/delete";
+import { exportCommand } from "./export";
+import { importCommand } from "./import";
+import { deleteCommand } from "./delete";
 
 const command = "record";
 

src/plugin/packer/__tests__/.gitignore

@@ -0,0 +1,2 @@
+fixtures/sample-plugin/plugin.zip
+fixtures/sample-plugin/*.ppk

src/plugin/packer/__tests__/bin.test.ts

@@ -0,0 +1,79 @@
+import path from "path";
+import type { ExecaMethod } from "execa";
+import pkg from "../../../../package.json";
+
+// TODO: Remove this test file
+const execa = {} as ExecaMethod<{}>;
+
+describe.skip("bin", () => {
+  it("should output version with --version", () =>
+    exec("--version").then((result) => {
+      expect(result.stdout).toBe(pkg.version);
+    }));
+
+  it("should fail without args", () =>
+    exec().then(
+      () => {
+        throw new Error("should be rejected");
+      },
+      (result) => {
+        expect(/An argument `PLUGIN_DIR` is required/.test(result.stderr)).toBe(
+          true,
+        );
+      },
+    ));
+
+  it("should recieve 1st arg as PLUGIN_DIR", () =>
+    exec("foo").then((result) => {
+      expect(JSON.parse(result.stdout)).toStrictEqual({
+        pluginDir: "foo",
+        flags: { watch: false },
+      });
+    }));
+
+  it("should recieve --ppk", () =>
+    exec("foo", "--ppk", "bar").then((result) => {
+      expect(JSON.parse(result.stdout)).toStrictEqual({
+        pluginDir: "foo",
+        flags: { watch: false, ppk: "bar" },
+      });
+    }));
+
+  it("should recieve --out", () =>
+    exec("foo", "--out", "bar").then((result) => {
+      expect(JSON.parse(result.stdout)).toStrictEqual({
+        pluginDir: "foo",
+        flags: { watch: false, out: "bar" },
+      });
+    }));
+
+  it("should recieve --watch", () =>
+    exec("foo", "--watch").then((result) => {
+      expect(JSON.parse(result.stdout)).toStrictEqual({
+        pluginDir: "foo",
+        flags: { watch: true },
+      });
+    }));
+
+  it("should recieve -w as an alias of --watch", () =>
+    exec("foo", "-w").then((result) => {
+      expect(JSON.parse(result.stdout)).toStrictEqual({
+        pluginDir: "foo",
+        flags: { watch: true },
+      });
+    }));
+
+  it("should filter unexpected option", () =>
+    exec("foo", "--bar").then((result) => {
+      expect(JSON.parse(result.stdout)).toStrictEqual({
+        pluginDir: "foo",
+        flags: { watch: false },
+      });
+    }));
+});
+
+const exec = (...args: string[]) => {
+  const binPath = path.resolve(__dirname, "../bin/cli.js");
+  const env = Object.assign({}, process.env, { NODE_ENV: "test" });
+  return execa(binPath, args, { env });
+};