@cenk1cenk2/oclif-common 3.9.11 → 4.0.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { Command as Command$1, CliUx, Hook } from '@oclif/core';
-export { CliUx, Flags } from '@oclif/core';
+import { Command as Command$1, ux, Hook } from '@oclif/core';
+export { Flags, ux } from '@oclif/core';
 import { ExecaChildProcess } from 'execa';
 import { Logger as Logger$2, ListrTaskWrapper, ListrContext, Manager, PromptOptions } from 'listr2';
 import { Logger as Logger$1, LeveledLogMethod } from 'winston';
@@ -7,15 +7,10 @@ import fs from 'fs-extra';
 export { default as fs } from 'fs-extra';
 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';
+import { InferredFlags } from '@oclif/core/lib/interfaces';
+export { Flag, InferredFlags } from '@oclif/core/lib/interfaces';
+import { FlagInput } from '@oclif/core/lib/interfaces/parser';
+export { Arg, ArgInput, FlagInput } from '@oclif/core/lib/interfaces/parser';
 import * as colorette from 'colorette';
 
 type ClassType<T> = new (...args: any[]) => T;
@@ -319,7 +314,7 @@ interface ConfigCommandSetup<T extends string = string, LockFile = any> {
     locker?: LockerService<LockFile>;
 }
 
-type InferFlags<T extends typeof Command$1> = InferredFlags<T['globalFlags'] & T['flags']>;
+type InferFlags<T extends typeof Command$1> = InferredFlags<T['baseFlags'] & T['flags']>;
 type InferArgs<T extends typeof Command$1> = Record<T['args'][number]['name'], string>;
 
 /**
@@ -330,6 +325,8 @@ 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 get baseFlags(): FlagInput;
+    static set baseFlags(flags: FlagInput);
     context: string;
     logger: Logger;
     tasks: Manager<Ctx, 'default' | 'verbose' | 'silent' | 'simple'>;
@@ -373,36 +370,9 @@ 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> {
     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<any>;
     setup(): ConfigCommandSetup<CommandChoices, LockFile> | Promise<ConfigCommandSetup<CommandChoices, LockFile>>;
-    protected table(...options: Parameters<typeof CliUx.ux.table>): void;
+    protected table(...options: Parameters<typeof ux.table>): void;
     protected select(): Promise<string>;
 }
 

package/dist/index.js

@@ -195,14 +195,14 @@ var FileSystemService = class {
   }
   async write(file, data, options = {}) {
     try {
-      await _fsextra2.default.writeFile(file, data, { encoding: "utf-8", ...options });
+      await _fsextra2.default.writeFile(file, data, typeof options === "object" ? { encoding: "utf-8", ...options } : options);
     } catch (e) {
       throw new Error(`Error while writing file to "${file}": ${e.message}`);
     }
   }
   writeSync(file, data, options = {}) {
     try {
-      _fsextra2.default.writeFileSync(file, data, { encoding: "utf-8", ...options });
+      _fsextra2.default.writeFileSync(file, data, typeof options === "object" ? { encoding: "utf-8", ...options } : options);
     } catch (e) {
       throw new Error(`Error while writing file to "${file}": ${e.message}`);
     }
@@ -460,7 +460,9 @@ var ConfigService = class {
               const variable = [
                 {
                   key: location,
+                  // eslint-disable-next-line no-underscore-dangle
                   env: value["__name" /* NAME */],
+                  // eslint-disable-next-line no-underscore-dangle
                   parser: value["__format" /* PARSER */],
                   extensions
                 }
