Files
larksuite-cli/shortcuts/apps/plugin_instance_list.go
anguohui e9f2da086f feat: add plugin package and instance management commands for apps domain
Add 8 new shortcut commands under `lark-cli apps`:

Plugin package management (aligned with fullstack-cli):
- +plugin-install: download tgz, extract to node_modules, update package.json
- +plugin-uninstall: remove from node_modules and package.json actionPlugins
- +plugin-list: list declared plugins with installation status

Plugin instance CRUD (aligned with feida-ai):
- +plugin-instance-create: validate + write capability JSON with formValue validation
- +plugin-instance-update: merge mutable fields, re-validate formValue
- +plugin-instance-delete: idempotent file removal
- +plugin-instance-get: read capability JSON
- +plugin-instance-list: scan capabilities directory

Shared infrastructure (plugin_common.go):
- 4-level capabilities dir resolution (flag → env → .env.local MIAODA_APP_TYPE → detection)
- formValue validation ported from feida-ai (5 rules: forbidden Handlebars, paramsSchema
  type constraints, input ref existence, unconsumed params, array double-wrap auto-fix)
- tgz extraction with path traversal protection
- package.json actionPlugins management
- Install version check with mismatch warnings
2026-06-18 16:10:47 +08:00

95 lines
2.8 KiB
Go

// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package apps
import (
"context"
"fmt"
"io"
"github.com/larksuite/cli/internal/output"
"github.com/larksuite/cli/shortcuts/common"
)
// AppsPluginInstanceList lists all plugin instances (capability JSON files)
// in the resolved capabilities directory.
var AppsPluginInstanceList = common.Shortcut{
Service: appsService,
Command: "+plugin-instance-list",
Description: "List all plugin instances in the project",
Risk: "read",
Flags: []common.Flag{
{Name: "summary", Type: "bool", Desc: "show only id and name"},
{Name: "project-path", Desc: "project root path (defaults to current directory)"},
{Name: "capabilities-dir", Desc: "explicit capabilities directory (relative to project or absolute)"},
},
DryRun: func(ctx context.Context, rctx *common.RuntimeContext) *common.DryRunAPI {
return common.NewDryRunAPI().
Desc("List plugin instances (scan capabilities directory)").
Set("action", "list").
Set("summary", fmt.Sprintf("%v", rctx.Bool("summary")))
},
Validate: func(ctx context.Context, rctx *common.RuntimeContext) error {
projectPath, err := pluginResolveProjectPath(rctx.Str("project-path"))
if err != nil {
return err
}
return pluginCheckProjectDir(projectPath)
},
Execute: func(ctx context.Context, rctx *common.RuntimeContext) error {
projectPath, err := pluginResolveProjectPath(rctx.Str("project-path"))
if err != nil {
return err
}
capDir, err := pluginResolveCapDir(projectPath, rctx.Str("capabilities-dir"))
if err != nil {
// Cannot determine capabilities dir → no instances exist yet.
rctx.OutFormat(
map[string]interface{}{"instances": []interface{}{}},
&output.Meta{Count: 0},
func(w io.Writer) { fmt.Fprintln(w, "No plugin instances found.") },
)
return nil
}
caps, err := pluginListCapabilities(capDir)
if err != nil {
return err
}
summary := rctx.Bool("summary")
instances := make([]interface{}, 0, len(caps))
for _, cap := range caps {
if summary {
instances = append(instances, map[string]interface{}{
"id": cap["id"],
"name": cap["name"],
})
} else {
instances = append(instances, cap)
}
}
data := map[string]interface{}{"instances": instances}
rctx.OutFormat(data, &output.Meta{Count: len(instances)}, func(w io.Writer) {
if len(instances) == 0 {
fmt.Fprintln(w, "No plugin instances found.")
return
}
rows := make([]map[string]interface{}, 0, len(caps))
for _, cap := range caps {
rows = append(rows, map[string]interface{}{
"id": cap["id"],
"pluginKey": cap["pluginKey"],
"pluginVersion": cap["pluginVersion"],
"name": cap["name"],
})
}
output.PrintTable(w, rows)
})
return nil
},
}