@gluhar/cli 3.0.2 → 6.0.0-next.0

package/src/commands/release/release.ts

@@ -1,24 +0,0 @@
-import { version } from "../version/version";
-import type { ReleaseOptions } from "./ReleaseOptions";
-import { log } from "./log";
-import { publish } from "./publish";
-import { tag } from "./tag";
-
-export const release = async (options: ReleaseOptions) => {
-  log.info("Initiating release...");
-  const { pre, dev, yes } = options;
-  if (yes) log.info("and saying yes to all prompts.");
-
-  if (options.version)
-    await version({
-      pre,
-      dev,
-      yes,
-      changelog: !dev,
-      commit: "chore: Releasing gluhar packages.",
-    });
-
-  publish(options);
-
-  await tag(options);
-};

package/src/commands/release/tag.ts

@@ -1,119 +0,0 @@
-import { lerna } from "src/scripts/lerna";
-import { INDEPENDENT_VERSION } from "src/scripts/lerna/constants";
-import { git } from "src/scripts/git";
-import { confirmQuestion } from "src/utils";
-import type { ReleaseOptions } from "./ReleaseOptions";
-import { log } from "./log";
-
-export const pattern = {
-  /** e.g. `@gluhar/cli` */
-  fullPackageName: "%f",
-  /** e.g. `cli` */
-  shortPackageName: "%s",
-  /** e.g. `1.2.3` */
-  version: "%v",
-  default: {
-    /** e.g. `cli/v1.2.3` */
-    independent: "%f@%v",
-    /** e.g. `v1.2.3` */
-    fixed: "v%v",
-  },
-};
-
-const getGitTagPattern = (
-  gitTag: ReleaseOptions["gitTag"],
-  isIndependent: boolean
-) => {
-  if (typeof gitTag === "string") {
-    return gitTag;
-  }
-
-  if (!gitTag) {
-    return null;
-  }
-
-  return isIndependent ? pattern.default.independent : pattern.default.fixed;
-};
-
-export interface PackageInfo {
-  /** Required for independent versioning. */
-  name?: string;
-  version: string;
-}
-
-export const parsePattern = (tagPattern: string, pkg: PackageInfo): string => {
-  const { name: fullName, version } = pkg;
-  const placeholders: { pattern: string; value: string }[] = [
-    {
-      pattern: pattern.version,
-      value: version,
-    },
-  ];
-
-  if (fullName) {
-    const shortName = fullName.substring(fullName.indexOf("/") + 1);
-    placeholders.push({
-      pattern: pattern.fullPackageName,
-      value: fullName,
-    });
-    placeholders.push({
-      pattern: pattern.shortPackageName,
-      value: shortName,
-    });
-  }
-
-  return placeholders.reduce(
-    (t, ph) => t.replaceAll(ph.pattern, ph.value),
-    tagPattern
-  );
-};
-
-export const tag = async (options: ReleaseOptions) => {
-  const { gitTag, yes } = options;
-  if (!gitTag) {
-    return;
-  }
-
-  const lernaConfig = lerna.getConfig();
-  const isIndependent =
-    !!lernaConfig && lernaConfig.version === INDEPENDENT_VERSION;
-
-  const tagPattern = getGitTagPattern(gitTag, isIndependent);
-  if (!tagPattern) {
-    return;
-  }
-
-  const tags = new Set<string>();
-
-  if (
-    !lernaConfig ||
-    isIndependent ||
-    tagPattern.includes(pattern.fullPackageName) ||
-    tagPattern.includes(pattern.shortPackageName)
-  ) {
-    lerna
-      .changed()
-      .filter((pkg) => !pkg.private)
-      .map((pkg) => parsePattern(tagPattern, pkg))
-      .forEach((t) => tags.add(t));
-  } else {
-    const t = parsePattern(tagPattern, { version: lernaConfig.version });
-    tags.add(t);
-  }
-
-  const tagList = [...tags].map((t) => `\n - ${t}`).join("");
-  log.verbose("Tags to create:", tagList);
-
-  const confirm = await confirmQuestion(
-    `Create and push tag(s): ${tagList}. Confirm?`,
-    yes
-  );
-
-  if (confirm) {
-    tags.forEach((t) => {
-      git.tag.create(t);
-    });
-
-    git.tag.pushAll();
-  }
-};