@@ -824,6 +826,7 @@ var Logger = class {
   trace(data, ...args) {
     return this.parseMessage("TRACE" /* TRACE */, data, args);
   }
+  // status levels
   run(data, ...args) {
     return this.parseMessage("INFO" /* INFO */, data, args, { status: "run" /* RUN */ });
   }
@@ -1034,11 +1037,11 @@ __name(pipeProcessToLogger, "pipeProcessToLogger");
 
 // src/constants/global-flags.constants.ts
 var CLI_FLAGS = {
-  ["log-level"]: _core.Flags.enum({
+  ["log-level"]: _core.Flags.string({
     default: "INFO" /* INFO */,
     env: "LOG_LEVEL",
     description: "Set the log level of the application.",
-    options: [...Object.values(LogLevels).map((level) => level.toLowerCase())],
+    options: Object.values(LogLevels).map((level) => level.toLowerCase()),
     helpGroup: "CLI" /* CLI */,
     parse: async (input) => _optionalChain([input, 'optionalAccess', _41 => _41.toUpperCase, 'call', _42 => _42()])
   }),
@@ -1065,13 +1068,30 @@ var Command = class extends _core.Command {
     this.flags = {};
     this.args = {};
   }
+  static get baseFlags() {
+    return this._baseFlags;
+  }
+  static set baseFlags(flags) {
+    this._baseFlags = Object.assign(CLI_FLAGS, this.baseFlags, flags);
+    this.flags = {};
+  }
+  /**
+   * Construct the class if you dont want to extend init or constructor.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   shouldRunBefore() {
   }
+  /**
+   * Deconstruct the class if you dont want to extend finally or catch.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars
   shouldRunAfter(_ctx) {
   }
+  // make run non-abstract for other classes
   run() {
     throw new Error("The command should have a run function to do something!");
   }
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   async _run() {
     let result;
     try {
@@ -1083,7 +1103,7 @@ var Command = class extends _core.Command {
       await this.catch(error, 127);
     }
     if (result && this.jsonEnabled()) {
-      _core.CliUx.ux.styledJSON(this.toSuccessJson(result));
+      _core.ux.styledJSON(this.toSuccessJson(result));
     }
     return result;
   }
@@ -1091,9 +1111,11 @@ var Command = class extends _core.Command {
     this.logger.trace("Code -> %d", code, { status: "exit" /* EXIT */ });
     process.exit(_nullishCoalesce(code, () => ( 0)));
   }
+  /** Run all tasks from task manager. */
   runTasks() {
     return this.tasks.runAll();
   }
+  /** Gets prompt from user. */
   prompt(options) {
     return _listr2.createPrompt.call(void 0, options, {
       error: true,
@@ -1114,6 +1136,8 @@ var Command = class extends _core.Command {
   pipeProcessThroughListr(task, instance) {
     return pipeProcessThroughListr(task, instance);
   }
+  /** Initial functions / constructor */
+  // can not override constructor, init function is defined by oclif
   async init() {
     this.constructor.flags = Object.assign({}, CLI_FLAGS, this.constructor.flags);
     await super.init();
@@ -1169,6 +1193,7 @@ var Command = class extends _core.Command {
     await this.shouldRunBefore();
     this.logger.stage("Finished shouldRunBefore.");
   }
+  /** Tasks to run before end of the command. */
   async finally() {
     this.logger.stage("Running tasks.");
     const ctx = await this.runTasks();
@@ -1178,6 +1203,8 @@ var Command = class extends _core.Command {
     this.logger.stage("Finished shouldRunAfter.");
     return { ctx };
   }
+  /** Catch any error occurred during command. */
+  // catch all those errors, not verbose
   catch(e, exit) {
     if (!this.logger) {
       console.error("Logger has not been initiated yet!");
@@ -1206,10 +1233,6 @@ __name(Command, "Command");
 
 // src/commands/config.command.ts
 var ConfigCommand = class extends Command {
-  constructor() {
-    super(...arguments);
-    this.ux = _core.CliUx.ux;
-  }
   async run() {
     this.logger.stage("Setting up config command.");
     const setup2 = await this.setup();
@@ -1224,7 +1247,7 @@ var ConfigCommand = class extends Command {
     throw new Error("The command should be setup first!");
   }
   table(...options) {
-    this.ux.table(...options);
+    _core.ux.table(...options);
   }
   async select() {
     const response = await this.prompt({
@@ -1295,4 +1318,4 @@ var storeHook = /* @__PURE__ */ __name((cb) => async (opts) => {
 
 
 
-exports.CLI_FLAGS = CLI_FLAGS; exports.CliUx = _core.CliUx; exports.Command = Command; exports.ConfigCommand = ConfigCommand; exports.ConfigService = ConfigService; exports.EnvironmentVariableParser = EnvironmentVariableParser; exports.FileConstants = FileConstants; exports.FileSystemService = FileSystemService; exports.Flags = _core.Flags; exports.HelpGroups = HelpGroups; exports.JsonParser = JsonParser; exports.ListrLogger = ListrLogger; exports.LockerService = LockerService; exports.LogFieldStatus = LogFieldStatus; exports.LogLevels = LogLevels; exports.Logger = Logger; exports.MergeStrategy = MergeStrategy; exports.ParserService = ParserService; exports.StoreService = StoreService; exports.ValidatorService = ValidatorService; exports.YamlParser = YamlParser; exports.color = color; exports.fs = _fsextra2.default; exports.isDebug = isDebug; exports.isSilent = isSilent; exports.isVerbose = isVerbose; exports.merge = merge; exports.notFoundHook = notFoundHook; exports.pipeProcessThroughListr = pipeProcessThroughListr; exports.pipeProcessToLogger = pipeProcessToLogger; exports.setCtxAssign = setCtxAssign; exports.setCtxDefaults = setCtxDefaults; exports.setup = setup; exports.storeHook = storeHook; exports.uniqueFilter = uniqueFilter; exports.updateNotifierHook = updateNotifierHook;
+exports.CLI_FLAGS = CLI_FLAGS; exports.Command = Command; exports.ConfigCommand = ConfigCommand; exports.ConfigService = ConfigService; exports.EnvironmentVariableParser = EnvironmentVariableParser; exports.FileConstants = FileConstants; exports.FileSystemService = FileSystemService; exports.Flags = _core.Flags; exports.HelpGroups = HelpGroups; exports.JsonParser = JsonParser; exports.ListrLogger = ListrLogger; exports.LockerService = LockerService; exports.LogFieldStatus = LogFieldStatus; exports.LogLevels = LogLevels; exports.Logger = Logger; exports.MergeStrategy = MergeStrategy; exports.ParserService = ParserService; exports.StoreService = StoreService; exports.ValidatorService = ValidatorService; exports.YamlParser = YamlParser; exports.color = color; exports.fs = _fsextra2.default; exports.isDebug = isDebug; exports.isSilent = isSilent; exports.isVerbose = isVerbose; exports.merge = merge; exports.notFoundHook = notFoundHook; exports.pipeProcessThroughListr = pipeProcessThroughListr; exports.pipeProcessToLogger = pipeProcessToLogger; exports.setCtxAssign = setCtxAssign; exports.setCtxDefaults = setCtxDefaults; exports.setup = setup; exports.storeHook = storeHook; exports.uniqueFilter = uniqueFilter; exports.updateNotifierHook = updateNotifierHook; exports.ux = _core.ux;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cenk1cenk2/oclif-common",
-  "version": "3.9.11",
+  "version": "4.0.0",
   "description": "Oclif common package for oclif2 projects.",
   "repository": "https://gitlab.kilic.dev/libraries/oclif-tools",
   "author": {
@@ -57,7 +57,7 @@
   },
   "dependencies": {
     "colorette": "^2.0.19",
-    "deepmerge": "^4.2.2",
+    "deepmerge": "^4.3.0",
     "object-path-immutable": "^4.1.2",
     "reflect-metadata": "^0.1.13",
     "through": "^2.3.8",
@@ -66,15 +66,15 @@
     "yaml": "^2.2.1"
   },
   "devDependencies": {
-    "@oclif/core": "^1.23.0",
-    "@types/fs-extra": "^9.0.13",
+    "@oclif/core": "^2.5.0",
+    "@types/fs-extra": "^11.0.1",
     "@types/through": "^0.0.30",
     "@types/update-notifier": "^6",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "enquirer": "^2.3.6",
     "execa": "^5",
-    "fs-extra": "^10.1.0",
-    "listr2": "^5.0.6"
+    "fs-extra": "^11.1.0",
+    "listr2": "^5.0.7"
   }
 }