@drazenbebic/wdid 0.1.0 → 0.1.3

package/README.md

@@ -41,13 +41,51 @@ If a commit doesn't reference a ticket, the Ticket column is left blank (rendere
 
 ## Options
 
-| Option             | Description                                                           |
-| ------------------ | --------------------------------------------------------------------- |
-| `[date]`           | A `YYYY-MM-DD` date or the literal `today`. Omit to show all history. |
-| `--from <date>`    | Start date (inclusive).                                               |
-| `--to <date>`      | End date (inclusive).                                                 |
-| `--author <name>`  | Override the git author. Defaults to `git config user.name`.          |
-| `--repo <path...>` | One or more repo paths to query. Defaults to the current directory.   |
+| Option                     | Description                                                                                  |
+| -------------------------- | -------------------------------------------------------------------------------------------- |
+| `[date]`                   | A `YYYY-MM-DD` date or the literal `today`. Omit to show all history.                        |
+| `--from <date>`            | Start date (inclusive).                                                                      |
+| `--to <date>`              | End date (inclusive).                                                                        |
+| `--author <name>`          | Override the git author. Defaults to `git config user.name` (or `defaultAuthor` in config).  |
+| `--repo <path...>`         | One or more repo paths to query. Defaults to `defaultRepos` in config, then the current dir. |
+| `--format <preset>`        | Ticket format: `jira`, `github`, `conventional`, or `custom`. Defaults to `jira`.            |
+| `--ticket-pattern <regex>` | Custom regex for ticket extraction. Implies `--format custom`; overrides `--format`.         |
+
+## Configuration
+
+`wdid` looks for a config file in this order:
+
+1. **Repo-level** (current directory and walking up): `wdid.config.{js,cjs,mjs,ts,json,yaml,yml}`, `.wdidrc{,.json,.yaml,.yml,.js,.cjs}`, or a `"wdid"` field in `package.json`.
+2. **Global**: `~/.config/wdid/config.json` (honors `XDG_CONFIG_HOME`).
+
+CLI flags always win. The first match in this list is used in full (configs do not merge across levels).
+
+### Schema
+
+```json
+{
+  "format": "jira",
+  "customPattern": "^\\[([A-Z]+-\\d+)\\]",
+  "defaultAuthor": "Jane Doe",
+  "defaultRepos": ["~/work/api", "~/work/web"]
+}
+```
+
+| Field           | Type                                               | Description                                                                        |
+| --------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `format`        | `"jira" \| "github" \| "conventional" \| "custom"` | Ticket extraction preset. Default `jira`.                                          |
+| `customPattern` | `string`                                           | Regex used when `format` is `"custom"`. First capture group wins, else full match. |
+| `defaultAuthor` | `string`                                           | Used when `--author` is not passed and you want to skip the `git config` lookup.   |
+| `defaultRepos`  | `string[]`                                         | Paths to query when no `--repo` is given. `~` is expanded.                         |
+
+### Format presets
+
+| Preset         | Matches                                          | Example commit → ticket                |
+| -------------- | ------------------------------------------------ | -------------------------------------- |
+| `jira`         | `ABC-123` style (uppercase project key + digits) | `feat(ABC-123): add login` → `ABC-123` |
+| `github`       | `#123` style                                     | `Closes #42` → `42`                    |
+| `conventional` | Conventional Commit `type(scope)!`               | `feat(auth)!: ...` → `feat(auth)!`     |
+| `custom`       | Your `customPattern` regex                       | depends on the regex                   |
 
 ## Development
 

package/dist/index.js

@@ -9,16 +9,32 @@ import { promisify } from "util";
 var execFileAsync = promisify(execFile);
 var FIELD_SEP = "";
 var RECORD_SEP = "";