package/src/commands/upgrade/UpgradeOptions.ts

@@ -1,3 +0,0 @@
-export interface UpgradeOptions {
-  upgrade: boolean;
-}

package/src/commands/upgrade/index.ts

@@ -1,10 +0,0 @@
-import { Command } from "commander";
-import { upgrade } from "./upgrade";
-
-export default new Command()
-  .name("upgrade")
-  .description(
-    "Upgrade all gluhar dependencies in a project to their latest versions."
-  )
-  .option("-b, --upgrade", "A boolean option.")
-  .action(upgrade);

package/src/commands/upgrade/log.ts

@@ -1,3 +0,0 @@
-import { logger } from "src/utils";
-
-export const log = logger("upgrade");

package/src/commands/upgrade/upgrade.ts

@@ -1,10 +0,0 @@
-import { executeCmd } from "src/scripts/cmd";
-import { UpgradeOptions } from "./UpgradeOptions";
-import { log } from "./log";
-
-export const upgrade = (options: UpgradeOptions) => {
-  log.info("Upgrading gluhar dependencies.");
-
-  // Upgrade all gluhar dependencies in a project to their latest versions.
-  executeCmd("npm update @gluhar/cli @gluhar/app");
-};

package/src/commands/version/VersionOptions.ts

@@ -1,7 +0,0 @@
-export interface VersionOptions {
-  pre: boolean | string;
-  dev: boolean;
-  changelog: boolean;
-  commit: boolean | string;
-  yes?: boolean;
-}

package/src/commands/version/getPreid.ts

@@ -1,7 +0,0 @@
-export const getPreid = (pre: boolean | string) => {
-  if (typeof pre === 'string') {
-    return pre;
-  }
-
-  return pre ? 'beta' : undefined;
-};

package/src/commands/version/index.ts

@@ -1,18 +0,0 @@
-import { Command } from "commander";
-import { version } from "./version";
-
-export default new Command()
-  .name("version")
-  .description("Update package versions and generate change logs.")
-  .option(
-    "--pre [id]",
-    "Prerelease identifier. Use this when creating a prerelease versioning.",
-    false
-  )
-  .option(
-    "-d, --dev",
-    "Release a dev version. This is a shorthand for a prerelease with a 'dev' identifier."
-  )
-  .option("--no-changelog", "Disable generating changelogs.")
-  .option("-c, --commit [msg]", "Commit changes in git.", false)
-  .action(version);

package/src/commands/version/log.ts

@@ -1,3 +0,0 @@
-import { logger } from 'src/utils';
-
-export const log = logger('version');

package/src/commands/version/pimpChangelogs.ts

@@ -1,43 +0,0 @@
-import { log } from "./log";
-import { glob } from "glob";
-import { join } from "path";
-import { readFileSync, writeFileSync } from "fs";
-import { capitalize } from "src/utils/common";
-
-export const pimpChangelogs = async () => {
-  log.info("Pimping changelogs");
-
-  const g = join("packages", "**", "CHANGELOG.md");
-  const filePaths = await glob(g);
-
-  const changelogs = filePaths.map((fp) => {
-    const changelog = readFileSync(fp).toString();
-
-    const lines = changelog.split("\n").map((line) => {
-      if (line.substring(0, 2) === "* ") {
-        if (line.substring(0, 4) === "* **")
-          return `- ${line.substring(2).split("** ").map(capitalize).join("** ")}`;
-
-        return `- ${capitalize(line.substring(2))}`;
-      }
-
-      if (line.includes("**Note:**"))
-        return line.replace("**Note:**", "**📝 Note:**");
-
-      if (line.substring(0, 4) === "### ")
-        return line
-          .replace("### Features", "### 🚀 Enhancements")
-          .replace("### Bug Fixes", "### 🩹 Fixes")
-          .replace("### Chore", "### 🏡 Chore")
-          .replace("### Performance Improvements", "### 🔥 Performance");
-
-      return line;
-    });
-
-    return lines.join("\n");
-  });
-
-  await filePaths.forEach((file, idx) => {
-    writeFileSync(file, changelogs[idx]);
-  });
-};

