@cenk1cenk2/oclif-common 3.5.1 → 3.5.3

package/dist/hooks/index.js

@@ -113,6 +113,9 @@ var Logger = class {
   end(data, ...args) {
     return this.parseMessage("INFO" /* INFO */, data, args, { status: "END" /* END */ });
   }
+  stage(data, ...args) {
+    return this.parseMessage("TRACE" /* TRACE */, data, args, { status: "STAGE" /* STAGE */ });
+  }
   initiateLogger() {
     const logFormat = import_winston.format.printf(({ level, message, context, status }) => {
       let multiLineMessage;

package/dist/hooks/not-found.hook.js

@@ -109,6 +109,9 @@ var Logger = class {
   end(data, ...args) {
     return this.parseMessage("INFO" /* INFO */, data, args, { status: "END" /* END */ });
   }
+  stage(data, ...args) {
+    return this.parseMessage("TRACE" /* TRACE */, data, args, { status: "STAGE" /* STAGE */ });
+  }
   initiateLogger() {
     const logFormat = import_winston.format.printf(({ level, message, context, status }) => {
       let multiLineMessage;

package/dist/hooks/store.hook.js

@@ -115,6 +115,9 @@ var Logger = class {
   end(data, ...args) {
     return this.parseMessage("INFO" /* INFO */, data, args, { status: "END" /* END */ });
   }
+  stage(data, ...args) {
+    return this.parseMessage("TRACE" /* TRACE */, data, args, { status: "STAGE" /* STAGE */ });
+  }
   initiateLogger() {
     const logFormat = import_winston.format.printf(({ level, message, context, status }) => {
       let multiLineMessage;

package/dist/index.d.ts

@@ -10,6 +10,13 @@ import { ClassTransformOptions } from 'class-transformer';
 import { ValidatorOptions } from 'class-validator';
 import { InferredFlags, FlagInput } from '@oclif/core/lib/interfaces';
 export { Arg, ArgInput, Flag, FlagInput, InferredFlags } from '@oclif/core/lib/interfaces';
+import * as _oclif_core_lib_cli_ux_styled_progress from '@oclif/core/lib/cli-ux/styled/progress';
+import * as _oclif_core_lib_cli_ux_open from '@oclif/core/lib/cli-ux/open';
+import * as _oclif_core_lib_cli_ux_styled_tree from '@oclif/core/lib/cli-ux/styled/tree';
+import * as _oclif_core_lib_cli_ux_styled_json from '@oclif/core/lib/cli-ux/styled/json';
+import * as _oclif_core_lib_cli_ux_styled_header from '@oclif/core/lib/cli-ux/styled/header';
+import * as _oclif_core_lib_cli_ux_prompt from '@oclif/core/lib/cli-ux/prompt';
+import * as _oclif_core_lib_errors from '@oclif/core/lib/errors';
 export { notFoundHook } from './hooks/not-found.hook.js';
 export { updateNotifierHook } from './hooks/update-notifier.hook.js';
 import { ExecaChildProcess } from 'execa';
@@ -30,7 +37,10 @@ declare enum LogLevels {
 }
 declare enum LogFieldStatus {
     RUN = "RUN",
-    END = "END"
+    END = "END",
+    STAGE = "STAGE",
+    EXIT = "EXIT",
+    TERMINATE = "TERMINATE"
 }
 
 interface LoggerOptions {
@@ -65,6 +75,7 @@ declare class Logger {
     trace(data: string | Buffer, ...args: any): void;
     run(data: string | Buffer, ...args: any): void;
     end(data: string | Buffer, ...args: any): void;
+    stage(data: string | Buffer, ...args: any): void;
     private initiateLogger;
     private parseMessage;
     private logColoring;
@@ -298,7 +309,7 @@ declare type DeepPartial<T> = {
 };
 
 declare class Command<Ctx extends ListrContext = ListrContext, Flags extends Record<PropertyKey, any> = InferFlags<typeof Command>, Args extends Record<PropertyKey, any> = InferArgs<typeof Command>, Store extends Record<PropertyKey, any> = Record<PropertyKey, any>> extends Command$1 {
-    static globalFlags: FlagInput;
+    static globalFlags: object;
     logger: Logger;
     tasks: Manager<Ctx, 'default' | 'verbose' | 'silent' | 'simple'>;
     validator: ValidatorService;
@@ -336,13 +347,40 @@ declare class Command<Ctx extends ListrContext = ListrContext, Flags extends Rec
 }
 
 declare class ConfigCommand<CommandChoices extends string = string, LockFile = any, Ctx extends ListrContext = ListrContext, Flags extends Record<PropertyKey, any> = InferFlags<typeof ConfigCommand>, Args extends Record<PropertyKey, any> = InferArgs<typeof ConfigCommand>, Store extends Record<PropertyKey, any> = Record<PropertyKey, any>> extends Command<Ctx, Flags, Args, Store> {
-    static globalFlags: FlagInput;
+    static globalFlags: object;
     choices: ConfigCommandChoices<CommandChoices>;
     locker: LockerService<LockFile>;
+    protected ux: {
+        config: CliUx.Config;
+        warn: typeof _oclif_core_lib_errors.warn;
+        error: typeof _oclif_core_lib_errors.error;
+        exit: typeof _oclif_core_lib_errors.exit;
+        readonly prompt: typeof _oclif_core_lib_cli_ux_prompt.prompt;
+        readonly anykey: typeof _oclif_core_lib_cli_ux_prompt.anykey;
+        readonly confirm: typeof _oclif_core_lib_cli_ux_prompt.confirm;
+        readonly action: CliUx.ActionBase;
+        readonly prideAction: CliUx.ActionBase;
+        styledObject(obj: any, keys?: string[]): void;
+        readonly styledHeader: typeof _oclif_core_lib_cli_ux_styled_header.default;
+        readonly styledJSON: typeof _oclif_core_lib_cli_ux_styled_json.default;
+        readonly table: typeof CliUx.Table.table;
+        readonly tree: typeof _oclif_core_lib_cli_ux_styled_tree.default;
+        readonly open: typeof _oclif_core_lib_cli_ux_open.default;
+        readonly wait: (ms?: number) => Promise<unknown>;
+        readonly progress: typeof _oclif_core_lib_cli_ux_styled_progress.default;
+        done(): Promise<void>;
+        trace(format: string, ...args: string[]): void;
+        debug(format: string, ...args: string[]): void;
+        info(format: string, ...args: string[]): void;
+        log(format?: string, ...args: string[]): void;
+        url(text: string, uri: string, params?: {}): void;
+        annotation(text: string, annotation: string): void;
+        flush(ms?: number): Promise<void>;
+    };
     run(): Promise<void>;
     setup(): ConfigCommandSetup<CommandChoices, LockFile> | Promise<ConfigCommandSetup<CommandChoices, LockFile>>;
     protected table(...options: Parameters<typeof CliUx.ux.table>): void;
-    private generate;
+    protected select(): Promise<string>;
 }
 
 declare enum FileConstants {

package/dist/index.js

@@ -108,6 +108,9 @@ var LogLevels = /* @__PURE__ */ ((LogLevels2) => {
 var LogFieldStatus = /* @__PURE__ */ ((LogFieldStatus2) => {
   LogFieldStatus2["RUN"] = "RUN";
   LogFieldStatus2["END"] = "END";
+  LogFieldStatus2["STAGE"] = "STAGE";
+  LogFieldStatus2["EXIT"] = "EXIT";
+  LogFieldStatus2["TERMINATE"] = "TERMINATE";
   return LogFieldStatus2;
 })(LogFieldStatus || {});
 
@@ -167,6 +170,9 @@ var Logger = class {
   end(data, ...args) {
     return this.parseMessage("INFO" /* INFO */, data, args, { status: "END" /* END */ });
   }
+  stage(data, ...args) {
+    return this.parseMessage("TRACE" /* TRACE */, data, args, { status: "STAGE" /* STAGE */ });
+  }
   initiateLogger() {
     const logFormat = import_winston.format.printf(({ level, message, context, status }) => {
       let multiLineMessage;
@@ -1049,7 +1055,7 @@ var Command = class extends import_core3.Command {
     if (err) {
       throw err;
     }
-    this.logger.trace("init", { status: "stage" });
+    this.logger.stage("Initiating services.");
     this.parser = new ParserService();
     this.fs = new FileSystemService();
     this.validator = new ValidatorService();
@@ -1073,24 +1079,27 @@ var Command = class extends import_core3.Command {
       });
     }
     process.on("SIGINT", () => {
-      this.logger.fatal("Caught terminate signal.", { context: "exit" });
+      this.logger.fatal("Caught terminate signal.", { status: "TERMINATE" /* TERMINATE */ });
       process.exit(1);
     });
-    this.logger.trace("should run before", { status: "stage" });
+    this.logger.stage("Running shouldRunBefore.");
     await this.shouldRunBefore();
+    this.logger.stage("Finished shouldRunBefore.");
   }
   shouldRunBefore() {
   }
   shouldRunAfter(_ctx) {
   }
   run() {
-    return;
+    throw new Error("The command should have a run function to do something!");
   }
   async finally() {
-    this.logger.trace("tasks", { status: "stage" });
+    this.logger.stage("Running tasks.");
     const ctx = await this.runTasks();
-    this.logger.trace("should run after", { status: "stage" });
+    this.logger.stage("Finished tasks.");
+    this.logger.stage("Running shouldRunAfter.");
     await this.shouldRunAfter(ctx);
+    this.logger.stage("Finished shouldRunAfter.");
     return { ctx };
   }
   catch(e) {
@@ -1100,7 +1109,7 @@ var Command = class extends import_core3.Command {
     return;
   }
   exit(code) {
-    this.logger.trace("Exitting with code: %d", code);
+    this.logger.trace("Code -> %d", code, { status: "EXIT" /* EXIT */ });
     process.exit(code ?? 0);
   }
   runTasks() {
@@ -1138,25 +1147,33 @@ Command.globalFlags = CLI_FLAGS;
 
 // src/commands/config.command.ts
 var ConfigCommand = class extends Command {
+  constructor() {
+    super(...arguments);
+    this.ux = import_core2.CliUx.ux;
+  }
   async run() {
+    this.logger.stage("Setting up config command.");
     const setup2 = await this.setup();
     this.choices = setup2.choices;
     this.locker = setup2.locker;
-    await this.generate();
+    this.logger.stage("User selection for configuration.");
+    const response = await this.select();
+    this.logger.stage("Will run selection: %s", response);
+    return this.choices[response]();
   }
   setup() {
     throw new Error("The command should be setup first!");
   }
   table(...options) {
-    import_core2.CliUx.ux.table(...options);
+    this.ux.table(...options);
   }
-  async generate() {
+  async select() {
     const response = await this.prompt({
       type: "Select",
       message: "Please select what to do with the configuration.",
       choices: Object.keys(this.choices)
     });
-    return this.choices[response].bind(this)();
+    return response;
   }
 };
 __name(ConfigCommand, "ConfigCommand");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cenk1cenk2/oclif-common",
-  "version": "3.5.1",
+  "version": "3.5.3",
   "description": "Oclif common package for oclif2 projects.",
   "repository": "https://gitlab.kilic.dev/libraries/oclif-tools",
   "author": {