@cenk1cenk2/oclif-common 3.6.0 → 3.7.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Command as Command$1, CliUx } from '@oclif/core';
+import { Command as Command$1, Config, CliUx } from '@oclif/core';
 export { CliUx, Flags } from '@oclif/core';
 import { Logger as Logger$2, ListrTaskWrapper, ListrContext, Manager, PromptOptions } from 'listr2';
 import { Logger as Logger$1, LeveledLogMethod } from 'winston';
@@ -310,7 +310,10 @@ 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: object;
+    argv: string[];
+    config: Config;
+    static get globalFlags(): FlagInput;
+    static set globalFlags(flags: FlagInput);
     logger: Logger;
     tasks: Manager<Ctx, 'default' | 'verbose' | 'silent' | 'simple'>;
     validator: ValidatorService;
@@ -320,8 +323,7 @@ declare class Command<Ctx extends ListrContext = ListrContext, Flags extends Rec
     store: StoreService<Store>;
     flags: Flags;
     args: Args;
-    /** Initial functions / constructor */
-    init(): Promise<void>;
+    constructor(argv: string[], config: Config);
     /**
      * Construct the class if you dont want to extend init or constructor.
      */
@@ -330,25 +332,27 @@ declare class Command<Ctx extends ListrContext = ListrContext, Flags extends Rec
      * Deconstruct the class if you dont want to extend finally or catch.
      */
     shouldRunAfter(_ctx?: Ctx): void | Promise<void>;
-    run(): Promise<void>;
-    /** Tasks to run before end of the command. */
-    finally<C extends Ctx = Ctx>(): Promise<{
-        ctx: C;
-    }>;
-    /** Catch any error occurred during command. */
-    catch(e: Error): Promise<void>;
+    run<T = void>(): Promise<T>;
+    _run<T>(): Promise<T | undefined>;
     exit(code?: number): void;
     /** Run all tasks from task manager. */
     runTasks<C extends Ctx = Ctx>(): Promise<C>;
     /** Gets prompt from user. */
     prompt<T = any>(options: PromptOptions): Promise<T>;
-    setCtxDefaults(...defaults: SetCtxDefaultsOptions<Ctx>[]): void;
-    setCtxAssign<K = Record<PropertyKey, any>>(...assigns: SetCtxAssignOptions<K>[]): void;
+    protected setCtxDefaults(...defaults: SetCtxDefaultsOptions<Ctx>[]): void;
+    protected setCtxAssign<K = Record<PropertyKey, any>>(...assigns: SetCtxAssignOptions<K>[]): void;
+    /** Initial functions / constructor */
+    protected init(): Promise<void>;
+    /** Tasks to run before end of the command. */
+    protected finally<C extends Ctx = Ctx>(): Promise<{
+        ctx: C;
+    }>;
+    /** Catch any error occurred during command. */
+    protected catch(e: Error): Promise<void>;
     private greet;
 }
 
 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: object;
     choices: ConfigCommandChoices<CommandChoices>;
     locker: LockerService<LockFile>;
     protected ux: {
@@ -378,7 +382,7 @@ declare class ConfigCommand<CommandChoices extends string = string, LockFile = a
         annotation(text: string, annotation: string): void;
         flush(ms?: number): Promise<void>;
     };
-    run(): Promise<void>;
+    run<T = void>(): Promise<T>;
     setup(): ConfigCommandSetup<CommandChoices, LockFile> | Promise<ConfigCommandSetup<CommandChoices, LockFile>>;
     protected table(...options: Parameters<typeof CliUx.ux.table>): void;
     protected select(): Promise<string>;

package/dist/index.js