package/src/commands/version/version.ts

@@ -1,33 +0,0 @@
-import { lerna } from "src/scripts/lerna";
-import { git } from "src/scripts/git";
-import type { VersionOptions } from "./VersionOptions";
-import { log } from "./log";
-import { getPreid } from "./getPreid";
-import { pimpChangelogs } from "./pimpChangelogs";
-
-export const version = async (options: VersionOptions) => {
-  const { pre, dev, changelog, commit, yes } = options;
-
-  lerna.version({
-    conventionalCommits: true,
-    conventionalGraduate: (!dev && !pre) || undefined,
-    conventionalPrerelease: !!dev || !!pre || undefined,
-    preid: dev ? "dev" : getPreid(pre),
-    includeMergedTags: true,
-    gitTagVersion: false,
-    private: false,
-    push: false,
-    changelog,
-    yes,
-  });
-
-  if (changelog) await pimpChangelogs();
-
-  if (commit) {
-    log.info("Commit changes.");
-    const msg = commit === true ? "chore: Prepare Release" : commit;
-    git.commit({
-      m: msg,
-    });
-  }
-};

package/src/constants.ts

@@ -1,5 +0,0 @@
-import { bin, version } from "../package.json";
-
-export const PROGRAM_NAME = Object.keys(bin)[0];
-export const VERSION = version;
-export const CONFIG_FILE = `${PROGRAM_NAME}.json`;

package/src/index.ts

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-import { program } from "commander";
-import { PROGRAM_NAME, VERSION } from "./constants";
-import commands from "./commands";
-import { preAction } from "./preAction";
-
-program
-  .name(PROGRAM_NAME)
-  .description(
-    "A collection of commands and scripts for helping running, building, deploying and assisting in developing with Gluhar, Vue, Nuxt, Tailwind & Sanity."
-  )
-  .version(VERSION, "-v, --version", "Output the version number.")
-  .helpOption("-h, --help", "Display help for a command.")
-  .option("-l, --log-level <level>", "Set log level.", "info")
-  .option("-lp, --log-prefix <prefixes...>", "Set log prefixes.")
-  .option("--ci", "Enable CI mode. Full logging and no prompts.", false)
-  .option("--cwd <path>", "The current working directory for the scripts.")
-  .usage("<command> [options]")
-  .hook("preAction", preAction)
-  .action(() => program.outputHelp());
-
-commands.forEach((cmd) => program.addCommand(cmd));
-
-program.parse(process.argv);

package/src/preAction.ts