-var JIRA_TICKET_RE = /\b([A-Z][A-Z0-9]+-\d+)\b/;
-function extractTicket(message) {
-  const match = message.match(JIRA_TICKET_RE);
-  return match ? match[1] : null;
+function extractTicket(message, pattern) {
+  const match = message.match(pattern);
+  if (!match) {
+    return null;
+  }
+  return match[1] ?? match[0];
 }
 async function getGitUserName(cwd) {
-  const { stdout } = await execFileAsync("git", ["config", "user.name"], {
-    cwd
-  });
-  return stdout.trim();
+  try {
+    const { stdout } = await execFileAsync("git", ["config", "user.name"], {
+      cwd
+    });
+    const name = stdout.trim();
+    if (!name) {
+      throw new Error("empty");
+    }
+    return name;
+  } catch (err) {
+    if (err.code === "ENOENT") {
+      throw new Error("git is not installed or not on PATH", { cause: err });
+    }
+    throw new Error(
+      'could not read git user.name \u2014 set it with `git config user.name "Your Name"` or pass --author',
+      { cause: err }
+    );
+  }
 }
 async function getCommits(opts) {
   const args = [
@@ -29,8 +45,12 @@ async function getCommits(opts) {
     `--author=${opts.author}`,
     `--pretty=format:%cs${FIELD_SEP}%s${RECORD_SEP}`
   ];
-  if (opts.from) args.push(`--after=${opts.from} 00:00`);
-  if (opts.to) args.push(`--before=${opts.to} 23:59`);
+  if (opts.from) {
+    args.push(`--after=${opts.from} 00:00`);
+  }
+  if (opts.to) {
+    args.push(`--before=${opts.to} 23:59`);
+  }
   const { stdout } = await execFileAsync("git", args, {
     cwd: opts.cwd,
     maxBuffer: 32 * 1024 * 1024
@@ -39,7 +59,7 @@ async function getCommits(opts) {
     const [date = "", subject = ""] = record.split(FIELD_SEP);
     return {
       date,
-      ticket: extractTicket(subject),
+      ticket: extractTicket(subject, opts.pattern),
       description: subject
     };
   });
@@ -75,7 +95,112 @@ function renderError(message) {
   return chalk.red(`error: ${message}`);
 }
 
+// src/config.ts
+import { homedir } from "os";
+import { readFile } from "fs/promises";
+import { join } from "path";
+import { cosmiconfig } from "cosmiconfig";
+var PRESET_PATTERNS = {
+  jira: /\b([A-Z][A-Z0-9]+-\d+)\b/,
+  github: /#(\d+)/,
+  conventional: /^(\w+(?:\([^)]+\))?!?):/
+};
+var VALID_FORMATS = [
+  "jira",
+  "github",
+  "conventional",
+  "custom"
+];
+function getTicketPattern(format, customPattern) {
+  if (format === "custom") {
+    if (!customPattern) {
+      throw new Error('format "custom" requires customPattern to be set');
+    }
+    return new RegExp(customPattern);
+  }
+  return PRESET_PATTERNS[format];
+}
+function expandPath(p) {
+  if (p === "~") {
+    return homedir();
+  }
+  if (p.startsWith("~/")) {
+    return join(homedir(), p.slice(2));
+  }
+  return p;
+}
+function validateConfig(raw) {
+  if (typeof raw !== "object" || raw === null) {
+    throw new Error("config must be an object");
+  }
+  const obj = raw;
+  const cfg = {};
+  if ("format" in obj) {
+    if (typeof obj.format !== "string" || !VALID_FORMATS.includes(obj.format)) {
+      throw new Error(
+        `invalid format "${String(obj.format)}" \u2014 must be one of ${VALID_FORMATS.join(", ")}`
+      );
+    }
+    cfg.format = obj.format;
+  }
+  if ("customPattern" in obj) {
+    if (typeof obj.customPattern !== "string") {
+      throw new Error("customPattern must be a string");
+    }
+    cfg.customPattern = obj.customPattern;
+  }
+  if (cfg.format === "custom" && !cfg.customPattern) {
+    throw new Error('format "custom" requires customPattern to be set');
+  }
+  if ("defaultAuthor" in obj) {
+    if (typeof obj.defaultAuthor !== "string") {
+      throw new Error("defaultAuthor must be a string");
+    }
+    cfg.defaultAuthor = obj.defaultAuthor;
+  }
+  if ("defaultRepos" in obj) {
+    if (!Array.isArray(obj.defaultRepos) || !obj.defaultRepos.every((r) => typeof r === "string")) {
+      throw new Error("defaultRepos must be an array of strings");
+    }
+    cfg.defaultRepos = obj.defaultRepos;
+  }
+  return cfg;
+}
+function globalConfigPath() {
+  const xdgConfigHome = process.env.XDG_CONFIG_HOME ?? join(homedir(), ".config");
+  return join(xdgConfigHome, "wdid", "config.json");
+}
+async function loadGlobalConfig() {
+  try {
+    const content = await readFile(globalConfigPath(), "utf-8");
+    return validateConfig(JSON.parse(content));
+  } catch (err) {
+    if (err.code === "ENOENT") {
+      return null;
+    }
+    throw err;
+  }
+}
+async function loadConfig(cwd) {
+  const explorer = cosmiconfig("wdid");
+  const local = await explorer.search(cwd);
+  if (local?.config) {
+    return validateConfig(local.config);
+  }
+  const global = await loadGlobalConfig();
+  if (global) {
+    return global;
+  }
+  return {};
+}
+
 // src/index.ts
+var VALID_PRESETS = [
+  "jira",
+  "github",
+  "conventional",
+  "custom"
+];
 function isIsoDate(value) {
   return /^\d{4}-\d{2}-\d{2}$/.test(value);
 }
@@ -89,7 +214,27 @@ function resolveDate(input) {
   return input;
 }
 async function run(dateArg, options) {
-  const repos = options.repo && options.repo.length > 0 ? options.repo : [process.cwd()];
+  const config = await loadConfig(process.cwd());
+  let format;
+  let customPattern;
+  if (options.ticketPattern) {
+    format = "custom";
+    customPattern = options.ticketPattern;
+  } else if (options.format) {
+    if (!VALID_PRESETS.includes(options.format)) {
+      throw new Error(
+        `invalid --format "${options.format}" \u2014 must be one of ${VALID_PRESETS.join(", ")}`
+      );
+    }
+    format = options.format;
+    customPattern = config.customPattern;
+  } else {
+    format = config.format ?? "jira";
+    customPattern = config.customPattern;
+  }
+  const pattern = getTicketPattern(format, customPattern);
+  const configRepos = config.defaultRepos?.map(expandPath) ?? [];
+  const repos = options.repo && options.repo.length > 0 ? options.repo : configRepos.length > 0 ? configRepos : [process.cwd()];
   let from = options.from ? resolveDate(options.from) : void 0;
   let to = options.to ? resolveDate(options.to) : void 0;
   if (dateArg) {
@@ -99,8 +244,8 @@ async function run(dateArg, options) {
   }
   const allEntries = [];
   for (const cwd of repos) {
-    const author = options.author ?? await getGitUserName(cwd);
-    const entries = await getCommits({ author, from, to, cwd });
+    const author = options.author ?? config.defaultAuthor ?? await getGitUserName(cwd);
+    const entries = await getCommits({ author, from, to, cwd, pattern });
     allEntries.push(...entries);
   }
   allEntries.sort((a, b) => b.date.localeCompare(a.date));
@@ -111,12 +256,18 @@ async function run(dateArg, options) {
   process.stdout.write(renderTable(allEntries) + "\n");
 }
 var program = new Command();
-program.name("wdid").description("What did I do? \u2014 summarize your git commits as a table").argument("[date]", 'a YYYY-MM-DD date or "today"; omit to show all history').option("--from <date>", 'start date (YYYY-MM-DD or "today")').option("--to <date>", 'end date (YYYY-MM-DD or "today")').option(
+program.name("wdid").description("What did I do? \u2014 summarize your git commits as a table").version("0.1.3", "-V, --version", "output the version number").argument("[date]", 'a YYYY-MM-DD date or "today"; omit to show all history').option("--from <date>", 'start date (YYYY-MM-DD or "today")').option("--to <date>", 'end date (YYYY-MM-DD or "today")').option(
   "--author <name>",
-  "override the git author (defaults to git config user.name)"
+  "override the git author (defaults to git config user.name, then defaultAuthor in config)"
 ).option(
   "--repo <path...>",
-  "one or more repo paths to query (defaults to current directory)"
+  "one or more repo paths to query (overrides defaultRepos in config; defaults to current directory)"
+).option(
+  "--format <preset>",
+  "ticket format: jira | github | conventional | custom (default: jira, or config.format)"
+).option(
+  "--ticket-pattern <regex>",
+  "custom regex for ticket extraction (implies --format custom; overrides --format)"
 ).action(async (dateArg, options) => {
   try {
     await run(dateArg, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drazenbebic/wdid",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "What did I do? — summarize your git activity per day as a tidy table, grouped by JIRA ticket.",
   "keywords": [
     "git",
@@ -15,12 +15,12 @@
   "author": "Your Name <you@example.com>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/your-org/wdid.git"
+    "url": "git+https://github.com/drazenbebic/wdid.git"
   },
   "bugs": {
-    "url": "https://github.com/your-org/wdid/issues"
+    "url": "https://github.com/drazenbebic/wdid/issues"
   },
-  "homepage": "https://github.com/your-org/wdid#readme",
+  "homepage": "https://github.com/drazenbebic/wdid#readme",
   "type": "module",
   "main": "dist/index.js",
   "bin": {
@@ -46,22 +46,36 @@
     "format:check": "prettier --check .",
     "test": "vitest run",
     "test:watch": "vitest",
+    "prepare": "husky",
     "prepublishOnly": "pnpm run build"
   },
   "publishConfig": {
     "access": "public"
   },
+  "lint-staged": {
+    "*.{ts,tsx,js,cjs,mjs}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
   "dependencies": {
     "chalk": "^5.6.2",
     "cli-table3": "^0.6.5",
-    "commander": "^14.0.3"
+    "commander": "^14.0.3",
+    "cosmiconfig": "^9.0.1"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
     "@types/node": "^20.19.41",
     "eslint": "^10.4.0",
     "eslint-config-prettier": "^10.1.8",
     "globals": "^17.6.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.0.5",
     "prettier": "^3.8.3",
     "tsup": "^8.5.1",
     "typescript": "^6.0.3",