lintlane 2.5.0 → 4.0.0

package/bin/commit-lint.mjs

@@ -1,143 +0,0 @@
-// Conventional Commits rules. Plain Node (no Bun APIs, no dependencies):
-// git hooks run this on every teammate's machine, whatever package manager
-// or runtime they use.
-
-export const TYPES = [
-  ["feat", "A new feature"],
-  ["fix", "A bug fix"],
-  ["docs", "Documentation only"],
-  ["style", "Formatting only, no code change"],
-  ["refactor", "Code change that neither fixes a bug nor adds a feature"],
-  ["perf", "A performance improvement"],
-  ["test", "Adding or fixing tests"],
-  ["build", "Build system or dependencies"],
-  ["ci", "CI configuration"],
-  ["chore", "Other changes that don't touch src or tests"],
-  ["revert", "Reverts a previous commit"],
-];
-
-// Same defaults as Commitizen's `cz check --allowed-prefixes`: messages git or
-// GitHub generate themselves.
-export const DEFAULT_ALLOWED_PREFIXES = [
-  "Merge",
-  "Revert",
-  "Pull request",
-  "fixup!",
-  "squash!",
-  "amend!",
-];
-
-export const DEFAULT_MAX_HEADER = 100;
-export const EXAMPLE = "feat(auth): add login form";
-
-const HEADER = /^([a-z]+)(?:\(([^()]+)\))?(!)?: (.*)$/;
-const LOOSE_HEADER = /^([A-Za-z]+)(?:\(([^()]*)\))?(!)?:/;
-
-/**
- * Merge user options (from package.json "lintlane".commit or CLI flags) over
- * the defaults. `types` may be a list of names, [name, description] pairs, or
- * an object of { name: description }. A max header of 0 turns the limit off.
- */
-export function resolveOptions(options = {}) {
-  let types = TYPES;
-  if (Array.isArray(options.types) && options.types.length > 0) {
-    types = options.types.map((t) => (Array.isArray(t) ? [t[0], t[1] ?? ""] : [String(t), ""]));
-  } else if (options.types && typeof options.types === "object" && !Array.isArray(options.types)) {
-    types = Object.entries(options.types).map(([name, description]) => [name, String(description)]);
-  }
-  const limit = Number(options.messageLengthLimit ?? options.maxHeader);
-  return {
-    types,
-    maxHeader: Number.isFinite(limit) && limit >= 0 ? limit : DEFAULT_MAX_HEADER,
-    allowedPrefixes: [
-      ...DEFAULT_ALLOWED_PREFIXES,
-      ...(Array.isArray(options.allowedPrefixes) ? options.allowedPrefixes : []),
-    ],
-    allowAbort: Boolean(options.allowAbort),
-  };
-}
-
-/** Drop git's "# ..." comment lines and surrounding blank space. */
-export function cleanMessage(raw) {
-  return raw
-    .split("\n")
-    .filter((line) => !line.startsWith("#"))
-    .join("\n")
-    .trim();
-}
-
-export function validateMessage(raw, options) {
-  const opts = resolveOptions(options);
-  const message = cleanMessage(raw);
-  if (!message) {
-    return opts.allowAbort
-      ? { valid: true, errors: [], skipped: true }
-      : { valid: false, errors: ["The commit message is empty."] };
-  }
-
-  const [header, ...rest] = message.split("\n");
-  if (opts.allowedPrefixes.some((prefix) => header.startsWith(prefix))) {
-    return { valid: true, errors: [], skipped: true };
-  }
-
-  const errors = [];
-  const typeNames = opts.types.map(([type]) => type);
-  const match = HEADER.exec(header);
-
-  if (!match) {
-    const loose = LOOSE_HEADER.exec(header);
-    if (loose && loose[1] !== loose[1].toLowerCase()) {
-      errors.push(`The type "${loose[1]}" must be lowercase ("${loose[1].toLowerCase()}").`);
-    } else if (loose && header.slice(loose[0].length, loose[0].length + 1) !== " ") {
-      errors.push('Put a space after the colon: "type: subject".');
-    } else {
-      errors.push(`The header must look like "type(scope): subject", e.g. "${EXAMPLE}".`);
-    }
-  } else {
-    const [, type, , , subject] = match;
-    if (!typeNames.includes(type)) {
-      errors.push(`Unknown type "${type}". Use one of: ${typeNames.join(", ")}.`);
-    }
-    if (!subject.trim()) errors.push("The subject after the colon can't be empty.");
-    if (subject.trim().endsWith(".")) errors.push("The subject shouldn't end with a period.");
-  }
-
-  if (opts.maxHeader > 0 && header.length > opts.maxHeader) {
-    errors.push(`The header is ${header.length} characters; keep it under ${opts.maxHeader}.`);
-  }
-  if (rest.length > 0 && rest[0].trim() !== "") {
-    errors.push("Leave a blank line between the header and the body.");
-  }
-
-  return { valid: errors.length === 0, errors };
-}
-
-/** Build the final message from the prompt's answers. */
-export function buildMessage({ type, scope, subject, body, breaking, footer }) {
-  const header = `${type}${scope ? `(${scope})` : ""}${breaking ? "!" : ""}: ${subject}`;
-  const parts = [header];
-  if (body) parts.push(body);
-  const footers = [];
-  if (breaking) footers.push(`BREAKING CHANGE: ${breaking}`);
-  if (footer) footers.push(footer);
-  if (footers.length > 0) parts.push(footers.join("\n"));
-  return parts.join("\n\n");
-}
-
-export function explainFailure(errors, options) {
-  const { types } = resolveOptions(options);
-  return [
-    "",
-    "✘ Commit message rejected",
-    "",
-    ...errors.map((error) => `  • ${error}`),
-    "",
-    "  Format:   type(scope): subject",
-    `  Example:  ${EXAMPLE}`,
-    `  Types:    ${types.map(([type]) => type).join(", ")}`,
-    "",
-    "  Not sure? Run the guided prompt:  npx lintlane commit",
-    "  (or just `git commit` with no -m, and you'll be asked step by step)",
-    "",
-  ].join("\n");
-}