@@ -1,93 +0,0 @@
-import { existsSync } from "fs";
-import type { Command } from "commander";
-import { confirmQuestion, init, logger } from "./utils";
-import type { GlobalOptions } from "./GlobalOptions";
-import { cmd, executeCmd, getCmdOutput } from "./scripts/cmd";
-import { PROGRAM_NAME, VERSION } from "./constants";
-import { git } from "./scripts/git";
-// import { getConfigOpt, setConfigOpt } from './config';
-
-const getOptions = <T>(command: Command) => command.opts() as T;
-const log = logger("cli");
-
-// const loadConfig = (rootCmd: Command, actionCmd: Command) => {
-//   const config = getConfigOpt(actionCmd.name());
-//   setConfigOpt(config, rootCmd, actionCmd);
-// };
-
-const setupCi = (rootCmd: Command, actionCmd: Command) => {
-  const { ci } = getOptions<GlobalOptions>(rootCmd);
-  const ciSource = rootCmd.getOptionValueSource("ci") ?? "implied";
-
-  if (ci) {
-    rootCmd.setOptionValueWithSource("yes", true, ciSource);
-    actionCmd.setOptionValueWithSource("yes", true, ciSource);
-    rootCmd.setOptionValueWithSource("logLevel", "verbose", ciSource);
-    rootCmd.setOptionValueWithSource("logPrefix", undefined, ciSource);
-  }
-};
-
-const setupLogging = (rootCmd: Command) => {
-  const { logLevel, logPrefix } = getOptions<GlobalOptions>(rootCmd);
-  init(PROGRAM_NAME, logLevel, logPrefix);
-};
-
-const setup = (rootCmd: Command, actionCmd: Command) => {
-  setupCi(rootCmd, actionCmd);
-  setupLogging(rootCmd);
-};
-
-const logCli = (actionCmd: Command) => {
-  log.notice(`v${VERSION}`);
-
-  log.verbose("Calling command:", actionCmd.name());
-  log.verbose("arguments:", actionCmd.args);
-  log.verbose("options:", getOptions(actionCmd));
-  log.verbose("cwd:", process.cwd());
-};
-
-const checkCliVersion = async () => {
-  const hasGit = existsSync(".git");
-  if (hasGit && git.getRepo() === "gluhar") return;
-
-  const latestVersion = getCmdOutput("npm show @gluhar/cli version");
-
-  // Version is up to date
-  if (latestVersion === VERSION) return;
-
-  // Version is old, ask to install latest
-  const installLatest = await confirmQuestion(
-    `There is a newer version of the gluhar/cli available (v${latestVersion}). \nDo you want to install it now? (npm i -g @gluhar/cli)`
-  );
-  if (installLatest) {
-    executeCmd("npm i -g @gluhar/cli@latest");
-
-    // If we are in a project, also update the local version
-    const isLocal = !getCmdOutput("npm list @gluhar/cli --depth=0").includes(
-      "empty"
-    );
-    if (isLocal) executeCmd("npm update @gluhar/cli");
-  }
-};
-
-export const preAction = async (rootCmd: Command, actionCmd: Command) => {
-  // setup logging before loadConfig, so we can get logging from loadConfig
-  setup(rootCmd, actionCmd);
-
-  const { cwd: initCwd } = getOptions<GlobalOptions>(rootCmd);
-  if (initCwd) cmd.cd(initCwd);
-
-  // Check for newer cli version
-  await checkCliVersion();
-
-  // loadConfig(rootCmd, actionCmd);
-
-  const { cwd: newCwd } = getOptions<GlobalOptions>(rootCmd);
-  if (newCwd && newCwd !== initCwd) cmd.cd(newCwd);
-
-  // setup logging after loadConfig so we apply options from config
-  setup(rootCmd, actionCmd);
-
-  logCli(actionCmd);
-  if (initCwd) log.notice("from", initCwd);
-};

package/src/scripts/cmd/cd.ts

@@ -1,9 +0,0 @@
-import shell from 'shelljs';
-import { log } from './log';
-
-export const cd = (path: string) => {
-  const oldDir = process.cwd();
-  shell.cd(path);
-  const newDir = process.cwd();
-  log.verbose(`cd ${path}: ${oldDir} -> ${newDir}`);
-};

package/src/scripts/cmd/executeCmd.ts

