chore: add plugin pack command (Experimental) #915

tasshi-me · 2024-10-24T15:30:27Z

Why

What

import plugin-packer codes from js-sdk (chore: import plugin-packer to subdirectory #903 )
add the plugin pack command as an experimental feature (hidden in the help message)
fix tests

NOTE: Be aware to add co-authors when merging. If co-authors are not automatically set in the commit message, add co-authors manually from co-authored-by.txt of #903 .

How to test

All the automated tests are inherited to /src/plugin/packer/__tests__ from plugin-packer.

Manual test example:

## Prepare plugin project
npx @kintone/create-plugin /tmp/hello-kintone

## Build cli-kintone
pnpm install
pnpm build

## Show pack --help
node cli.js plugin pack --help

## Run pack command
node cli.js plugin pack --input /tmp/hello-kintone/src/ --output /tmp/dist/plugin.zip

ls /tmp/dist # => plugin.zip and .ppk exist

## Run pack command with ppk file
node cli.js plugin pack --input /tmp/hello-kintone/src/ --output /tmp/dist/plugin-2.zip --private-key /tmp/dist/*.ppk

ls /tmp/dist # => plugin.zip, plugin-2.zip, and .ppk exist

Checklist

Read CONTRIBUTING.md
Updated documentation if it is required.
Added/updated tests if it is required. (or tested manually)
Passed pnpm lint and pnpm test on the root directory.

Co-authored-by: Teppei SATO <[email protected]> Co-authored-by: Will <[email protected]> Co-authored-by: teppeis <[email protected]> Co-authored-by: Teppei Sato <[email protected]> Co-authored-by: toshihisa-tomatsu <[email protected]> Co-authored-by: Hiroyuki Anai <[email protected]> Co-authored-by: renovate[bot] <renovate[bot]@users.noreply.github.com> Co-authored-by: Toshihisa Tomatsu <[email protected]> Co-authored-by: WhiteSource Renovate <[email protected]> Co-authored-by: Hiroyuki ANAI <[email protected]> Co-authored-by: Sakito Mukai <[email protected]> Co-authored-by: toshi-toma <[email protected]> Co-authored-by: sakito <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: shisama <[email protected]> Co-authored-by: chick-p <[email protected]> Co-authored-by: Sosuke Suzuki <[email protected]> Co-authored-by: Hodaka Kasama <[email protected]> Co-authored-by: Toru Kobayashi <[email protected]> Co-authored-by: nakajmg <[email protected]> Co-authored-by: Shingo Yamazaki <[email protected]> Co-authored-by: shintaroNagata <[email protected]> Co-authored-by: Shintaro Nagata <[email protected]> Co-authored-by: piyo <[email protected]> Co-authored-by: Shin'ya Ueoka <[email protected]> Co-authored-by: Masashi Hirano <[email protected]> Co-authored-by: Renovate Bot <[email protected]> Co-authored-by: Nguyen Thai Hung <[email protected]> Co-authored-by: ryounasso <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: tasshi / Masaharu TASHIRO <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: tuanphamcybozu <[email protected]> Co-authored-by: hung-nguyen <[email protected]> Co-authored-by: tuan-pham <[email protected]> Co-authored-by: trigger-github-actions[bot] <143469140+trigger-github-actions[bot]@users.noreply.github.com> Co-authored-by: Masaharu TASHIRO <[email protected]> Co-authored-by: Nguyen Thai Hung <[email protected]> Co-authored-by: Tuan Pham <[email protected]> Co-authored-by: trigger-github-actions-release[bot] <143469140+trigger-github-actions-release[bot]@users.noreply.github.com> Co-authored-by: tasshi / Masaharu Tashiro <[email protected]> Co-authored-by: nameless-mc <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

tasshi-me

差分大きいですが、 src/plugin/packer 配下はほぼ plugin-packer のファイルそのままです！

tasshi-me · 2024-10-24T19:22:10Z

jest.config.js

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


理想的には__tests__の中であっても*.tests.tsのみを試験対象にするように設定変更する方が良い
が、一旦決め打ちでhelpersを除外している。

tasshi-me · 2024-10-24T19:23:37Z

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",


node-rsaはLICENSEファイルがなく、READMEに直接ライセンス本文が書かれているため、license-managerで抽出できない。
そのためREADMEへのリンクを記載する。

tasshi-me · 2024-10-24T19:37:33Z

src/cli/main.ts

 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 })


describe: falseでコマンド非公開になる。

tasshi-me · 2024-10-24T19:43:29Z

src/cli/plugin/pack.ts

+  if (process.env.NODE_ENV === "test") {
+    console.log(JSON.stringify({ pluginDir: args.input, flags: flags }));


ここはplugin-packerの実装を踏襲

tasshi-me · 2024-10-24T19:45:56Z

src/cli/record/index.ts

plugin/index.tsと合わせてrecord/index.tsを置く構成に変更

tasshi-me · 2024-10-24T19:47:09Z

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

+// TODO: Remove this test file
+const execa = {} as ExecaMethod<{}>;
+
+describe.skip("bin", () => {


この試験はコマンドラインオプションの試験なので、一旦Skipにする。
（cli-kintone側のCLIが確定したら修正する）

shabaraba · 2024-10-25T00:58:35Z

src/cli/plugin/pack.ts

+  ReturnType<typeof builder> extends yargs.Argv<infer U> ? U : never
+>;
+
+const handler = async (args: Args) => {


今じゃなくて全然いいのですが、今後も開発中の機能で似たようなhandlerを作る事になりそうなので、
flagsとcallbackから開発中のhandlerを作れるような仕組みがあると良さそうに思いました。

後続の #916 で対応します！

shabaraba · 2024-10-25T01:05:34Z

src/plugin/packer/cli.ts

+  packerMock_: typeof packer;
+}>;
+
+const cli = (pluginDir: string, options_?: Options) => {


今回のPRのスコープ外と思いますが、メソッド名はrecordと合わせてrunとかのほうが良さそう？

後続の #916 で対応します！

tasshi-me · 2024-10-25T08:23:32Z

The Co-authored-by: list generated by GitHub has automatically removed duplicates.
I confirmed that all original contributors were included in the list before merging.

tasshi-me changed the title ~~demo: plugin-packer~~ demo: plugin pack command Oct 24, 2024

tasshi-me changed the title ~~demo: plugin pack command~~ proto: plugin pack command Oct 24, 2024

tasshi-me changed the title ~~proto: plugin pack command~~ proto: plugin pack command (Experimental) Oct 24, 2024

tasshi-me added 9 commits October 25, 2024 00:39

remove web app and JavaScript API

5c7ac1d

add dependencies

66b5699

create plugin pack command

07403eb

rename .spec.ts files to .test.ts

3fe9c41

resolve type errors

1eca354

make all tests pass

7751dce

fix some tests

7690f76

refactor directory structure

b99b87e

fix lint errors

4ba2157

tasshi-me changed the title ~~proto: plugin pack command (Experimental)~~ chore: plugin pack command (Experimental) Oct 24, 2024

tasshi-me changed the title ~~chore: plugin pack command (Experimental)~~ chore: add plugin pack command (Experimental) Oct 24, 2024

tasshi-me added 6 commits October 25, 2024 03:08

hide plugin command

bbf655f

flag as experimental

4a57cd7

exlude helpers from test target

ee82248

fix license text errors

809ec1a

make private-key option optional

c1c05db

rename option out to output

a8e6a7d

tasshi-me self-assigned this Oct 24, 2024

tasshi-me force-pushed the feat/plugin-packer branch from 26eebd7 to 9c9a9f2 Compare October 24, 2024 19:42

tasshi-me commented Oct 24, 2024

View reviewed changes

tasshi-me marked this pull request as ready for review October 24, 2024 19:54

tasshi-me requested a review from a team as a code owner October 24, 2024 19:54

tasshi-me requested review from chihiro-adachi and shabaraba and removed request for a team October 24, 2024 19:54

tasshi-me force-pushed the feat/plugin-packer branch from 9c9a9f2 to a8e6a7d Compare October 24, 2024 20:29

shabaraba reviewed Oct 25, 2024

View reviewed changes

shabaraba approved these changes Oct 25, 2024

View reviewed changes

tasshi-me merged commit 9d7ee6c into main Oct 25, 2024
66 checks passed

tasshi-me deleted the feat/plugin-packer branch October 25, 2024 08:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add plugin pack command (Experimental) #915

chore: add plugin pack command (Experimental) #915

tasshi-me commented Oct 24, 2024 •

edited

Loading

tasshi-me left a comment

tasshi-me Oct 24, 2024

tasshi-me Oct 24, 2024

tasshi-me Oct 24, 2024

tasshi-me Oct 24, 2024

tasshi-me Oct 24, 2024

tasshi-me Oct 24, 2024

shabaraba Oct 25, 2024

tasshi-me Oct 25, 2024

shabaraba Oct 25, 2024

tasshi-me Oct 25, 2024

tasshi-me commented Oct 25, 2024

		if (process.env.NODE_ENV === "test") {
		console.log(JSON.stringify({ pluginDir: args.input, flags: flags }));

chore: add plugin pack command (Experimental) #915

chore: add plugin pack command (Experimental) #915

Conversation

tasshi-me commented Oct 24, 2024 • edited Loading

Why

What

How to test

Checklist

tasshi-me left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tasshi-me commented Oct 25, 2024

tasshi-me commented Oct 24, 2024 •

edited

Loading