@hesed/mysql 0.5.0 → 0.5.1

package/README.md

@@ -26,7 +26,7 @@ $ npm install -g @hesed/mysql
 $ mq COMMAND
 running command...
 $ mq (--version)
-@hesed/mysql/0.5.0 linux-x64 node-v24.16.0
+@hesed/mysql/0.5.1 linux-x64 node-v24.17.0
 $ mq --help [COMMAND]
 USAGE
   $ mq COMMAND
@@ -80,7 +80,7 @@ EXAMPLES
   $ mq mysql auth add -p prod
 ```
 
-_See code: [src/commands/mysql/auth/add.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/auth/add.ts)_
+_See code: [src/commands/mysql/auth/add.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/add.ts)_
 
 ## `mq mysql auth delete`
 
@@ -105,7 +105,7 @@ EXAMPLES
   $ mq mysql auth delete -p prod
 ```
 
-_See code: [src/commands/mysql/auth/delete.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/auth/delete.ts)_
+_See code: [src/commands/mysql/auth/delete.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/delete.ts)_
 
 ## `mq mysql auth list`
 
@@ -125,7 +125,7 @@ EXAMPLES
   $ mq mysql auth list
 ```
 
-_See code: [src/commands/mysql/auth/list.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/auth/list.ts)_
+_See code: [src/commands/mysql/auth/list.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/list.ts)_
 
 ## `mq mysql auth profile`
 
@@ -150,7 +150,7 @@ EXAMPLES
   $ mq mysql auth profile --default test
 ```
 
-_See code: [src/commands/mysql/auth/profile.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/auth/profile.ts)_
+_See code: [src/commands/mysql/auth/profile.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/profile.ts)_
 
 ## `mq mysql auth test`
 
@@ -175,7 +175,7 @@ EXAMPLES
   $ mq mysql auth test -p prod
 ```
 
-_See code: [src/commands/mysql/auth/test.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/auth/test.ts)_
+_See code: [src/commands/mysql/auth/test.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/test.ts)_
 
 ## `mq mysql auth update`
 
@@ -207,7 +207,7 @@ EXAMPLES
   $ mq mysql auth update -p test
 ```
 
-_See code: [src/commands/mysql/auth/update.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/auth/update.ts)_
+_See code: [src/commands/mysql/auth/update.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/auth/update.ts)_
 
 ## `mq mysql databases`
 
@@ -215,11 +215,14 @@ List all databases accessible on the MySQL server
 
 ```
 USAGE
-  $ mq mysql databases [-p <value>]
+  $ mq mysql databases [--json] [-p <value>]
 
 FLAGS
   -p, --profile=<value>  Database profile name from config
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   List all databases accessible on the MySQL server
 
@@ -229,7 +232,7 @@ EXAMPLES
   $ mq mysql databases -p staging
 ```
 
-_See code: [src/commands/mysql/databases.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/databases.ts)_
+_See code: [src/commands/mysql/databases.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/databases.ts)_
 
 ## `mq mysql describe-table TABLE`
 
@@ -237,7 +240,7 @@ Describe the structure of a MySQL table
 
 ```
 USAGE
-  $ mq mysql describe-table TABLE [--format table|json|toon] [-p <value>]
+  $ mq mysql describe-table TABLE [--json] [--format table|json|toon] [-p <value>]
 
 ARGUMENTS
   TABLE  Table name to describe
@@ -247,6 +250,9 @@ FLAGS
       --format=<option>  [default: table] Output format
                          <options: table|json|toon>
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   Describe the structure of a MySQL table
 
@@ -256,7 +262,7 @@ EXAMPLES
   $ mq mysql describe-table orders --format json -p prod
 ```
 
-_See code: [src/commands/mysql/describe-table.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/describe-table.ts)_
+_See code: [src/commands/mysql/describe-table.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/describe-table.ts)_
 
 ## `mq mysql explain-query QUERY`
 
@@ -264,7 +270,7 @@ Show the execution plan for a MySQL query
 
 ```
 USAGE
-  $ mq mysql explain-query QUERY [--format table|json|toon] [-p <value>]
+  $ mq mysql explain-query QUERY [--json] [--format table|json|toon] [-p <value>]
 
 ARGUMENTS
   QUERY  SQL query to explain
@@ -274,6 +280,9 @@ FLAGS
       --format=<option>  [default: table] Output format
                          <options: table|json|toon>
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   Show the execution plan for a MySQL query
 
@@ -283,7 +292,7 @@ EXAMPLES
   $ mq mysql explain-query "SELECT * FROM orders JOIN users ON orders.user_id = users.id" --format json
 ```
 