package/bin/commit-msg.mjs

@@ -1,18 +0,0 @@
-// git `commit-msg` hook entry: rejects messages that aren't Conventional Commits.
-// Plain Node on purpose — see commit-lint.mjs.
-import { readFileSync } from "node:fs";
-import { loadCommitConfig } from "./commit-config.mjs";
-import { explainFailure, validateMessage } from "./commit-lint.mjs";
-
-const file = process.argv[2];
-if (!file) {
-  process.stderr.write("commit-msg: expected the path to the commit message file.\n");
-  process.exit(2);
-}
-
-const options = loadCommitConfig();
-const result = validateMessage(readFileSync(file, "utf8"), options);
-if (!result.valid) {
-  process.stderr.write(`${explainFailure(result.errors, options)}\n`);
-  process.exit(1);
-}

package/bin/commit-prompt.mjs

@@ -1,110 +0,0 @@
-// Interactive "commit with steps" prompt (the Commitizen-style flow).
-// Plain Node, readline only — no dependencies.
-import { createInterface } from "node:readline/promises";
-import { buildMessage, resolveOptions } from "./commit-lint.mjs";
-
-const supportsColor = (stream) => stream.isTTY && !process.env.NO_COLOR;
-
-/**
- * Ask the questions and return the finished message, or null if the user
- * chose not to commit. Throws if the input ends (Ctrl+C / Ctrl+D).
- */
-export async function promptCommit({
-  input = process.stdin,
-  output = process.stderr,
-  options,
-} = {}) {
-  const { types: TYPES, maxHeader: MAX_HEADER } = resolveOptions(options);
-  const typeWidth = Math.max(...TYPES.map(([type]) => type.length));
-  const rl = createInterface({ input, output });
-  const c = supportsColor(output)
-    ? {
-        b: (s) => `\x1b[1m${s}\x1b[0m`,
-        d: (s) => `\x1b[2m${s}\x1b[0m`,
-        g: (s) => `\x1b[32m${s}\x1b[0m`,
-        r: (s) => `\x1b[31m${s}\x1b[0m`,
-      }
-    : { b: (s) => s, d: (s) => s, g: (s) => s, r: (s) => s };
-  const say = (text = "") => output.write(`${text}\n`);
-
-  // Queue incoming lines so input that arrives early (pasted or piped) isn't
-  // lost between questions, and so a closed input ends the prompt instead of
-  // leaving it waiting forever.
-  const lines = rl[Symbol.asyncIterator]();
-  const ask = async (question) => {
-    rl.setPrompt(question);
-    rl.prompt();
-    const { value, done } = await lines.next();
-    if (done) throw new Error("input closed");
-    return value.trim();
-  };
-
-  try {
-    say(c.b("\nCommit — step 1/7: type of change"));
-    TYPES.forEach(([type, description], i) => {
-      say(`  ${String(i + 1).padStart(2)}. ${c.g(type.padEnd(typeWidth))} ${c.d(description)}`);
-    });
-    let type;
-    while (!type) {
-      const answer = (await ask("Choose a type (number or name): ")).toLowerCase();
-      type = TYPES.find(([name], i) => name === answer || String(i + 1) === answer)?.[0];
-      if (!type) say(c.r("  Pick one of the listed types."));
-    }
-
-    say(c.b("\nStep 2/7: scope") + c.d("  (optional — the area you changed, e.g. auth, api, ui)"));
-    let scope = "";
-    for (;;) {
-      scope = await ask("Scope (Enter to skip): ");
-      if (!/[()]/.test(scope)) break;
-      say(c.r("  Scope can't contain parentheses."));
-    }
-
-    say(c.b("\nStep 3/7: subject") + c.d("  (short, imperative: “add login form”, no period)"));
-    let subject = "";
-    for (;;) {
-      subject = await ask("Subject: ");
-      const headerLength = `${type}${scope ? `(${scope})` : ""}: ${subject}`.length;
-      if (!subject) say(c.r("  The subject is required."));
-      else if (subject.endsWith(".")) say(c.r("  Remove the trailing period."));
-      else if (MAX_HEADER > 0 && headerLength > MAX_HEADER)
-        say(c.r(`  Too long (${headerLength}/${MAX_HEADER}). Shorten it.`));
-      else break;
-    }
-
-    say(c.b("\nStep 4/7: body") + c.d("  (optional — why, not what. Empty line to finish)"));
-    const bodyLines = [];
-    for (;;) {
-      const line = await ask(bodyLines.length === 0 ? "Body (Enter to skip): " : "  …: ");
-      if (line === "") break;
-      bodyLines.push(line);
-    }
-
-    say(c.b("\nStep 5/7: breaking change?"));
-    let breaking = "";
-    if ((await ask("Does this break existing behaviour? (y/N): ")).toLowerCase().startsWith("y")) {
-      while (!breaking) {
-        breaking = await ask("Describe what breaks and how to migrate: ");
-      }
-    }
-
-    say(c.b("\nStep 6/7: footer") + c.d("  (optional — issues this closes, e.g. “Closes #123”)"));
-    const footer = await ask("Footer (Enter to skip): ");
-
-    const message = buildMessage({
-      type,
-      scope,
-      subject,
-      body: bodyLines.join("\n"),
-      breaking,
-      footer,
-    });
-    say(c.b("\nStep 7/7: confirm"));
-    say(c.d("─".repeat(40)));
-    say(message);
-    say(c.d("─".repeat(40)));
-    const confirm = (await ask("Use this message? (Y/n): ")).toLowerCase();
-    return confirm === "" || confirm.startsWith("y") ? message : null;
-  } finally {
-    rl.close();
-  }
-}

