proteum 2.1.0 → 2.1.2

package/cli/runtime/commands.ts

@@ -9,15 +9,71 @@ class InitCommand extends ProteumCommand {
 
     public static usage = buildUsage('init');
 
-    public legacyArgs = Option.Rest();
+    public name = Option.String('--name', { description: 'Human-readable app name.' });
+    public description = Option.String('--description', { description: 'App description used in identity.yaml and package.json.' });
+    public identifier = Option.String('--identifier', { description: 'Application class and identity identifier.' });
+    public port = Option.String('--port', { description: 'Default local router port used in .env.' });
+    public url = Option.String('--url', { description: 'Default absolute URL used in .env.' });
+    public proteumVersion = Option.String('--proteum-version', {
+        description: 'Override the Proteum dependency written to package.json.',
+    });
+    public install = Option.Boolean('--install', false, { description: 'Run npm install after scaffolding.' });
+    public dryRun = Option.Boolean('--dry-run', false, { description: 'Print the scaffold plan without writing files.' });
+    public json = Option.Boolean('--json', false, { description: 'Print machine-readable scaffold output.' });
+    public force = Option.Boolean('--force', false, { description: 'Allow writing into a non-empty target directory.' });
+    public args = Option.Rest();
 
     public async execute() {
-        assertNoLegacyArgs('init', this.legacyArgs);
-        this.setCliArgs();
+        const [directory = ''] = this.args;
+
+        this.setCliArgs({
+            directory,
+            name: this.name ?? '',
+            description: this.description ?? '',
+            identifier: this.identifier ?? '',
+            port: this.port ?? '',
+            url: this.url ?? '',
+            proteumVersion: this.proteumVersion ?? '',
+            install: this.install,
+            dryRun: this.dryRun,
+            json: this.json,
+            force: this.force,
+        });
         await runCommandModule(() => import('../commands/init'));
     }
 }
 
+class CreateCommand extends ProteumCommand {
+    public static paths = [['create']];
+
+    public static usage = buildUsage('create');
+
+    public route = Option.String('--route', { description: 'Explicit URL path used for page or route scaffolds.' });
+    public method = Option.String('--method', { description: 'Method name used for controller or command scaffolds.' });
+    public httpMethod = Option.String('--http-method', { description: 'HTTP verb used for route scaffolds.' });
+    public json = Option.Boolean('--json', false, { description: 'Print machine-readable scaffold output.' });
+    public dryRun = Option.Boolean('--dry-run', false, { description: 'Print the scaffold plan without writing files.' });
+    public force = Option.Boolean('--force', false, { description: 'Allow overwriting generated target files.' });
+    public args = Option.Rest();
+
+    public async execute() {
+        const [kind = '', target = ''] = this.args;
+
+        this.setCliArgs({
+            kind,
+            target,
+            route: this.route ?? '',
+            method: this.method ?? '',
+            httpMethod: this.httpMethod ?? '',
+            json: this.json,
+            dryRun: this.dryRun,
+            force: this.force,
+        });
+
+        await runCommandModule(() => import('../commands/create'));
+    }
+}
+
 class DevCommand extends ProteumCommand {
     public static paths = [['dev']];
 
@@ -153,6 +209,7 @@ class ExplainCommand extends ProteumCommand {
     public env = Option.Boolean('--env', false, { description: 'Include the env section.' });
     public services = Option.Boolean('--services', false, { description: 'Include the services section.' });
     public controllers = Option.Boolean('--controllers', false, { description: 'Include the controllers section.' });
+    public commands = Option.Boolean('--commands', false, { description: 'Include the commands section.' });
     public routes = Option.Boolean('--routes', false, { description: 'Include the routes section.' });
     public layouts = Option.Boolean('--layouts', false, { description: 'Include the layouts section.' });
     public diagnostics = Option.Boolean('--diagnostics', false, {
@@ -169,6 +226,7 @@ class ExplainCommand extends ProteumCommand {
             env: this.env,
             services: this.services,
             controllers: this.controllers,
+            commands: this.commands,
             routes: this.routes,
             layouts: this.layouts,
             diagnostics: this.diagnostics,
@@ -177,7 +235,7 @@ class ExplainCommand extends ProteumCommand {
         applyLegacyBooleanArgs(
             'explain',
             this.legacyArgs,
-            ['json', 'all', 'app', 'conventions', 'env', 'services', 'controllers', 'routes', 'layouts', 'diagnostics'],
+            ['json', 'all', 'app', 'conventions', 'env', 'services', 'controllers', 'commands', 'routes', 'layouts', 'diagnostics'],
             args,
         );
         this.setCliArgs(args);
@@ -185,8 +243,62 @@ class ExplainCommand extends ProteumCommand {
     }
 }
 
+class TraceCommand extends ProteumCommand {
+    public static paths = [['trace']];
+
+    public static usage = buildUsage('trace');
+
+    public port = Option.String('--port', { description: 'Override the router port used to query the running dev server.' });
+    public url = Option.String('--url', { description: 'Override the full base URL used to query the running dev server.' });
+    public json = Option.Boolean('--json', false, { description: 'Print JSON output.' });
+    public capture = Option.String('--capture', { description: 'Capture mode used by `proteum trace arm`.' });
+    public output = Option.String('--output', { description: 'Output filepath used by `proteum trace export`.' });
+    public args = Option.Rest();
+
+    public async execute() {
+        const [action = 'latest', id = ''] = this.args;
+
+        this.setCliArgs({
+            action,
+            id,
+            port: this.port ?? '',
+            url: this.url ?? '',
+            json: this.json,
+            capture: this.capture ?? '',
+            output: this.output ?? '',
+        });
+
+        await runCommandModule(() => import('../commands/trace'));
+    }
+}
+
+class CommandCommand extends ProteumCommand {
+    public static paths = [['command']];
+
+    public static usage = buildUsage('command');
+
+    public port = Option.String('--port', { description: 'Target an existing dev server on the given port.' });
+    public url = Option.String('--url', { description: 'Target an existing dev server at the given base URL.' });
+    public json = Option.Boolean('--json', false, { description: 'Print JSON output.' });
+    public args = Option.Rest();
+
+    public async execute() {
+        const [path = ''] = this.args;
+
+        this.setCliArgs({
+            path,
+            port: this.port ?? '',
+            url: this.url ?? '',
+            json: this.json,
+        });
+
+        await runCommandModule(() => import('../commands/command'));
+    }
+}
+
 export const registeredCommands = {
     init: InitCommand,
+    create: CreateCommand,
     dev: DevCommand,
     refresh: RefreshCommand,
     build: BuildCommand,
@@ -195,6 +307,8 @@ export const registeredCommands = {
     check: CheckCommand,
     doctor: DoctorCommand,
     explain: ExplainCommand,
+    trace: TraceCommand,
+    command: CommandCommand,
 } as const;
 
 export const createCli = (version: string) => {
@@ -208,6 +322,7 @@ export const createCli = (version: string) => {
     clipanion.register(Builtins.VersionCommand);
     clipanion.register(Builtins.DefinitionsCommand);
     clipanion.register(InitCommand);
+    clipanion.register(CreateCommand);
     clipanion.register(DevCommand);
     clipanion.register(RefreshCommand);
     clipanion.register(BuildCommand);
@@ -216,6 +331,8 @@ export const createCli = (version: string) => {
     clipanion.register(CheckCommand);
     clipanion.register(DoctorCommand);
     clipanion.register(ExplainCommand);
+    clipanion.register(TraceCommand);
+    clipanion.register(CommandCommand);
 
     return clipanion;
 };