-_See code: [src/commands/mysql/explain-query.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/explain-query.ts)_
+_See code: [src/commands/mysql/explain-query.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/explain-query.ts)_
 
 ## `mq mysql indexes TABLE`
 
@@ -291,7 +300,7 @@ Show indexes for a MySQL table
 
 ```
 USAGE
-  $ mq mysql indexes TABLE [--format table|json|toon] [-p <value>]
+  $ mq mysql indexes TABLE [--json] [--format table|json|toon] [-p <value>]
 
 ARGUMENTS
   TABLE  Table name to show indexes for
@@ -301,6 +310,9 @@ FLAGS
       --format=<option>  [default: table] Output format
                          <options: table|json|toon>
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   Show indexes for a MySQL table
 
@@ -310,7 +322,7 @@ EXAMPLES
   $ mq mysql indexes orders --format json -p prod
 ```
 
-_See code: [src/commands/mysql/indexes.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/indexes.ts)_
+_See code: [src/commands/mysql/indexes.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/indexes.ts)_
 
 ## `mq mysql query QUERY`
 
@@ -318,7 +330,7 @@ Execute a SQL query against a MySQL database
 
 ```
 USAGE
-  $ mq mysql query QUERY [--format table|json|csv|toon] [-p <value>] [--skip-confirmation]
+  $ mq mysql query QUERY [--json] [--format table|json|csv|toon] [-p <value>] [--skip-confirmation]
 
 ARGUMENTS
   QUERY  SQL query to execute
@@ -329,6 +341,9 @@ FLAGS
                            <options: table|json|csv|toon>
       --skip-confirmation  Skip confirmation prompt for destructive operations
 
+GLOBAL FLAGS
+  --json  Format output as json.
+
 DESCRIPTION
   Execute a SQL query against a MySQL database
 
@@ -340,7 +355,7 @@ EXAMPLES
   $ mq mysql query "DELETE FROM sessions" -p prod --skip-confirmation
 ```
 
-_See code: [src/commands/mysql/query.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/query.ts)_
+_See code: [src/commands/mysql/query.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/query.ts)_
 
 ## `mq mysql tables`
 
