moonbitstack/moonctl/plugin

README
U
Bind
U
Command
U
Config
U
DataSource
U
DataSourceError
U
DdlColumn
U
DdlTable
U
Diagnostic
U
DocVersion
U
Field
U
FuncFn
U
GatewayRoute
U
GenFile
U
Group
U
Label
U
Lang
U
PgTarget
U
Plugin
U
Proto
U
ProtoEnum
U
ProtoEnumValue
U
ProtoField
U
ProtoMessage
U
ProtoOneof
U
ProtoService
U
Range
U
ReflectedColumn
U
Regen
U
Route
U
Rpc
U
Severity
U
Spec
U
SpecError
U
Style
U
StyleError
U
Template
U
TemplateEntry
U
TemplateError
U
TreeFile
U
TypeDef
U
Value
V
bug_report
V
cache_file_name
V
client_file
V
client_file_name
V
command_names
V
commands
V
completion
V
config_get
V
config_keys
V
config_set
V
config_text
V
default_config
V
default_routes
V
deps
V
env_report
V
find_template
V
format
V
gateway_file_name
V
gen_files_to_json
V
generate
V
generate_agent
V
generate_cached
V
generate_client
V
generate_crud
V
generate_crud_from_ddl
V
generate_crud_from_reflection
V
generate_doc
V
generate_gateway
V
generate_gql
V
generate_gql_tree
V
generate_grpc
V
generate_markdown
V
generate_mcp_tree
V
generate_migrations
V
generate_model
V
generate_mongo
V
generate_rpc_tree
V
generate_tree
V
generate_with
V
has_errors
V
has_method
V
markdown_file_name
V
migrate_config
V
migrate_file_name
V
mod_pins
V
mongo_file_name
V
openapi_document
V
parse
V
parse_all
V
parse_config
V
parse_ddl
V
parse_dsn
V
parse_gen_files
V
parse_lenient
V
parse_proto
V
parse_route_map
V
pin_module
V
pinned_version
V
pins
V
plugin_argv
V
plugin_from_json
V
plugin_plan
V
plugin_request
V
port
V
proto_reserved_conflicts
V
render
V
resolve_import
V
safe_path
V
scaffold_api
V
scaffold_docker
V
scaffold_gql
V
scaffold_kube
V
scaffold_mcp
V
scaffold_model
V
scaffold_rpc
V
spec_from_json
V
spec_to_json
V
spec_to_value
V
subcommands
V
swagger_ui_stub
V
tables_from_reflection
V
template_detail
V
template_table
V
templates
V
templates_of
V
tree_plan
V
upgrade_pins
V
usage_text
V
validate
V
validate_files
V
validate_source

moonbitstack/moonctl/plugin does not have a README file

GenFile

pub(all) struct GenFile {
  path : String
  content : String
}

One file a plugin asks mctl to write: a destination path (relative to the output directory) and its full content.

Plugin

source

pub(all) struct Plugin {
  api : @moonbitstack/moonctl/api.Spec
Spec
  api_file_path : String
  style : String
  dir : String
}

What a plugin is handed on stdin (← goctl's plugin.Plugin): the parsed spec under api, the .api file it was read from, the --style naming template, and the directory the generated tree goes under.

gen_files_to_json

source

fn gen_files_to_json(files : Array[GenFile]) -> Json

Serialise a list of generated files into the plugin-reply JSON — the writer a MoonBit plugin uses on its stdout. Emits the {"files": [...]} envelope.

parse_gen_files

source

fn parse_gen_files(j : Json) -> Array[GenFile]

Parse a plugin's stdout into the files to write. Two shapes are accepted: a bare array [{path, content}, …], or an object {"files": [ … ]} (goctl-style envelope). An element missing path or content is skipped. The list preserves the plugin's order.

plugin_argv

source

fn plugin_argv(invocation : String) -> (String, Array[String])

Split a plugin invocation into the program to run and the arguments to run it with, the way goctl reads its -plugin value: the first whitespace-separated word is the executable, the rest are its argv. A quoted word keeps its spaces.

plugin_from_json

source

fn plugin_from_json(j : Json) -> Plugin

Read the request a plugin was handed on stdin. Missing members degrade to empty rather than raising, so a hand-written request still parses.

plugin_plan

source

fn plugin_plan(files : Array[GenFile]) -> (Array[GenFile], Array[String])

What a plugin run will actually write: the files whose path is safe, and a note per file that was refused or superseded. A later file for a path an earlier one already claimed is refused rather than silently overwriting it — a plugin that emits the same file twice has a bug, and the report should say so rather than leave a coin-flip in the output.

plugin_request

source

fn plugin_request(spec : @moonbitstack/moonctl/api.Spec
Spec, api_file_path? : String, style? : String, dir? : String) -> String

The plugin request as a two-space-indented JSON string, ready to write to the plugin's stdin: goctl's four keys — the spec under Api, plus the file it was read from, the --style template and the output directory, which is everything a plugin needs to decide where its output goes and what to call it.

safe_path

source

fn safe_path(path : String) -> Bool

Whether a path a plugin supplies lands inside the directory mctl writes to. A plugin runs as its own process and its reply is arbitrary text, so the one thing mctl must not do is believe it: ../../.ssh/authorized_keys, /etc/passwd and C:/Windows/system32/… are all accepted by a naive writer, and all three write where a code generator has no business writing. Only a relative path with no .. segment is allowed; a path with one is refused and named in the run's report.

spec_from_json

source

fn spec_from_json(j : Json) -> @moonbitstack/moonctl/api.Spec
Spec

Reconstruct a Spec from the request JSON — the reader a plugin written in MoonBit uses on its stdin. The whole request ({Api, ApiFilePath, Style, Dir}) and a bare spec are both accepted, so a plugin that wants nothing but the routes need not unwrap the envelope. Missing or mistyped members degrade to empty rather than raising, so a partial request still parses.

spec_to_json

source

fn spec_to_json(spec : @moonbitstack/moonctl/api.Spec
Spec) -> Json

Serialise a Spec into the plugin request JSON. The shape mirrors the Spec itself — service, routes (verb/path/handler/summary, plus the group the route was declared under), types (name plus fields of name/type) and groups — so a plugin in any language parses it with an ordinary JSON reader. type_ is written as type, the name a caller expects.