@@ -1032,12 +1032,68 @@ __name(setup, "setup");
 
 // src/commands/base.command.ts
 var Command = class extends import_core3.Command {
-  constructor() {
-    super(...arguments);
+  constructor(argv, config) {
+    super(argv, config);
+    this.argv = argv;
+    this.config = config;
     this.flags = {};
     this.args = {};
   }
+  static get globalFlags() {
+    return { CLI_FLAGS, ...this._globalFlags };
+  }
+  static set globalFlags(flags) {
+    this._globalFlags = Object.assign({}, this.globalFlags, flags);
+    this.flags = {};
+  }
+  shouldRunBefore() {
+  }
+  shouldRunAfter(_ctx) {
+  }
+  run() {
+    throw new Error("The command should have a run function to do something!");
+  }
+  async _run() {
+    let result;
+    try {
+      delete process.env[this.config.scopedEnvVarKey("REDIRECTED")];
+      await this.init();
+      result = await this.run();
+    } catch (error) {
+      await this.catch(error);
+    } finally {
+      await this.finally();
+    }
+    if (result && this.jsonEnabled()) {
+      import_core2.CliUx.ux.styledJSON(this.toSuccessJson(result));
+    }
+    return result;
+  }
+  exit(code) {
+    this.logger.trace("Code -> %d", code, { status: "exit" /* EXIT */ });
+    process.exit(code ?? 0);
+  }
+  runTasks() {
+    return this.tasks.runAll();
+  }
+  prompt(options) {
+    return (0, import_listr23.createPrompt)(options, {
+      stdout: process.stdout,
+      cancelCallback: () => {
+        throw new Error("Cancelled prompt.");
+      }
+    });
+  }
+  setCtxDefaults(...defaults) {
+    setCtxDefaults(this.tasks.options.ctx, ...defaults);
+    this.logger.trace("updated  with defaults: %o", this.tasks.options.ctx, { status: "ctx" });
+  }
+  setCtxAssign(...assigns) {
+    setCtxAssign(this.tasks.options.ctx, ...assigns);
+    this.logger.trace("updated with assign: %o", this.tasks.options.ctx, { status: "ctx" });
+  }
   async init() {
+    await super.init();
     let err;
     try {
       const { flags, args } = await this.parse();
@@ -1089,13 +1145,6 @@ var Command = class extends import_core3.Command {
     await this.shouldRunBefore();
     this.logger.stage("Finished shouldRunBefore.");
   }
-  shouldRunBefore() {
-  }
-  shouldRunAfter(_ctx) {
-  }
-  run() {
-    throw new Error("The command should have a run function to do something!");
-  }
   async finally() {
     this.logger.stage("Running tasks.");
     const ctx = await this.runTasks();
@@ -1111,29 +1160,6 @@ var Command = class extends import_core3.Command {
     this.exit(127);
     return;
   }
-  exit(code) {
-    this.logger.trace("Code -> %d", code, { status: "exit" /* EXIT */ });
-    process.exit(code ?? 0);
-  }
-  runTasks() {
-    return this.tasks.runAll();
-  }
-  prompt(options) {
-    return (0, import_listr23.createPrompt)(options, {
-      stdout: process.stdout,
-      cancelCallback: () => {
-        throw new Error("Cancelled prompt.");
-      }
-    });
-  }
-  setCtxDefaults(...defaults) {
-    setCtxDefaults(this.tasks.options.ctx, ...defaults);
-    this.logger.trace("updated  with defaults: %o", this.tasks.options.ctx, { status: "ctx" });
-  }
-  setCtxAssign(...assigns) {
-    setCtxAssign(this.tasks.options.ctx, ...assigns);
-    this.logger.trace("updated with assign: %o", this.tasks.options.ctx, { status: "ctx" });
-  }
   greet() {
     if (this.cs.isSilent || this.cs.json) {
       return;
@@ -1146,7 +1172,6 @@ var Command = class extends import_core3.Command {
   }
 };
 __name(Command, "Command");
-Command.globalFlags = CLI_FLAGS;
 
 // src/commands/config.command.ts
 var ConfigCommand = class extends Command {
@@ -1180,7 +1205,6 @@ var ConfigCommand = class extends Command {
   }
 };
 __name(ConfigCommand, "ConfigCommand");
-ConfigCommand.globalFlags = CLI_FLAGS;
 
 // src/hooks/not-found.hook.ts
 var import_core4 = require("@oclif/core");

package/package.json

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