package/bin/pre-push-check.mjs

@@ -1,48 +0,0 @@
-// git `pre-push` hook entry: checks every commit that's about to be pushed.
-// This is the safety net for commits that skipped the commit-msg hook
-// (`git commit --no-verify`, a GUI client, a clone where hooks weren't installed).
-// Plain Node on purpose — see commit-lint.mjs.
-import { readFileSync } from "node:fs";
-import { describeInvalid, findInvalidCommits, listCommits } from "./check-commit.mjs";
-import { loadCommitConfig } from "./commit-config.mjs";
-
-const [remote = "origin"] = process.argv.slice(2);
-const ZERO = /^0+$/;
-
-let input = "";
-try {
-  input = readFileSync(0, "utf8");
-} catch {}
-
-const options = loadCommitConfig();
-const invalid = [];
-const seen = new Set();
-
-for (const line of input.split("\n")) {
-  const [localRef, localSha, , remoteSha] = line.trim().split(/\s+/);
-  if (!localRef || !localSha || ZERO.test(localSha)) continue; // deleting a branch
-  if (localRef.startsWith("refs/tags/")) continue;
-
-  // New branch: everything not already on a remote. Existing: just the new commits.
-  const logArgs = ZERO.test(remoteSha ?? "0")
-    ? [localSha, "--not", `--remotes=${remote}`]
-    : [`${remoteSha}..${localSha}`];
-  try {
-    for (const bad of findInvalidCommits(listCommits(logArgs), options)) {
-      if (!seen.has(bad.hash)) {
-        seen.add(bad.hash);
-        invalid.push(bad);
-      }
-    }
-  } catch {
-    // Can't inspect the range (e.g. the remote's commit isn't local). Don't block the push.
-  }
-}
-
-if (invalid.length > 0) {
-  process.stderr.write(
-    `\n✘ Push blocked: ${invalid.length} commit message(s) don't follow Conventional Commits:\n\n${describeInvalid(invalid)}\n\n` +
-      "  Reword them with `git rebase -i` (or `git commit --amend` for the latest), then push again.\n\n",
-  );
-  process.exit(1);
-}

