git-history-ui 4.0.1 → 5.0.0

package/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project are documented in this file.
 The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
 this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.0.0] - 2026-05-03
+
+### Added
+
+- AI explanations now render as formatted markdown with an internal scrollbar
+  for long responses.
+- OpenAI and Anthropic model selection can be overridden with
+  `GHUI_LLM_MODEL`, `OPENAI_MODEL`, or `ANTHROPIC_MODEL`.
+- Project governance docs, PR templates, issue templates, and expanded test
+  coverage were added for a more release-ready package.
+
+### Changed
+
+- OpenAI defaults to `gpt-4.1-nano` and Anthropic defaults to the available
+  Sonnet model `claude-sonnet-4-6`.
+- AI summaries and commit explanations use larger token budgets and tighter
+  prompts to avoid truncated prose.
+
 ## [4.0.1] - 2026-05-02
 
 ### Fixed

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,53 @@
+# Code of Conduct
+
+## Our Pledge
+
+We pledge to make participation in this project a harassment-free experience
+for everyone, regardless of age, body size, visible or invisible disability,
+ethnicity, sex characteristics, gender identity and expression, level of
+experience, education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by mistakes
+- Focusing on what is best for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing standards of
+acceptable behavior and may remove, edit, or reject comments, commits, code,
+wiki edits, issues, and other contributions that are not aligned with this Code
+of Conduct.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and also applies when an
+individual is officially representing the project in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project maintainer at
+[ankit.sharma199803@gmail.com](mailto:ankit.sharma199803@gmail.com).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

