ccommit 4.2.0-canary.1 → 4.2.0

package/src/lib/index.ts

@@ -1,107 +0,0 @@
-const COMMANDS = {
-  COMMIT: "commit",
-  HOOK: "hook",
-  LIST: "list",
-};
-const COMMIT_FORMATS = {
-  CONVENTIONAL: "conventional",
-  CONVENTIONAL_NO_EMOJI: "conventional-no-emoji",
-  GITMOJI: "gitmoji",
-};
-
-const COMMIT_MODES = {
-  CLIENT: "client",
-  HOOK: "hook",
-};
-
-const FIND_BY = {
-  EMOJI: "emoji",
-  TYPE: "type",
-};
-
-const FLAGS = Object.freeze({
-  BREAKING: "breaking",
-  COMMIT: "commit",
-  DRYRUN: "dryrun",
-  EMOJI: "emoji",
-  HELP: "help",
-  HOOK: "hook",
-  LIST: "list",
-  SKIP: "skip",
-  VERSION: "version",
-});
-
-const FORMAT = {
-  [COMMIT_FORMATS.CONVENTIONAL]: "{type}{scope}{breaking}: {emoji}{title}",
-  [COMMIT_FORMATS.CONVENTIONAL_NO_EMOJI]: "{type}{scope}{breaking}: {title}",
-  [COMMIT_FORMATS.GITMOJI]: "{emoji}{breaking}{scope}{title}",
-};
-
-const LOGS = {
-  MESSAGES: {
-    COMMAND_LINE_WITHOUT_REQUIRED: "❯ Command line option requires both: --title, --type",
-    COMMIT_FAIL: `❯ \n
-      ❯ Oops! An error occurred. There is likely additional logging output above.\n
-      ❯ You can run the same commit with this command:\n
-      ❯ \t
-      {REPLACE}
-    `,
-    GENERATOR_TAKING_OVER: "❯ Generator will take it from here (CTRL+C to quit)",
-    MODE_CONFLICT: "❯ Please choose one or the other: --commit, -c | --hook, -u",
-    REPLACE: "{REPLACE}",
-    STAGED_FILES: "❯ There are no staged files for git. Did you mean to do a dry-run (-n)?",
-    TYPE_INCORRECT: "❯ There is no gitmoji/type associated with: {REPLACE}",
-  },
-  TYPES: {
-    ERROR: "error",
-    INFO: "info",
-    SUCCESS: "success",
-    WARNING: "warning",
-  },
-};
-
-const OPTIONS = Object.freeze({
-  FORMAT: "format",
-  MESSAGE: "message",
-  SCOPE: "scope",
-  TITLE: "title",
-  TYPE: "type",
-});
-
-const SCOPE = {
-  MAX: 12,
-  MIN: 3,
-};
-
-const SEMVER = {
-  MAJOR: "major",
-  MINOR: "minor",
-  NULL: "null",
-  PATCH: "patch",
-};
-
-const TITLE = {
-  MAX: 48,
-  MAX_SWAG: 40,
-  MIN: 3,
-  MIN_SWAG: 15,
-};
-
-const TYPE = {
-  MAX: 15,
-};
-
-export {
-  COMMANDS,
-  COMMIT_FORMATS,
-  COMMIT_MODES,
-  FIND_BY,
-  FLAGS,
-  FORMAT,
-  LOGS,
-  OPTIONS,
-  SCOPE,
-  SEMVER,
-  TITLE,
-  TYPE,
-};

package/src/utils/cancel-if.ts

@@ -1,43 +0,0 @@
-/*!
- * reference: https://github.com/carloscuesta/gitmoji-cli
- */
-import fs from "node:fs";
-import process from "node:process";
-
-import { execa } from "execa";
-
-const cancelIfRebasing = (): Promise<void> =>
-  execa("git", ["rev-parse", "--absolute-git-dir"]).then(({ stdout: gitDirectory }) => {
-    // see https://stackoverflow.com/questions/3921409/how-to-know-if-there-is-a-git-rebase-in-progress
-    // to understand how a rebase is detected
-    if (
-      fs.existsSync(gitDirectory + "/rebase-merge") ||
-      fs.existsSync(gitDirectory + "/rebase-apply")
-    ) {
-      process.exit(0);
-    }
-  });
-
-const COMMIT_MESSAGE_SOURCE = 4;
-
-const cancelIfAmending = (): Promise<void> =>
-  new Promise<void>((resolve) => {
-    /*
-      from https://git-scm.com/docs/githooks#_prepare_commit_msg
-      the commit message source is passed as second argument and corresponding 4 for ccommit
-      `gitmoji --hook $1 $2`
-    */
-    const commitMessageSource: string = process.argv[COMMIT_MESSAGE_SOURCE];
-    if (
-      commitMessageSource &&
-      (commitMessageSource.startsWith("commit") || commitMessageSource.startsWith("merge"))
-    ) {
-      process.exit(0);
-    }
-    resolve();
-  });
-
-// I avoid Promise.all to avoid race condition in future cancel callbacks
-const cancelIfNeeded = (): Promise<void> => cancelIfAmending().then(cancelIfRebasing);
-
-export { COMMIT_MESSAGE_SOURCE, cancelIfAmending, cancelIfNeeded, cancelIfRebasing };

