repo-dive 0.4.0

package/dist/config.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Public configuration surface for repo-dive.
+ *
+ * Drop a `repo-dive.config.ts` (or `.mjs`/`.js`) at the root of the
+ * repository you analyze and export a `defineConfig(...)` call as the default
+ * export. Everything keeps working with zero config; this only refines it.
+ *
+ * ```ts
+ * import { defineConfig } from "repo-dive/config";
+ *
+ * export default defineConfig({
+ *   contributors: {
+ *     aliases: [
+ *       // Shorthand: emails only, the first is canonical.
+ *       ["alice@work.example", "alice@personal.example"],
+ *       // Rich form: a display name, a profile link and a kind.
+ *       {
+ *         emails: ["bob@work.example", "bob@personal.example"],
+ *         displayName: "Bob",
+ *         url: "https://github.com/bob",
+ *       },
+ *     ],
+ *     maxInCharts: 10,
+ *   },
+ * });
+ * ```
+ */
+/**
+ * What sort of contributor an identity is. `kind` is optional in the config; a
+ * missing value is derived from the commit author's name/email (automation bots
+ * and known AI coding agents are recognized) and otherwise defaults to `human`.
+ */
+export type ContributorKind = "human" | "bot" | "ai";
+/**
+ * One alias group in its rich form: the email identities of a single
+ * contributor plus optional presentation. `emails` entries are matched against
+ * each commit author's email — either its raw value or its prettified
+ * GitHub-noreply handle (so `"alice"` matches
+ * `1234+alice@users.noreply.github.com`). The **first entry is canonical**.
+ */
+export type ContributorAliasGroup = {
+    readonly emails: readonly string[];
+    /** Overrides the display name shown in charts and the contributors table. */
+    readonly displayName?: string;
+    /** Profile URL (e.g. a GitHub page) the contributor's name links to. */
+    readonly url?: string;
+    /** Overrides the auto-derived {@link ContributorKind}. */
+    readonly kind?: ContributorKind;
+};
+export type ContributorsConfig = {
+    /**
+     * Alias groups for people who appear under multiple identities (work +
+     * personal email, GitHub noreply, name variants). Each group is either a
+     * plain array of emails (the first is canonical) or a
+     * {@link ContributorAliasGroup} object that additionally sets a
+     * `displayName`, `url` and `kind`. They are merged when building the cube and
+     * dashboard data.
+     */
+    readonly aliases?: ReadonlyArray<readonly string[] | ContributorAliasGroup>;
+    /**
+     * How many contributors the per-contributor charts keep before folding the
+     * rest into "Other". Defaults to 10.
+     */
+    readonly maxInCharts?: number;
+};
+export type RepoDiveConfig = {
+    readonly contributors?: ContributorsConfig;
+};
+/**
+ * Identity helper that gives `repo-dive.config.ts` full type-checking and
+ * editor IntelliSense. It returns its argument unchanged.
+ */
+export declare const defineConfig: (config: RepoDiveConfig) => RepoDiveConfig;

package/dist/config.js

@@ -0,0 +1,32 @@
+/**
+ * Public configuration surface for repo-dive.
+ *
+ * Drop a `repo-dive.config.ts` (or `.mjs`/`.js`) at the root of the
+ * repository you analyze and export a `defineConfig(...)` call as the default
+ * export. Everything keeps working with zero config; this only refines it.
+ *
+ * ```ts
+ * import { defineConfig } from "repo-dive/config";
+ *
+ * export default defineConfig({
+ *   contributors: {
+ *     aliases: [
+ *       // Shorthand: emails only, the first is canonical.
+ *       ["alice@work.example", "alice@personal.example"],
+ *       // Rich form: a display name, a profile link and a kind.
+ *       {
+ *         emails: ["bob@work.example", "bob@personal.example"],
+ *         displayName: "Bob",
+ *         url: "https://github.com/bob",
+ *       },
+ *     ],
+ *     maxInCharts: 10,
+ *   },
+ * });
+ * ```
+ */
+/**
+ * Identity helper that gives `repo-dive.config.ts` full type-checking and
+ * editor IntelliSense. It returns its argument unchanged.
+ */
+export const defineConfig = (config) => config;