repo-dive 0.5.0 → 0.7.0

package/README.md

@@ -39,8 +39,9 @@ npx repo-dive status     # show catalog coverage
 npx repo-dive collectors # list available collectors
 npx repo-dive report     # export one shareable self-contained HTML file
 npx repo-dive query "SELECT metric, sum(value) FROM facts GROUP BY metric"
-npx repo-dive mcp # serve the cube to AI agents (Model Context Protocol)
-npx repo-dive gc  # clean up the catalog interactively
+npx repo-dive mcp    # serve the cube to AI agents (Model Context Protocol)
+npx repo-dive gc     # clean up the catalog interactively
+npx repo-dive ignore # keep other tools out of the catalog
 ```
 
 `scan` walks the repository's history and runs collectors against every commit (or a sample, per collector), writing raw snapshots into a `.repo-dive/` catalog inside the analyzed repo.
@@ -54,10 +55,13 @@ Collectors so far:
 - **directives** — eslint-disable comments by rule (block disables tracked as gray areas) and `@ts-ignore`/`@ts-expect-error`/`@ts-nocheck`
 - **dependencies** — total resolved packages from package-manager lockfiles, per package manager (pnpm, npm and yarn — classic and berry; version-aware and monorepo-aware, extensible to more managers), plus direct/dev/optional dependencies and the number of manifests read straight from `package.json` files
 - **todo-comments** — TODO/FIXME/HACK/XXX counts
-- **languages** — tokei language/LOC breakdown (sampled monthly; markdown counted whole)
+- **languages** — lines and file count per language across a commit's source files (lockfiles, minified bundles and generated data excluded)
 - **survival** — `git blame` line survival by extension, author and age cohort (sampled monthly)
 
-`index` normalizes raw snapshots into `.repo-dive/index/metrics.sqlite` (a facts-by-categories cube, rebuildable at any time) plus `dashboard.json`, and `dashboard` serves a local React app with interactive charts: languages over time, monthly commits with AI-assisted share, churn, lint-suppression trends, dependency counts over time, code survival by cohort and author, and more.
+The catalog hides itself from git, but other tools that walk the repository (prettier, markdownlint, cspell, docker builds) each read one ignore file at its root.
+`scan` warns when the catalog is missing from those; `repo-dive ignore` adds it to every one of them.
+
+`index` normalizes raw snapshots into `.repo-dive/index/metrics.sqlite` (a facts-by-categories cube, rebuildable at any time) plus `dashboard.json`, and `dashboard` serves a local React app with interactive charts: languages over time, a GitHub-style commit calendar, monthly commits with AI-assisted share, churn, lint-suppression trends, dependency counts over time, code survival by cohort and author, and more.
 
 ## Configuration
 
@@ -82,11 +86,21 @@ export default defineConfig({
     // How many contributors charts keep before folding the rest into "Other" (default 10).
     maxInCharts: 10,
   },
+  charts: {
+    // First day of the week in calendar-shaped charts (default "monday").
+    weekStartsOn: "monday",
+  },
+  catalog: {
+    // Where snapshots, caches and the cube live (default ".repo-dive").
+    dir: ".repo-dive",
+  },
 });
 ```
 
+`charts.weekStartsOn` sets the first day of the week in calendar-shaped charts such as the commit calendar (`"monday"` by default, `"sunday"` also supported).
 `contributors.aliases` merges the multiple identities one person commits under (work + personal email, GitHub noreply, name variants) so attribution, the contributors table and code-survival-by-contributor count them once; a group can also carry a `displayName`, a profile `url` and a `kind` (`human`/`bot`/`ai`, otherwise auto-derived — the dashboard badges bots and AI agents and lists them apart from humans).
-The config is read by `index`.
+`catalog.dir` moves the catalog; point it outside the repository (e.g. `"../repo-dive-catalogs/my-repo"`) to leave the analyzed working tree untouched altogether, ignore files included.
+Apart from `catalog`, which every command needs, the config is read by `index`.
 See [docs/specs/07-config.md](docs/specs/07-config.md) for details.
 
 ## AI agents (MCP)