package/src/utils/filter.ts

@@ -1,23 +0,0 @@
-import Fuse from "fuse.js";
-
-const options = {
-  keys: [
-    {
-      name: "type",
-      weight: 0.44,
-    },
-    {
-      name: "description",
-      weight: 0.56,
-    },
-  ],
-  threshold: 0.4,
-};
-
-const filterGitmojis = (input: string, gitmojis: any) => {
-  const fuse = new Fuse(gitmojis, options);
-
-  return input ? fuse.search(input).map((gitmoji) => gitmoji.item) : gitmojis;
-};
-
-export { filterGitmojis };

package/src/utils/find-by.ts

@@ -1,8 +0,0 @@
-import commitTypes from "../data/types.ts";
-
-const findBy = (str, from, to): string | undefined => {
-  const key = commitTypes.findIndex((el) => el[from] === str);
-  return commitTypes[key]?.[to];
-};
-
-export { findBy };

package/src/utils/find-command.ts

@@ -1,80 +0,0 @@
-import process from "node:process";
-
-import { COMMIT_FORMATS, COMMIT_MODES, FLAGS, LOGS, OPTIONS } from "../lib/index.ts";
-import { generateLog, getStagedFiles } from "./index.ts";
-
-const getOptionsForCommand = (command: string, flags: any): any => {
-  const commandsWithOptions = [FLAGS.COMMIT, FLAGS.HOOK];
-
-  // @ts-ignore
-  if (commandsWithOptions.includes(command)) {
-    const options = {
-      dryrun: flags[FLAGS.DRYRUN],
-      emoji: flags[FLAGS.EMOJI],
-      // options
-      format:
-        flags[OPTIONS.FORMAT] === COMMIT_FORMATS.CONVENTIONAL
-          ? flags[FLAGS.EMOJI]
-            ? COMMIT_FORMATS.CONVENTIONAL
-            : COMMIT_FORMATS.CONVENTIONAL_NO_EMOJI
-          : COMMIT_FORMATS.GITMOJI,
-      message: flags[OPTIONS.MESSAGE],
-      mode: command === FLAGS.HOOK ? COMMIT_MODES.HOOK : COMMIT_MODES.CLIENT,
-      scope: flags[OPTIONS.SCOPE],
-      skip: flags[FLAGS.SKIP],
-      title: flags[OPTIONS.TITLE],
-      type: flags[OPTIONS.TYPE],
-    };
-
-    return options;
-  }
-
-  return null;
-};
-
-// @todo(lint) complexity: 11
-// oxlint-disable-next-line complexity
-const findCommand = (cli: any, options: any): void => {
-  const flags = cli.flags;
-  const commandFlag = Object.keys(flags)
-    .map((flag) => flags[flag] && flag)
-    .find((flag) => options[flag]);
-
-  const filesChanged = getStagedFiles();
-
-  if (!flags[FLAGS.DRYRUN] && !filesChanged) {
-    console.log(generateLog(LOGS.TYPES.ERROR, LOGS.MESSAGES.STAGED_FILES));
-    process.exit(2);
-  }
-
-  if (flags[FLAGS.COMMIT] && flags[FLAGS.HOOK]) {
-    console.log(generateLog(LOGS.TYPES.ERROR, LOGS.MESSAGES.MODE_CONFLICT));
-    process.exit(2);
-  }
-
-  if (
-    flags[OPTIONS.MESSAGE] ||
-    flags[OPTIONS.SCOPE] ||
-    flags[OPTIONS.TITLE] ||
-    flags[OPTIONS.TYPE]
-  ) {
-    flags[FLAGS.SKIP] = true;
-  }
-
-  if (flags[FLAGS.SKIP]) {
-    if (flags[OPTIONS.TITLE] && flags[OPTIONS.TYPE]) {
-      flags[FLAGS.SKIP] = true;
-    } else {
-      flags[FLAGS.SKIP] = false;
-      console.log(generateLog(LOGS.TYPES.ERROR, LOGS.MESSAGES.COMMAND_LINE_WITHOUT_REQUIRED));
-      flags[OPTIONS.TITLE] = undefined;
-      flags[OPTIONS.TYPE] = undefined;
-    }
-  }
-
-  const commandOptions = getOptionsForCommand(commandFlag, flags);
-
-  return options[commandFlag] ? options[commandFlag](commandOptions) : cli.showHelp();
-};
-
-export { findCommand };