@@ -1,23 +0,0 @@
-import { spawnSync } from 'child_process';
-import { log } from './log';
-import type { Args } from './types';
-import { parseArgs } from './parseArgs';
-
-/**
- * Function that executes a bash script from string.
- * @param cmd A one-line string of a bash command: 'npm install'.
- * @param args Option flags to pass to the script: { m: 'Message', msg: 'asdf' }.
- * @returns Executes the bash script in the same stdio.
- */
-export const executeCmd = (cmd: string, args?: Args) => {
-  const cmdArgs = [cmd];
-  if (args) {
-    cmdArgs.push(...parseArgs(args));
-  }
-
-  const fullCmd = cmdArgs.join(' ');
-  log.verbose('executeCmd:', fullCmd);
-  return spawnSync(fullCmd, { stdio: 'inherit', shell: true });
-};
-
-// TODO make an async option

package/src/scripts/cmd/getCmdOutput.ts

@@ -1,26 +0,0 @@
-import { execSync } from 'child_process';
-import { log } from './log';
-import type { Args } from './types';
-import { parseArgs } from './parseArgs';
-
-/**
- * A function that runs a bash script from a string and returns the output.
- * Mainly used in js logic if you want the output of a bash script.
- * @param cmd A one-line string of a bash command: 'npm install'.
- * @param args Option flags to pass to the script: { m: 'Message', msg: 'asdf' }.
- * @returns The output of the command as a string.
- */
-export const getCmdOutput = (cmd: string, args?: Args) => {
-  const cmdArgs = [cmd];
-  if (args) {
-    cmdArgs.push(...parseArgs(args));
-  }
-
-  const fullCmd = cmdArgs.join(' ');
-  log.verbose('getCmdOutput:', fullCmd);
-  return execSync(fullCmd).toString().trim();
-};
-
-// TODO make an async option
-// TODO get output from a script file?
-// TODO maybe utilise the other two function instead of execSync?

package/src/scripts/cmd/log.ts

@@ -1,3 +0,0 @@
-import { logger } from 'src/utils';
-
-export const log = logger('cmd');

package/src/scripts/cmd/parseArgs.ts

@@ -1,44 +0,0 @@
-import humps from "humps";
-import type { Args, NotNullableProps, ParsedArg } from "./types";
-
-const hyphenize = (s: string) => humps.decamelize(s, { separator: "-" });
-
-const hasValue = (arg: ParsedArg): arg is NotNullableProps<ParsedArg> => {
-  return arg.value !== undefined;
-};
-
-export const parseArgs = (args: Args): string[] => {
-  return Object.entries(args)
-    .map(
-      ([name, value]): ParsedArg => ({
-        name,
-        parsedName: hyphenize(name),
-        value,
-        parsedValue: JSON.stringify(value),
-      })
-    )
-    .filter(hasValue)
-    .reduce((result, { name, parsedName, value, parsedValue }) => {
-      if (name.length > 1) {
-        result.push(`--${parsedName}`);
-      } else {
-        result.push(`-${parsedName}`);
-      }
-      value.toString();
-
-      if (value !== true) {
-        let v = parsedValue;
-        if (
-          v.length > 2 &&
-          v[0] === '"' &&
-          v[v.length - 1] === '"' &&
-          !v.includes(" ")
-        )
-          v = v.slice(1, -1);
-
-        result.push(v);
-      }
-
-      return result;
-    }, [] as string[]);
-};

package/src/scripts/cmd/parseBashArgs.ts

@@ -1,21 +0,0 @@
-import { log } from './log';
-import type { Args } from './types';
-import { parseArgs } from './parseArgs';
-
-export const parseBashArgs = (
-  path: string,
-  args?: Args,
-  absolute?: boolean,
-) => {
-  const filePath = path.endsWith('.sh') ? path : `${path}.sh`;
-  const absolutePath = !absolute ? `${__dirname}/../${filePath}` : filePath;
-  const flags = [absolutePath];
-
-  if (args) {
-    flags.push(...parseArgs(args));
-  }
-
-  log.verbose('executeBash:', flags.join(' '));
-
-  return flags;
-};

package/src/scripts/cmd/types.ts