package/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing to git-history-ui
+
+Thanks for your interest in improving git-history-ui! This guide will help you
+get started.
+
+## Development Setup
+
+```bash
+# 1. Fork and clone
+git clone https://github.com/<your-user>/git-history-ui.git
+cd git-history-ui
+
+# 2. Use the correct Node version
+nvm use          # reads .nvmrc → Node 20
+
+# 3. Install dependencies
+npm install
+npm install --prefix frontend
+
+# 4. Start the dev server (backend + frontend with hot reload)
+npm run dev
+```
+
+The backend runs on `http://localhost:3000` and the Angular dev server on
+`http://localhost:4200` with API requests proxied to the backend.
+
+## Project Structure
+
+```
+src/
+  cli.ts                  # CLI entry point (Commander)
+  backend/
+    server.ts             # Express app + API routes
+    gitService.ts         # All git operations
+    llm/                  # LLM provider abstraction
+    search/               # Natural-language search
+    cache/                # SQLite indexer
+    ...
+  __tests__/              # Backend tests (Jest)
+
+frontend/
+  src/app/
+    components/           # Angular standalone components
+    services/             # Angular services
+    models/               # Shared TypeScript interfaces
+```
+
+## Making Changes
+
+1. **Create a feature branch** from `main`:
+
+   ```bash
+   git checkout -b feat/my-feature
+   ```
+
+2. **Write code.** Follow the existing style — Prettier and ESLint will
+   enforce formatting on commit (via the pre-commit hook).
+
+3. **Write tests.** Backend coverage must stay above 90% (CI enforces this).
+   Add tests in `src/__tests__/` for any new backend logic.
+
+4. **Run checks locally** before pushing:
+
+   ```bash
+   npm run lint          # ESLint
+   npm run typecheck     # tsc --noEmit
+   npm test              # Jest (backend)
+   npm test --prefix frontend -- --watch=false   # Karma (frontend)
+   ```
+
+5. **Commit with a conventional message:**
+
+   ```
+   feat: add branch comparison view
+   fix: handle empty commit body in NL search
+   docs: update API endpoint reference
+   chore: bump express to 4.22
+   ```
+
+   The format is `type(optional-scope): description`. See
+   [Conventional Commits](https://www.conventionalcommits.org/) for the full
+   spec.
+
+6. **Push and open a PR** against `main`. Fill in the PR template and link
+   any related issues.
+
+## Commit Message Convention
+
+We use [Conventional Commits](https://www.conventionalcommits.org/):
+
+| Prefix     | When to use                          |
+| ---------- | ------------------------------------ |
+| `feat:`    | New user-facing feature              |
+| `fix:`     | Bug fix                              |
+| `docs:`    | Documentation only                   |
+| `style:`   | Formatting, whitespace               |
+| `refactor:`| Code change that neither fixes nor adds |
+| `perf:`    | Performance improvement              |
+| `test:`    | Adding or updating tests             |
+| `chore:`   | Build, CI, dependency updates        |
+
+## Code Style
+
+- **TypeScript** throughout (backend + frontend).
+- **Prettier** formats on save / on commit.
+- **ESLint** with `@typescript-eslint` and `prettier` integration.
+- Prefer `const` over `let`, avoid `any` when practical.
+- Keep functions small and testable.
+
+## Tests
+
+- **Backend:** Jest + ts-jest. Tests live in `src/__tests__/`.
+  - Use `supertest` for HTTP endpoint tests.
+  - Use `nock` for external HTTP mocking (GitHub API, LLM providers).
+  - Use `helpers/repo.ts` to create ephemeral git repos.
+- **Frontend:** Karma + Jasmine. Specs live alongside components (`*.spec.ts`).
+
+## Reporting Bugs
+
+Use the [bug report template](https://github.com/beingmartinbmc/git-history-ui/issues/new?template=bug_report.yml)
+on GitHub. Include your Node version, OS, and the output of
+`npx git-history-ui --version`.
+
+## Requesting Features
+
+Use the [feature request template](https://github.com/beingmartinbmc/git-history-ui/issues/new?template=feature_request.yml)
+on GitHub. Describe the use case, not just the solution.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the
+[MIT License](LICENSE).

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ankit Sharma
+
+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.

package/README.md

@@ -21,6 +21,24 @@ Zero setup. Runs locally. Your code never leaves your machine unless you opt in.
 npx git-history-ui@latest
 ```
 
+## Table of contents
+
+- [10-second workflow](#-10-second-workflow)
+- [Preview](#-preview)
+- [Why this exists](#-why-this-exists)
+- [What makes it different](#-what-makes-it-different)
+- [Quick Start](#-quick-start)
+- [How it compares](#-how-it-compares)
+- [All features](#-all-features)
+- [Usage](#-usage)
+- [Docs](#-docs)
+- [Production](#-production)
+- [Development](#-development)
+- [Requirements](#-requirements)
+- [Contributing](#-contributing)
+- [Security](#-security)
+- [License](#-license)
+
 ## ⚡ 10-second workflow
 
 1. Run `npx git-history-ui` inside any git repo
@@ -86,14 +104,16 @@ directory — no installs, no config, no account.
 
 ## ⚖️ How it compares
 
-- **vs GitHub UI:** NL search and PR grouping work *with* your unpushed
-  commits. Time travel and impact analysis aren't on GitHub at all.
-- **vs `tig` / `git log`:** visual lanes, browser diffs, optional AI
-  explanations, insights dashboard.
-- **vs desktop clients (GitKraken, SourceTree, Fork):** starts on demand,
-  no project import, no account, no native install. AI features are
-  pay-as-you-go on *your* key — nothing about your code leaves your
-  machine unless you opt in.
+| Capability | `git-history-ui` | GitHub UI | `tig` / `git log` | Desktop clients |
+| --- | --- | --- | --- | --- |
+| Works with local and unpushed commits | Yes | No | Yes | Usually |
+| Natural-language history search | Yes | No | No | Rare |
+| PR / feature grouping for local history | Yes | Partial | No | Partial |
+| Time-travel snapshot diffing | Yes | No | No | Rare |
+| Commit impact analysis | Yes | No | No | Rare |
+| Browser-based unified / split diffs | Yes | Yes | No | Yes |
+| Optional AI summaries on your key | Yes | No | No | Rare |
+| No account, import, or desktop install | Yes | No | Yes | No |
 
 ## 📦 All features
 
@@ -172,17 +192,48 @@ npx git-history-ui@latest --no-open           # don't open the browser
 npx git-history-ui@latest --help              # full flag list
 ```
 
+### CLI reference
+
+```text
+Usage: git-history-ui [options] [command]
+
+Beautiful git history visualization in your browser
+
+Options:
+  -v, --version            output the version number
+  -p, --port <number>      port to run server on (default: "3000")
+  -H, --host <host>        host to bind to (default: "localhost")
+  -f, --file <path>        filter commits by a specific file
+  -s, --since <date>       filter commits since a date (YYYY-MM-DD)
+  -a, --author <name>      filter commits by author
+  --no-open                do not automatically open browser
+  --cwd <path>             path to the git repository (defaults to cwd)
+  --llm <provider>         LLM provider: heuristic, anthropic, openai (default:
+                           auto)
+  --preset <name>          load filters from a saved preset
+  --save-preset <name>     save the current flags as a preset for next time
+  -h, --help               display help for command
+
+Commands:
+  presets <action> [name]  manage saved CLI presets
+```
+
 ### Optional: bring your own AI key
 
 ```bash
-# Anthropic (recommended; uses claude-3-5-haiku by default)
+# Anthropic (uses Claude Sonnet 4 by default)
 export ANTHROPIC_API_KEY=sk-ant-...
 
-# Or OpenAI (uses gpt-4o-mini by default)
+# Or OpenAI (uses GPT 4.1 Nano by default)
 export OPENAI_API_KEY=sk-...
 
 # Force a specific provider when both are set
 export GHUI_LLM_PROVIDER=anthropic   # anthropic | openai | heuristic
+
+# Optional model overrides
+export GHUI_LLM_MODEL=claude-sonnet-4-6
+export ANTHROPIC_MODEL=claude-sonnet-4-6
+export OPENAI_MODEL=gpt-4.1-nano
 ```
 
 ### Optional: GitHub PR enrichment
@@ -193,6 +244,13 @@ export GITHUB_TOKEN=ghp_...   # fine-grained PAT, read-only on the repo
 
 This hydrates the *Grouped* view with PR titles, authors, and labels.
 
+## 📚 Docs
+
+- [API reference](./docs/API.md)
+- [Architecture](./docs/architecture.md)
+- [Configuration](./docs/configuration.md)
+- [Troubleshooting](./docs/troubleshooting.md)
+
 ## 🏭 Production
 
 ```bash
@@ -225,11 +283,13 @@ cd frontend && npm test
 
 ## 🤝 Contributing
 
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Run tests
-5. Submit a pull request
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for local
+setup, commit conventions, test commands, and PR expectations.
+
+## 🔐 Security
+
+Please do not open public issues for security vulnerabilities. See
+[SECURITY.md](SECURITY.md) for the responsible disclosure process.
 
 ## 📄 License
 

package/SECURITY.md

@@ -0,0 +1,51 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 4.x     | :white_check_mark: |
+| 3.x     | :x:                |
+| < 3.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in `git-history-ui`, **please do not
+open a public issue.** Instead, report it responsibly so we can fix it before
+it's disclosed.
+
+**Email:** [ankit.sharma199803@gmail.com](mailto:ankit.sharma199803@gmail.com)
+
+Please include:
+
+- A description of the vulnerability
+- Steps to reproduce
+- The version(s) affected
+- Any potential impact you've identified
+
+You should receive an acknowledgment within **48 hours**. We'll work with you
+to understand the issue and coordinate a fix and disclosure timeline.
+
+## Scope
+
+The following are in scope:
+
+- The `git-history-ui` npm package and CLI
+- The Express backend server (`src/backend/`)
+- API key handling (Anthropic, OpenAI, GitHub tokens)
+- The local SQLite index (`~/.git-history-ui/`)
+
+The following are **out of scope**:
+
+- Third-party services (Anthropic, OpenAI, GitHub APIs)
+- The user's own git repository contents
+- The Chrome extension and GitHub App scaffolds (experimental, not published)
+
+## Principles
+
+- **Local-first.** Your repository data never leaves your machine unless you
+  explicitly configure an LLM provider key.
+- **No telemetry.** We do not collect analytics, crash reports, or usage data.
+- **API keys are yours.** Keys are read from environment variables and sent
+  directly to the provider you chose. They are never logged, stored, or
+  transmitted elsewhere.

package/build/frontend/{chunk-CFCRPNUQ.js → chunk-3E3FVV4X.js}

@@ -1 +1 @@
-import{$ as a,Qb as v,Rb as l,Sb as m,U as f,W as h,ja as y,ka as b,l as g,la as d,oa as i}from"./chunk-OBPR2XVH.js";function U(n,e){let t=e?.injector??a(y),s=new g(1),u=m(()=>{let r;try{r=n()}catch(c){v(()=>s.error(c));return}v(()=>s.next(r))},{injector:t,manualCleanup:!0});return t.get(d).onDestroy(()=>{u.destroy(),s.complete()}),s.asObservable()}function L(n,e){let s=!e?.manualCleanup?e?.injector?.get(d)??a(d):null,u=w(e?.equal),r;e?.requireSync?r=i({kind:0},{equal:u}):r=i({kind:1,value:e?.initialValue},{equal:u});let c,p=n.subscribe({next:o=>r.set({kind:1,value:o}),error:o=>{r.set({kind:2,error:o}),c?.()},complete:()=>{c?.()}});if(e?.requireSync&&r().kind===0)throw new f(601,!1);return c=s?.onDestroy(p.unsubscribe.bind(p)),l(()=>{let o=r();switch(o.kind){case 1:return o.value;case 2:throw o.error;case 0:throw new f(601,!1)}},{equal:e?.equal})}function w(n=Object.is){return(e,t)=>e.kind===1&&t.kind===1&&n(e.value,t.value)}var k="ghui:theme",D=class n{doc=a(b);mediaQuery=null;preference=i(this.read());systemDark=i(!1);resolved=l(()=>{let e=this.preference();return e==="system"?this.systemDark()?"dark":"light":e});constructor(){typeof window<"u"&&window.matchMedia&&(this.mediaQuery=window.matchMedia("(prefers-color-scheme: dark)"),this.systemDark.set(this.mediaQuery.matches),this.mediaQuery.addEventListener("change",e=>this.systemDark.set(e.matches))),m(()=>{let e=this.resolved(),t=this.doc.documentElement;t.classList.toggle("dark",e==="dark"),t.dataset.theme=e,this.doc.body?.classList?.toggle("dark",e==="dark")})}setPreference(e){this.preference.set(e);try{localStorage.setItem(k,e)}catch{}}cycle(){let t=this.resolved()==="light"?"dark":"light";this.setPreference(t)}read(){try{let e=localStorage.getItem(k);if(e==="light"||e==="dark"||e==="system")return e}catch{}return"system"}static \u0275fac=function(t){return new(t||n)};static \u0275prov=h({token:n,factory:n.\u0275fac,providedIn:"root"})};export{U as a,L as b,D as c};
+import{$ as a,U as f,W as h,ac as v,bc as l,cc as m,ja as y,ka as b,l as g,la as d,oa as i}from"./chunk-QH2BEUIU.js";function U(n,e){let t=e?.injector??a(y),s=new g(1),u=m(()=>{let r;try{r=n()}catch(c){v(()=>s.error(c));return}v(()=>s.next(r))},{injector:t,manualCleanup:!0});return t.get(d).onDestroy(()=>{u.destroy(),s.complete()}),s.asObservable()}function L(n,e){let s=!e?.manualCleanup?e?.injector?.get(d)??a(d):null,u=w(e?.equal),r;e?.requireSync?r=i({kind:0},{equal:u}):r=i({kind:1,value:e?.initialValue},{equal:u});let c,p=n.subscribe({next:o=>r.set({kind:1,value:o}),error:o=>{r.set({kind:2,error:o}),c?.()},complete:()=>{c?.()}});if(e?.requireSync&&r().kind===0)throw new f(601,!1);return c=s?.onDestroy(p.unsubscribe.bind(p)),l(()=>{let o=r();switch(o.kind){case 1:return o.value;case 2:throw o.error;case 0:throw new f(601,!1)}},{equal:e?.equal})}function w(n=Object.is){return(e,t)=>e.kind===1&&t.kind===1&&n(e.value,t.value)}var k="ghui:theme",D=class n{doc=a(b);mediaQuery=null;preference=i(this.read());systemDark=i(!1);resolved=l(()=>{let e=this.preference();return e==="system"?this.systemDark()?"dark":"light":e});constructor(){typeof window<"u"&&window.matchMedia&&(this.mediaQuery=window.matchMedia("(prefers-color-scheme: dark)"),this.systemDark.set(this.mediaQuery.matches),this.mediaQuery.addEventListener("change",e=>this.systemDark.set(e.matches))),m(()=>{let e=this.resolved(),t=this.doc.documentElement;t.classList.toggle("dark",e==="dark"),t.dataset.theme=e,this.doc.body?.classList?.toggle("dark",e==="dark")})}setPreference(e){this.preference.set(e);try{localStorage.setItem(k,e)}catch{}}cycle(){let t=this.resolved()==="light"?"dark":"light";this.setPreference(t)}read(){try{let e=localStorage.getItem(k);if(e==="light"||e==="dark"||e==="system")return e}catch{}return"system"}static \u0275fac=function(t){return new(t||n)};static \u0275prov=h({token:n,factory:n.\u0275fac,providedIn:"root"})};export{U as a,L as b,D as c};