package/src/utils/format.ts

@@ -1,51 +0,0 @@
-import { COMMIT_FORMATS, FORMAT, TYPE } from "../lib/index.ts";
-
-const formatCliEmoji = ({ emoji, emojiLength }) =>
-  emojiLength === 0 ? `${emoji}     ` : `${emoji}    `;
-
-const formatCliType = (type) => type?.padEnd(TYPE.MAX);
-
-const formatCliTypes = (commitTypes: any) => {
-  // console.log(`EMOJI  TYPE            DESCRIPTION`)
-  // console.log(`-----  ----            -----------`)
-  return commitTypes.map(({ description, emoji, emojiLength, type }) => {
-    console.log(
-      `${formatCliEmoji({
-        emoji,
-        emojiLength,
-      })} ${formatCliType(type)} ${description}`,
-    );
-  });
-};
-
-// oxlint-disable-next-line complexity
-const formatCommitSubject = (options, answers) => {
-  const format = FORMAT[options?.format];
-
-  // @note(ccommit) two spaces after emoji
-  const emoji = answers?.gitmoji ? `${answers?.gitmoji}  ` : "";
-
-  let scope = answers?.scope
-    ? `(${answers?.scope.replace(/ {2}/g, "--").replace(/ /g, "-").toLowerCase().trim()})`
-    : "";
-  // @note(ccommit) only add space to scope if format is: gitmoji
-  scope = scope && options?.format === COMMIT_FORMATS.GITMOJI ? `${scope} ` : scope;
-
-  /**
-   * @todo(ccommit) breaking identification in commit subject
-   */
-  // const breaking = answers?.breaking
-  //   ? options?.format === COMMIT_FORMATS.GITMOJI
-  //     ? `💥 `
-  //     : '!'
-  //   : ''
-
-  return format
-    .replace(/\{emoji\}/g, emoji)
-    .replace(/\{scope\}/g, scope)
-    .replace(/\{breaking\}/g, "")
-    .replace(/\{title\}/g, answers?.title)
-    .replace(/\{type\}/g, answers?.type);
-};
-
-export { formatCliEmoji, formatCliType, formatCliTypes, formatCommitSubject };

package/src/utils/generate-log.ts

@@ -1,40 +0,0 @@
-import colors from "ansi-colors";
-
-import { LOGS } from "../lib/index.ts";
-
-type GenerateLog = (type: string, message: string, replace?: string) => void;
-/**
- * @todo(ccommit) this is a bit much, can we reduce?
- */
-const generateLog: GenerateLog = (type, message, replace) => {
-  let msg = replace ? message.replace(/\{REPLACE\}/g, replace) : message;
-  msg = `\n${msg}\n`;
-
-  if (type === LOGS.TYPES.ERROR) {
-    return colors.magenta.bold(msg);
-  }
-  if (type === LOGS.TYPES.INFO) {
-    return colors.blue.bold(msg);
-  }
-  if (type === LOGS.TYPES.WARNING) {
-    return colors.yellow.bold(msg);
-  }
-  return colors.green.bold(msg);
-};
-
-const generateCount: GenerateLog = (type, message, replace) => {
-  const msg = replace ? message.replace(/\{REPLACE\}/g, replace) : message;
-
-  if (type === LOGS.TYPES.ERROR) {
-    return colors.red.bold(msg);
-  }
-  if (type === LOGS.TYPES.INFO) {
-    return colors.white.bold(msg);
-  }
-  if (type === LOGS.TYPES.WARNING) {
-    return colors.yellow.bold(msg);
-  }
-  return colors.green.bold(msg);
-};
-
-export { generateCount, generateLog };

package/src/utils/get-chars-left.ts

@@ -1,17 +0,0 @@
-import { LOGS, TITLE } from "../lib/index.ts";
-import { generateCount } from "./index.ts";
-
-const getCharsLeft = (str: string) => {
-  const chars = str.length;
-  const message = chars.toString();
-  let logType = LOGS.TYPES.SUCCESS;
-
-  if (chars < TITLE.MIN || chars > TITLE.MAX) {
-    logType = LOGS.TYPES.ERROR;
-  } else if (chars < TITLE.MIN_SWAG || chars > TITLE.MAX_SWAG) {
-    logType = LOGS.TYPES.WARNING;
-  }
-  return generateCount(logType, LOGS.MESSAGES.REPLACE, message);
-};
-
-export { getCharsLeft };