@@ -1,13 +0,0 @@
-export type ArgValue = string | number | boolean;
-export type Args = Record<string, ArgValue | undefined> | {};
-
-export interface ParsedArg {
-  name: string;
-  parsedName: string;
-  value: ArgValue | undefined;
-  parsedValue: string | undefined;
-}
-
-export type NotNullableProps<T> = {
-  [K in keyof T]: NonNullable<T[K]>;
-};

package/src/scripts/filesystem/copyDir.ts

@@ -1,29 +0,0 @@
-import { join, relative } from "path";
-import { copyFiles, FileInfoUpdate } from "./copyFiles";
-import { log } from "./log";
-
-/**
- * Function that copies all files recursively from one dir to another allowing to update their content in the process.
- * @param sourcePath Directory of files to copy recursively.
- * @param destinationPath Destination directory to place files.
- * @param updateContent Optional function that updates the contents of each file.
- */
-export const copyDir = (
-  sourcePath: string,
-  destinationPath: string,
-  updateFile?: FileInfoUpdate
-) => {
-  log.verbose("copyDir", { sourcePath, destinationPath });
-  const glob = join(sourcePath, "**", "*.*");
-
-  return copyFiles([glob], (file) => {
-    const newDir = join(destinationPath, relative(sourcePath, file.dir));
-    log.verbose("copyDir file from", file.dir, "to", newDir);
-    const f = updateFile ? updateFile(file) : file;
-
-    return {
-      ...f,
-      dir: newDir,
-    };
-  });
-};

package/src/scripts/filesystem/copyFiles.ts

@@ -1,75 +0,0 @@
-import { mkdir, readFile, writeFile } from "fs/promises";
-import { glob } from "glob";
-import { type ParsedPath, parse, resolve, format } from "path";
-import { exists } from "fs-extra";
-import { log } from "./log";
-
-export interface FileInfo extends Omit<ParsedPath, "root"> {
-  name: string;
-  content: string;
-  encoding: BufferEncoding;
-}
-
-export type FileInfoUpdate = (fileInfo: FileInfo) => Partial<FileInfo>;
-
-export const loadFiles = async (globs: string[]): Promise<FileInfo[]> => {
-  const { isText } = await import("istextorbinary");
-
-  log.verbose("Globs:", globs);
-  const filePaths = await glob(globs, {
-    nodir: true,
-    dot: true,
-    nocase: true,
-  });
-  log.verbose("Loaded files:", filePaths.length);
-
-  const files = filePaths.map(async (path): Promise<FileInfo> => {
-    const encoding = isText(path) ? "utf-8" : "binary";
-
-    return {
-      ...parse(path),
-      content: await readFile(path, encoding),
-      encoding,
-    };
-  });
-
-  return Promise.all(files);
-};
-
-export const updateFiles = (
-  files: FileInfo[],
-  update: FileInfoUpdate
-): FileInfo[] => {
-  return files.map((original): FileInfo => {
-    log.verbose("Updating file", original.dir, original.base);
-    const updated = update(original);
-    return {
-      ...original,
-      ...updated,
-    };
-  });
-};
-
-const getPath = (relative: string) => resolve(process.cwd(), relative);
-
-const write = async (files: FileInfo[]) => {
-  const writes = files.map(async (file) => {
-    const dirPath = getPath(file.dir);
-    const dirExists = await exists(dirPath);
-    if (!dirExists) {
-      await mkdir(dirPath, { recursive: true });
-    }
-
-    const filePath = getPath(format(file));
-    log.verbose("Writing file", filePath);
-    await writeFile(filePath, file.content, file.encoding);
-  });
-
-  await Promise.all(writes);
-};
-
-export const copyFiles = async (globs: string[], update: FileInfoUpdate) => {
-  const files = await loadFiles(globs);
-  const updatedFiles = updateFiles(files, update);
-  await write(updatedFiles);
-};