package/bin/prepare-commit-msg.mjs

@@ -1,46 +0,0 @@
-// git `prepare-commit-msg` hook entry: when you run a plain `git commit` (no -m,
-// no template, not a merge), walk through the guided prompt and pre-fill the
-// message — the same flow as `lintlane commit`.
-// Plain Node on purpose — see commit-lint.mjs.
-import { closeSync, openSync, readFileSync, writeFileSync } from "node:fs";
-import { ReadStream } from "node:tty";
-import { loadCommitConfig } from "./commit-config.mjs";
-import { promptCommit } from "./commit-prompt.mjs";
-
-const [file, source] = process.argv.slice(2);
-
-// source is set when the message came from -m/-F, a template, a merge, a
-// squash, or an amend. Only a plain `git commit` leaves it empty.
-if (!file || source || process.env.CI || process.env.LINTLANE_NO_PROMPT) process.exit(0);
-
-// Git runs hooks with stdin detached; talk to the terminal directly. If there
-// isn't one (a GUI client, CI, a script), stay out of the way.
-let fd;
-try {
-  fd = openSync("/dev/tty", "r");
-} catch {
-  process.exit(0);
-}
-
-try {
-  const message = await promptCommit({
-    input: new ReadStream(fd),
-    output: process.stderr,
-    options: loadCommitConfig(),
-  });
-  if (message === null) {
-    process.stderr.write("\nCommit cancelled.\n");
-    process.exit(1);
-  }
-  const existing = readFileSync(file, "utf8");
-  writeFileSync(file, `${message}\n${existing}`);
-  // The open terminal handle would otherwise keep this process (and git) waiting.
-  process.exit(0);
-} catch {
-  process.stderr.write("\nCommit cancelled.\n");
-  process.exit(1);
-} finally {
-  try {
-    closeSync(fd);
-  } catch {}
-}