@@ -362,5 +377,5 @@ EXAMPLES
   $ mq mysql tables -p local
 ```
 
-_See code: [src/commands/mysql/tables.ts](https://github.com/hesedcasa/mysql/blob/v0.5.0/src/commands/mysql/tables.ts)_
+_See code: [src/commands/mysql/tables.ts](https://github.com/hesedcasa/mysql/blob/v0.5.1/src/commands/mysql/tables.ts)_
 <!-- commandsstop -->

package/dist/base-command.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export declare abstract class BaseCommand extends Command {
+    static enableJsonFlag: boolean;
+    jsonEnabled(): boolean;
+    protected parse(options?: any, argv?: string[]): Promise<any>;
+    protected parseJsonOutput(output?: string): unknown;
+    protected toErrorJson(err: unknown): {
+        error: string;
+    };
+    private formatFlagValue;
+    private hasFormatFlag;
+}

package/dist/base-command.js

@@ -0,0 +1,50 @@
+import { Command } from '@oclif/core';
+export class BaseCommand extends Command {
+    static enableJsonFlag = true;
+    jsonEnabled() {
+        const separatorIndex = this.argv.indexOf('--');
+        const flagArgs = separatorIndex === -1 ? this.argv : this.argv.slice(0, separatorIndex);
+        if (this.hasFormatFlag(flagArgs))
+            return this.formatFlagValue(flagArgs) === 'json';
+        return flagArgs.includes('--json');
+    }
+    // oclif sets this.parsed=true only after Parser.parse() returns successfully.
+    // When parse() throws (e.g. missing required arg), this.parsed stays false and
+    // _run() emits an UnparsedCommand warning. The finally block prevents that.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async parse(options, argv) {
+        try {
+            return await super.parse(options, argv);
+        }
+        finally {
+            this.parsed = true;
+        }
+    }
+    parseJsonOutput(output) {
+        if (!output)
+            return null;
+        try {
+            return JSON.parse(output);
+        }
+        catch {
+            return output;
+        }
+    }
+    // oclif's default toErrorJson returns the raw error object which for
+    // CLIParseError includes context:this (the full config). Strip it down.
+    toErrorJson(err) {
+        const message = err instanceof Error ? err.message : String(err);
+        return { error: message };
+    }
+    formatFlagValue(flagArgs) {
+        for (const [index, arg] of flagArgs.entries()) {
+            if (arg === '--format')
+                return flagArgs[index + 1];
+            if (arg.startsWith('--format='))
+                return arg.slice('--format='.length);
+        }
+    }
+    hasFormatFlag(flagArgs) {
+        return flagArgs.some((arg) => arg === '--format' || arg.startsWith('--format='));
+    }
+}

package/dist/commands/mysql/databases.d.ts

@@ -1,9 +1,11 @@
 import { Command } from '@oclif/core';
 export default class MySQLDatabases extends Command {
     static description: string;
+    static enableJsonFlag: boolean;
     static examples: string[];
     static flags: {
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    run(): Promise<void>;
+    jsonEnabled(): boolean;
+    run(): Promise<string[]>;
 }

package/dist/commands/mysql/databases.js

@@ -2,19 +2,21 @@ import { Command, Flags } from '@oclif/core';
 import { closeConnections, listDatabases } from '../../mysql/index.js';
 export default class MySQLDatabases extends Command {
     static description = 'List all databases accessible on the MySQL server';
+    static enableJsonFlag = true;
     static examples = ['<%= config.bin %> <%= command.id %>', '<%= config.bin %> <%= command.id %> -p staging'];
     static flags = {
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
     };
+    jsonEnabled() {
+        return true;
+    }
     async run() {
         const { flags } = await this.parse(MySQLDatabases);
         const result = await listDatabases(this.config, flags.profile);
         await closeConnections();
         if (result.success) {
-            this.logJson(result.databases);
-        }
-        else {
-            this.error(result.error ?? 'Failed to list databases');
+            return result.databases ?? [];
         }
+        this.error(result.error ?? 'Failed to list databases');
     }
 }

package/dist/commands/mysql/describe-table.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@oclif/core';
-export default class MySQLDescribeTable extends Command {
+import { BaseCommand } from '../../base-command.js';
+export default class MySQLDescribeTable extends BaseCommand {
     static args: {
         table: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
@@ -9,5 +9,5 @@ export default class MySQLDescribeTable extends Command {
         format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    run(): Promise<void>;
+    run(): Promise<unknown>;
 }

package/dist/commands/mysql/describe-table.js

@@ -1,6 +1,7 @@
-import { Args, Command, Flags } from '@oclif/core';
+import { Args, Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
 import { closeConnections, describeTable } from '../../mysql/index.js';
-export default class MySQLDescribeTable extends Command {
+export default class MySQLDescribeTable extends BaseCommand {
     static args = {
         table: Args.string({ description: 'Table name to describe', required: true }),
     };
@@ -23,9 +24,8 @@ export default class MySQLDescribeTable extends Command {
         await closeConnections();
         if (result.success) {
             this.log(result.result ?? '');
+            return result;
         }
-        else {
-            this.error(result.error ?? 'Failed to describe table');
-        }
+        this.error(result.error ?? 'Failed to describe table');
     }
 }

package/dist/commands/mysql/explain-query.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@oclif/core';
-export default class MySQLExplain extends Command {
+import { BaseCommand } from '../../base-command.js';
+export default class MySQLExplain extends BaseCommand {
     static args: {
         query: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
@@ -9,5 +9,5 @@ export default class MySQLExplain extends Command {
         format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    run(): Promise<void>;
+    run(): Promise<unknown>;
 }

package/dist/commands/mysql/explain-query.js

@@ -1,6 +1,7 @@
-import { Args, Command, Flags } from '@oclif/core';
+import { Args, Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
 import { closeConnections, explainQuery } from '../../mysql/index.js';
-export default class MySQLExplain extends Command {
+export default class MySQLExplain extends BaseCommand {
     static args = {
         query: Args.string({ description: 'SQL query to explain', required: true }),
     };
@@ -23,9 +24,8 @@ export default class MySQLExplain extends Command {
         await closeConnections();
         if (result.success) {
             this.log(result.result ?? '');
+            return result;
         }
-        else {
-            this.error(result.error ?? 'Failed to explain query');
-        }
+        this.error(result.error ?? 'Failed to explain query');
     }
 }

package/dist/commands/mysql/indexes.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@oclif/core';
-export default class MySQLIndexes extends Command {
+import { BaseCommand } from '../../base-command.js';
+export default class MySQLIndexes extends BaseCommand {
     static args: {
         table: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
@@ -9,5 +9,5 @@ export default class MySQLIndexes extends Command {
         format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    run(): Promise<void>;
+    run(): Promise<unknown>;
 }

package/dist/commands/mysql/indexes.js

@@ -1,6 +1,7 @@
-import { Args, Command, Flags } from '@oclif/core';
+import { Args, Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
 import { closeConnections, showIndexes } from '../../mysql/index.js';
-export default class MySQLIndexes extends Command {
+export default class MySQLIndexes extends BaseCommand {
     static args = {
         table: Args.string({ description: 'Table name to show indexes for', required: true }),
     };
@@ -23,9 +24,8 @@ export default class MySQLIndexes extends Command {
         await closeConnections();
         if (result.success) {
             this.log(result.result ?? '');
+            return result;
         }
-        else {
-            this.error(result.error ?? 'Failed to show indexes');
-        }
+        this.error(result.error ?? 'Failed to show indexes');
     }
 }

package/dist/commands/mysql/query.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@oclif/core';
-export default class MySQLQuery extends Command {
+import { BaseCommand } from '../../base-command.js';
+export default class MySQLQuery extends BaseCommand {
     static args: {
         query: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
@@ -10,5 +10,5 @@ export default class MySQLQuery extends Command {
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'skip-confirmation': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<void>;
+    run(): Promise<unknown>;
 }

package/dist/commands/mysql/query.js

@@ -1,6 +1,7 @@
-import { Args, Command, Flags } from '@oclif/core';
+import { Args, Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
 import { closeConnections, executeQuery } from '../../mysql/index.js';
-export default class MySQLQuery extends Command {
+export default class MySQLQuery extends BaseCommand {
     static args = {
         query: Args.string({ description: 'SQL query to execute', required: true }),
     };
@@ -31,13 +32,15 @@ export default class MySQLQuery extends Command {
             // leave stdout as clean, parseable data.
             if (result.notices)
                 this.logToStderr(result.notices);
+            if (this.jsonEnabled())
+                return this.parseJsonOutput(result.result);
             this.log(result.result ?? '');
+            return result;
         }
-        else if (result.requiresConfirmation) {
+        if (result.requiresConfirmation) {
             this.log(`${result.message ?? 'Destructive operation requires confirmation.'}\nRe-run with --skip-confirmation to proceed.`);
+            return result;
         }
-        else {
-            this.error(result.error ?? 'Query failed');
-        }
+        this.error(result.error ?? 'Query failed');
     }
 }

package/dist/commands/mysql/tables.d.ts

@@ -5,5 +5,6 @@ export default class MySQLTables extends Command {
     static flags: {
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    run(): Promise<void>;
+    jsonEnabled(): boolean;
+    run(): Promise<string[]>;
 }

package/dist/commands/mysql/tables.js

@@ -6,15 +6,16 @@ export default class MySQLTables extends Command {
     static flags = {
         profile: Flags.string({ char: 'p', description: 'Database profile name from config', required: false }),
     };
+    jsonEnabled() {
+        return true;
+    }
     async run() {
         const { flags } = await this.parse(MySQLTables);
         const result = await listTables(this.config, flags.profile);
         await closeConnections();
         if (result.success) {
-            this.logJson(result.tables);
-        }
-        else {
-            this.error(result.error ?? 'Failed to list tables');
+            return result.tables ?? [];
         }
+        this.error(result.error ?? 'Failed to list tables');
     }
 }

package/oclif.manifest.json

@@ -9,6 +9,13 @@
         "<%= config.bin %> <%= command.id %> -p staging"
       ],
       "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "profile": {
           "char": "p",
           "description": "Database profile name from config",
@@ -26,7 +33,7 @@
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -50,6 +57,13 @@
         "<%= config.bin %> <%= command.id %> orders --format json -p prod"
       ],
       "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "format": {
           "description": "Output format",
           "name": "format",
@@ -80,7 +94,7 @@
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -104,6 +118,13 @@
         "<%= config.bin %> <%= command.id %> \"SELECT * FROM orders JOIN users ON orders.user_id = users.id\" --format json"
       ],
       "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "format": {
           "description": "Output format",
           "name": "format",
@@ -134,7 +155,7 @@
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -158,6 +179,13 @@
         "<%= config.bin %> <%= command.id %> orders --format json -p prod"
       ],
       "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "format": {
           "description": "Output format",
           "name": "format",
@@ -188,7 +216,7 @@
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -213,6 +241,13 @@
         "<%= config.bin %> <%= command.id %> \"DELETE FROM sessions\" -p prod --skip-confirmation"
       ],
       "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "format": {
           "description": "Output format",
           "name": "format",
@@ -250,7 +285,7 @@
       "pluginName": "@hesed/mysql",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -640,5 +675,5 @@
       ]
     }
   },
-  "version": "0.5.0"
+  "version": "0.5.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hesed/mysql",
   "description": "CLI for MySQL database interaction",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "author": "Hesed",
   "bin": {
     "mq": "./bin/run.js"