@git.zone/cli 2.13.15 → 2.14.0

package/ts/gitzone.cli.ts

@@ -1,23 +1,29 @@
-import * as plugins from './plugins.js';
-import * as paths from './paths.js';
-import { GitzoneConfig } from './classes.gitzoneconfig.js';
+import * as plugins from "./plugins.js";
+import * as paths from "./paths.js";
+import { GitzoneConfig } from "./classes.gitzoneconfig.js";
+import { getRawCliMode } from "./helpers.climode.js";
 
 const gitzoneSmartcli = new plugins.smartcli.Smartcli();
 
 export let run = async () => {
   const done = plugins.smartpromise.defer();
+  const rawCliMode = await getRawCliMode();
 
   // get packageInfo
   const projectInfo = new plugins.projectinfo.ProjectInfo(paths.packageDir);
 
   // check for updates
-  const smartupdateInstance = new plugins.smartupdate.SmartUpdate();
-  await smartupdateInstance.check(
-    'gitzone',
-    projectInfo.npm.version,
-    'http://gitzone.gitlab.io/gitzone/changelog.html',
-  );
-  console.log('---------------------------------------------');
+  if (rawCliMode.checkUpdates) {
+    const smartupdateInstance = new plugins.smartupdate.SmartUpdate();
+    await smartupdateInstance.check(
+      "gitzone",
+      projectInfo.npm.version,
+      "http://gitzone.gitlab.io/gitzone/changelog.html",
+    );
+  }
+  if (rawCliMode.output === "human") {
+    console.log("---------------------------------------------");
+  }
   gitzoneSmartcli.addVersion(projectInfo.npm.version);
 
   // ======> Standard task <======
@@ -26,8 +32,13 @@ export let run = async () => {
    * standard task
    */
   gitzoneSmartcli.standardCommand().subscribe(async (argvArg) => {
-    const modStandard = await import('./mod_standard/index.js');
-    await modStandard.run();
+    const modStandard = await import("./mod_standard/index.js");
+    await modStandard.run(argvArg);
+  });
+
+  gitzoneSmartcli.addCommand("help").subscribe(async (argvArg) => {
+    const modStandard = await import("./mod_standard/index.js");
+    await modStandard.run(argvArg);
   });
 
   // ======> Specific tasks <======
@@ -35,43 +46,44 @@ export let run = async () => {
   /**
    * commit something
    */
-  gitzoneSmartcli.addCommand('commit').subscribe(async (argvArg) => {
-    const modCommit = await import('./mod_commit/index.js');
+  gitzoneSmartcli.addCommand("commit").subscribe(async (argvArg) => {
+    const modCommit = await import("./mod_commit/index.js");
     await modCommit.run(argvArg);
   });
 
   /**
    * deprecate a package on npm
    */
-  gitzoneSmartcli.addCommand('deprecate').subscribe(async (argvArg) => {
-    const modDeprecate = await import('./mod_deprecate/index.js');
+  gitzoneSmartcli.addCommand("deprecate").subscribe(async (argvArg) => {
+    const modDeprecate = await import("./mod_deprecate/index.js");
     await modDeprecate.run();
   });
 
   /**
    * docker
    */
-  gitzoneSmartcli.addCommand('docker').subscribe(async (argvArg) => {
-    const modDocker = await import('./mod_docker/index.js');
+  gitzoneSmartcli.addCommand("docker").subscribe(async (argvArg) => {
+    const modDocker = await import("./mod_docker/index.js");
     await modDocker.run(argvArg);
   });
 
   /**
    * Update all files that comply with the gitzone standard
    */
-  gitzoneSmartcli.addCommand('format').subscribe(async (argvArg) => {
+  gitzoneSmartcli.addCommand("format").subscribe(async (argvArg) => {
     const config = GitzoneConfig.fromCwd();
-    const modFormat = await import('./mod_format/index.js');
+    const modFormat = await import("./mod_format/index.js");
 
     // Handle format with options
     // Default is dry-mode, use --write/-w to apply changes
     await modFormat.run({
+      ...argvArg,
       write: argvArg.write || argvArg.w,
-      dryRun: argvArg['dry-run'],
+      dryRun: argvArg["dry-run"],
       yes: argvArg.yes,
-      planOnly: argvArg['plan-only'],
-      savePlan: argvArg['save-plan'],
-      fromPlan: argvArg['from-plan'],
+      planOnly: argvArg["plan-only"],
+      savePlan: argvArg["save-plan"],
+      fromPlan: argvArg["from-plan"],
       detailed: argvArg.detailed,
       interactive: argvArg.interactive !== false,
       verbose: argvArg.verbose,
@@ -82,54 +94,54 @@ export let run = async () => {
   /**
    * run meta commands
    */
-  gitzoneSmartcli.addCommand('meta').subscribe(async (argvArg) => {
+  gitzoneSmartcli.addCommand("meta").subscribe(async (argvArg) => {
     const config = GitzoneConfig.fromCwd();
-    const modMeta = await import('./mod_meta/index.js');
+    const modMeta = await import("./mod_meta/index.js");
     modMeta.run(argvArg);
   });
 
   /**
    * open assets
    */
-  gitzoneSmartcli.addCommand('open').subscribe(async (argvArg) => {
-    const modOpen = await import('./mod_open/index.js');
+  gitzoneSmartcli.addCommand("open").subscribe(async (argvArg) => {
+    const modOpen = await import("./mod_open/index.js");
     modOpen.run(argvArg);
   });
 
   /**
    * add a readme to a project
    */
-  gitzoneSmartcli.addCommand('template').subscribe(async (argvArg) => {
-    const modTemplate = await import('./mod_template/index.js');
+  gitzoneSmartcli.addCommand("template").subscribe(async (argvArg) => {
+    const modTemplate = await import("./mod_template/index.js");
     modTemplate.run(argvArg);
   });
 
   /**
    * start working on a project
    */
-  gitzoneSmartcli.addCommand('start').subscribe(async (argvArg) => {
-    const modTemplate = await import('./mod_start/index.js');
+  gitzoneSmartcli.addCommand("start").subscribe(async (argvArg) => {
+    const modTemplate = await import("./mod_start/index.js");
     modTemplate.run(argvArg);
   });
 
-  gitzoneSmartcli.addCommand('helpers').subscribe(async (argvArg) => {
-    const modHelpers = await import('./mod_helpers/index.js');
+  gitzoneSmartcli.addCommand("helpers").subscribe(async (argvArg) => {
+    const modHelpers = await import("./mod_helpers/index.js");
     modHelpers.run(argvArg);
   });
 
   /**
    * manage release configuration
    */
-  gitzoneSmartcli.addCommand('config').subscribe(async (argvArg) => {
-    const modConfig = await import('./mod_config/index.js');
+  gitzoneSmartcli.addCommand("config").subscribe(async (argvArg) => {
+    const modConfig = await import("./mod_config/index.js");
     await modConfig.run(argvArg);
   });
 
   /**
    * manage development services (MongoDB, S3/MinIO)
    */
-  gitzoneSmartcli.addCommand('services').subscribe(async (argvArg) => {
-    const modServices = await import('./mod_services/index.js');
+  gitzoneSmartcli.addCommand("services").subscribe(async (argvArg) => {
+    const modServices = await import("./mod_services/index.js");
     await modServices.run(argvArg);
   });
 

package/ts/helpers.climode.ts

@@ -0,0 +1,212 @@
+import { getCliConfigValue } from "./helpers.smartconfig.js";
+
+export type TCliOutputMode = "human" | "plain" | "json";
+
+export interface ICliMode {
+  output: TCliOutputMode;
+  interactive: boolean;
+  json: boolean;
+  plain: boolean;
+  quiet: boolean;
+  yes: boolean;
+  help: boolean;
+  agent: boolean;
+  checkUpdates: boolean;
+  isTty: boolean;
+  command?: string;
+}
+
+interface ICliConfigSettings {
+  interactive?: boolean;
+  output?: TCliOutputMode;
+  checkUpdates?: boolean;
+}
+
+type TArgSource = Record<string, any> & { _?: string[] };
+
+const camelCase = (value: string): string => {
+  return value.replace(/-([a-z])/g, (_match, group: string) =>
+    group.toUpperCase(),
+  );
+};
+
+const getArgValue = (argvArg: TArgSource, key: string): any => {
+  const keyVariants = [key, camelCase(key), key.replace(/-/g, "")];
+  for (const keyVariant of keyVariants) {
+    if (argvArg[keyVariant] !== undefined) {
+      return argvArg[keyVariant];
+    }
+  }
+  return undefined;
+};
+
+const parseRawArgv = (argv: string[]): TArgSource => {
+  const parsedArgv: TArgSource = { _: [] };
+
+  for (let i = 0; i < argv.length; i++) {
+    const currentArg = argv[i];
+
+    if (currentArg.startsWith("--no-")) {
+      const key = currentArg.slice(5);
+      parsedArgv[key] = false;
+      parsedArgv[camelCase(key)] = false;
+      continue;
+    }
+
+    if (currentArg.startsWith("--")) {
+      const withoutPrefix = currentArg.slice(2);
+      const [rawKey, inlineValue] = withoutPrefix.split("=", 2);
+      if (inlineValue !== undefined) {
+        parsedArgv[rawKey] = inlineValue;
+        parsedArgv[camelCase(rawKey)] = inlineValue;
+        continue;
+      }
+
+      const nextArg = argv[i + 1];
+      if (nextArg && !nextArg.startsWith("-")) {
+        parsedArgv[rawKey] = nextArg;
+        parsedArgv[camelCase(rawKey)] = nextArg;
+        i++;
+      } else {
+        parsedArgv[rawKey] = true;
+        parsedArgv[camelCase(rawKey)] = true;
+      }
+      continue;
+    }
+
+    if (currentArg.startsWith("-") && currentArg.length > 1) {
+      for (const shortFlag of currentArg.slice(1).split("")) {
+        parsedArgv[shortFlag] = true;
+      }
+      continue;
+    }
+
+    parsedArgv._ = parsedArgv._ || [];
+    parsedArgv._.push(currentArg);
+  }
+
+  return parsedArgv;
+};
+
+const normalizeOutputMode = (value: unknown): TCliOutputMode | undefined => {
+  if (value === "human" || value === "plain" || value === "json") {
+    return value;
+  }
+  return undefined;
+};
+
+const resolveCliMode = (
+  argvArg: TArgSource,
+  cliConfig: ICliConfigSettings,
+): ICliMode => {
+  const isTty = Boolean(process.stdout?.isTTY && process.stdin?.isTTY);
+  const agentMode = Boolean(getArgValue(argvArg, "agent"));
+  const outputOverride = normalizeOutputMode(getArgValue(argvArg, "output"));
+
+  let output: TCliOutputMode =
+    normalizeOutputMode(cliConfig.output) || (isTty ? "human" : "plain");
+  if (agentMode || getArgValue(argvArg, "json")) {
+    output = "json";
+  } else if (getArgValue(argvArg, "plain")) {
+    output = "plain";
+  } else if (outputOverride) {
+    output = outputOverride;
+  }
+
+  const interactiveSetting = getArgValue(argvArg, "interactive");
+  let interactive = cliConfig.interactive ?? isTty;
+  if (interactiveSetting === true) {
+    interactive = true;
+  } else if (interactiveSetting === false) {
+    interactive = false;
+  }
+  if (!isTty || output !== "human" || agentMode) {
+    interactive = false;
+  }
+
+  const checkUpdatesSetting = getArgValue(argvArg, "check-updates");
+  let checkUpdates = cliConfig.checkUpdates ?? output === "human";
+  if (checkUpdatesSetting === true) {
+    checkUpdates = true;
+  } else if (checkUpdatesSetting === false) {
+    checkUpdates = false;
+  }
+  if (output !== "human" || agentMode) {
+    checkUpdates = false;
+  }
+
+  return {
+    output,
+    interactive,
+    json: output === "json",
+    plain: output === "plain",
+    quiet: Boolean(
+      getArgValue(argvArg, "quiet") ||
+      getArgValue(argvArg, "q") ||
+      output === "json",
+    ),
+    yes: Boolean(getArgValue(argvArg, "yes") || getArgValue(argvArg, "y")),
+    help: Boolean(
+      getArgValue(argvArg, "help") ||
+      getArgValue(argvArg, "h") ||
+      argvArg._?.[0] === "help",
+    ),
+    agent: agentMode,
+    checkUpdates,
+    isTty,
+    command: argvArg._?.[0],
+  };
+};
+
+const getCliModeConfig = async (): Promise<ICliConfigSettings> => {
+  return await getCliConfigValue<ICliConfigSettings>("cli", {});
+};
+
+export const getCliMode = async (
+  argvArg: TArgSource = {},
+): Promise<ICliMode> => {
+  const cliConfig = await getCliModeConfig();
+  return resolveCliMode(argvArg, cliConfig);
+};
+
+export const getRawCliMode = async (): Promise<ICliMode> => {
+  const cliConfig = await getCliModeConfig();
+  const rawArgv = parseRawArgv(process.argv.slice(2));
+  return resolveCliMode(rawArgv, cliConfig);
+};
+
+export const printJson = (data: unknown): void => {
+  console.log(JSON.stringify(data, null, 2));
+};
+
+export const runWithSuppressedOutput = async <T>(
+  fn: () => Promise<T>,
+): Promise<T> => {
+  const originalConsole = {
+    log: console.log,
+    info: console.info,
+    warn: console.warn,
+    error: console.error,
+  };
+  const originalStdoutWrite = process.stdout.write.bind(process.stdout);
+  const originalStderrWrite = process.stderr.write.bind(process.stderr);
+  const noop = () => undefined;
+
+  console.log = noop;
+  console.info = noop;
+  console.warn = noop;
+  console.error = noop;
+  process.stdout.write = (() => true) as typeof process.stdout.write;
+  process.stderr.write = (() => true) as typeof process.stderr.write;
+
+  try {
+    return await fn();
+  } finally {
+    console.log = originalConsole.log;
+    console.info = originalConsole.info;
+    console.warn = originalConsole.warn;
+    console.error = originalConsole.error;
+    process.stdout.write = originalStdoutWrite;
+    process.stderr.write = originalStderrWrite;
+  }
+};

package/ts/helpers.smartconfig.ts

@@ -0,0 +1,192 @@
+import * as plugins from "./plugins.js";
+import { rename, writeFile } from "fs/promises";
+
+export const CLI_NAMESPACE = "@git.zone/cli";
+
+const isPlainObject = (value: unknown): value is Record<string, any> => {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+};
+
+export const getSmartconfigPath = (cwd: string = process.cwd()): string => {
+  return plugins.path.join(cwd, ".smartconfig.json");
+};
+
+export const readSmartconfigFile = async (
+  cwd: string = process.cwd(),
+): Promise<Record<string, any>> => {
+  const smartconfigPath = getSmartconfigPath(cwd);
+  if (!(await plugins.smartfs.file(smartconfigPath).exists())) {
+    return {};
+  }
+
+  const content = (await plugins.smartfs
+    .file(smartconfigPath)
+    .encoding("utf8")
+    .read()) as string;
+  if (content.trim() === "") {
+    return {};
+  }
+  return JSON.parse(content);
+};
+
+export const writeSmartconfigFile = async (
+  data: Record<string, any>,
+  cwd: string = process.cwd(),
+): Promise<void> => {
+  const smartconfigPath = getSmartconfigPath(cwd);
+  const tempPath = `${smartconfigPath}.tmp-${Date.now()}`;
+  const content = JSON.stringify(data, null, 2);
+  await writeFile(tempPath, content, "utf8");
+  await rename(tempPath, smartconfigPath);
+};
+
+export const normalizeCliConfigPath = (configPath: string): string => {
+  const trimmedPath = configPath.trim();
+  if (!trimmedPath || trimmedPath === CLI_NAMESPACE) {
+    return "";
+  }
+
+  if (trimmedPath.startsWith(`${CLI_NAMESPACE}.`)) {
+    return trimmedPath.slice(`${CLI_NAMESPACE}.`.length);
+  }
+
+  return trimmedPath;
+};
+
+export const getCliConfigPathSegments = (configPath: string): string[] => {
+  const normalizedPath = normalizeCliConfigPath(configPath);
+  if (!normalizedPath) {
+    return [];
+  }
+
+  return normalizedPath
+    .split(".")
+    .map((segment) => segment.trim())
+    .filter(Boolean);
+};
+
+export const getCliNamespaceConfig = (
+  smartconfigData: Record<string, any>,
+): Record<string, any> => {
+  const cliConfig = smartconfigData[CLI_NAMESPACE];
+  if (isPlainObject(cliConfig)) {
+    return cliConfig;
+  }
+  return {};
+};
+
+export const getCliConfigValueFromData = (
+  smartconfigData: Record<string, any>,
+  configPath: string,
+): any => {
+  const segments = getCliConfigPathSegments(configPath);
+  let currentValue: any = getCliNamespaceConfig(smartconfigData);
+
+  for (const segment of segments) {
+    if (!isPlainObject(currentValue) && !Array.isArray(currentValue)) {
+      return undefined;
+    }
+    currentValue = (currentValue as any)?.[segment];
+  }
+
+  return currentValue;
+};
+
+export const getCliConfigValue = async <T>(
+  configPath: string,
+  defaultValue: T,
+  cwd: string = process.cwd(),
+): Promise<T> => {
+  const smartconfigData = await readSmartconfigFile(cwd);
+  const configValue = getCliConfigValueFromData(smartconfigData, configPath);
+
+  if (configValue === undefined) {
+    return defaultValue;
+  }
+
+  if (isPlainObject(defaultValue) && isPlainObject(configValue)) {
+    return {
+      ...defaultValue,
+      ...configValue,
+    } as T;
+  }
+
+  return configValue as T;
+};
+
+export const setCliConfigValueInData = (
+  smartconfigData: Record<string, any>,
+  configPath: string,
+  value: any,
+): Record<string, any> => {
+  const segments = getCliConfigPathSegments(configPath);
+
+  if (!isPlainObject(smartconfigData[CLI_NAMESPACE])) {
+    smartconfigData[CLI_NAMESPACE] = {};
+  }
+
+  if (segments.length === 0) {
+    smartconfigData[CLI_NAMESPACE] = value;
+    return smartconfigData;
+  }
+
+  let currentValue = smartconfigData[CLI_NAMESPACE];
+  for (const segment of segments.slice(0, -1)) {
+    if (!isPlainObject(currentValue[segment])) {
+      currentValue[segment] = {};
+    }
+    currentValue = currentValue[segment];
+  }
+
+  currentValue[segments[segments.length - 1]] = value;
+  return smartconfigData;
+};
+
+export const unsetCliConfigValueInData = (
+  smartconfigData: Record<string, any>,
+  configPath: string,
+): boolean => {
+  const segments = getCliConfigPathSegments(configPath);
+  if (segments.length === 0) {
+    if (smartconfigData[CLI_NAMESPACE] !== undefined) {
+      delete smartconfigData[CLI_NAMESPACE];
+      return true;
+    }
+    return false;
+  }
+
+  const parentSegments = segments.slice(0, -1);
+  let currentValue: any = getCliNamespaceConfig(smartconfigData);
+  const objectPath: Array<Record<string, any>> = [currentValue];
+
+  for (const segment of parentSegments) {
+    if (!isPlainObject(currentValue[segment])) {
+      return false;
+    }
+    currentValue = currentValue[segment];
+    objectPath.push(currentValue);
+  }
+
+  const lastSegment = segments[segments.length - 1];
+  if (!(lastSegment in currentValue)) {
+    return false;
+  }
+
+  delete currentValue[lastSegment];
+
+  for (let i = objectPath.length - 1; i >= 1; i--) {
+    if (Object.keys(objectPath[i]).length > 0) {
+      break;
+    }
+
+    const parentObject = objectPath[i - 1];
+    const parentKey = parentSegments[i - 1];
+    delete parentObject[parentKey];
+  }
+
+  if (Object.keys(getCliNamespaceConfig(smartconfigData)).length === 0) {
+    delete smartconfigData[CLI_NAMESPACE];
+  }
+
+  return true;
+};