package/src/utils/get-git-root-dir.ts

@@ -1,12 +0,0 @@
-import { execSync } from "node:child_process";
-
-const getGitRootDir = () => {
-  const devNull = process.platform === "win32" ? " nul" : "/dev/null";
-  const dir = execSync("git rev-parse --show-toplevel 2>" + devNull)
-    .toString()
-    .trim();
-
-  return dir;
-};
-
-export { getGitRootDir };

package/src/utils/get-issue-tracker.ts

@@ -1,24 +0,0 @@
-import { execSync } from "node:child_process";
-
-const getIssueTracker = () => {
-  let branch: any,
-    init = "";
-
-  //  branch = 'ABC-123'
-  branch = execSync("git rev-parse --abbrev-ref HEAD");
-  branch = branch.toString().trim().split("/");
-  const branchType = branch[0];
-  const branchName = !branch[1] ? branchType : branch[1];
-
-  const it = branchName.split("-");
-  const itProject = it[0];
-  const itNumber = !it[1] ? itProject : it[1];
-  const itTicket = `${itProject}-${itNumber}`;
-
-  if (!isNaN(parseFloat(itNumber)) && isFinite(parseFloat(itNumber))) {
-    init = itTicket;
-  }
-  return init;
-};
-
-export { getIssueTracker };

package/src/utils/get-staged-files.ts

@@ -1,9 +0,0 @@
-import { execSync } from "node:child_process";
-
-const getStagedFiles = () => {
-  const stagedFiles = execSync("git diff --name-only --staged").toString().trim();
-
-  return !!stagedFiles;
-};
-
-export { getStagedFiles };

package/src/utils/index.ts

@@ -1,17 +0,0 @@
-export {
-  COMMIT_MESSAGE_SOURCE,
-  cancelIfAmending,
-  cancelIfNeeded,
-  cancelIfRebasing,
-} from "./cancel-if.ts";
-export { filterGitmojis } from "./filter.ts";
-export { findBy } from "./find-by.ts";
-export { findCommand } from "./find-command.ts";
-export { formatCliEmoji, formatCliType, formatCliTypes, formatCommitSubject } from "./format.ts";
-export { generateCount, generateLog } from "./generate-log.ts";
-export { getCharsLeft } from "./get-chars-left.ts";
-export { getGitRootDir } from "./get-git-root-dir.ts";
-export { getIssueTracker } from "./get-issue-tracker.ts";
-export { getStagedFiles } from "./get-staged-files.ts";
-export { printDryRun } from "./print-dry-run.ts";
-export { registerHookInterruptionHandler } from "./register-hook-interruption-handler.ts";

package/src/utils/print-dry-run.ts

@@ -1,7 +0,0 @@
-import colors from "ansi-colors";
-
-const printDryRun = (v) => {
-  console.log(colors.magenta.bold(`❯ dry-run mode: ${v}\n`));
-};
-
-export { printDryRun };

package/src/utils/register-hook-interruption-handler.ts

@@ -1,16 +0,0 @@
-/*!
- * reference: https://github.com/carloscuesta/gitmoji-cli
- */
-import process from "node:process";
-
-import colors from "ansi-colors";
-
-const registerHookInterruptionHandler = () => {
-  // Allow to interrupt the hook without cancelling the commit
-  process.on("SIGINT", () => {
-    console.log(colors.magenta.bold("❯ [ccommit] interrupted"));
-    process.exit(0);
-  });
-};
-
-export { registerHookInterruptionHandler };

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src"
-  },
-  "exclude": ["node_modules", "release.config.js"],
-  "extends": "@jeromefitz/tsconfig/src/node24.json",
-  "include": ["src"]
-}

package/tsdown.config.ts

@@ -1,44 +0,0 @@
-import { readFileSync, writeFileSync } from "node:fs";
-
-import type { UserConfig } from "tsdown";
-import { defineConfig } from "tsdown";
-
-import { config as _config } from "../../tsdown.config.ts";
-
-const GITMOJI_CLI_LICENSE = `MIT License
-
-Copyright (c) 2016-2022 Carlos Cuesta
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-`;
-
-const entry = ["src/index.ts"];
-const config: UserConfig = {
-  ..._config,
-  entry,
-  onSuccess: () => {
-    const license = readFileSync("../../LICENSE", "utf8");
-    writeFileSync("./dist/index.mjs.LICENSE.txt", `${license}\n${GITMOJI_CLI_LICENSE}`);
-  },
-  treeshake: true,
-};
-
-export default defineConfig({
-  ...config,
-});