diff --git a/README.md b/README.md index 0eca5b1..7312081 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -# vscode-diff Next โ€” compare branches and repos side by side +![vscode-diff-next banner](https://raw.githubusercontent.com/machine-made/vscode-diff-next/main/assets/readme-banner-v3.jpg) -[![CI](https://github.com/machine-made/vscode-diff-next/actions/workflows/ci.yml/badge.svg)](https://github.com/machine-made/vscode-diff-next/actions/workflows/ci.yml) -[![License: MIT](https://img.shields.io/badge/license-MIT-green)](./LICENSE) +[![CI](https://github.com/machine-made/vscode-diff-next/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/machine-made/vscode-diff-next/actions/workflows/ci.yml) +[![Marketplace](https://vsmarketplacebadges.dev/version/RicardoFrantz.diff-next.svg)](https://marketplace.visualstudio.com/items?itemName=RicardoFrantz.diff-next) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![GitHub](https://img.shields.io/badge/github-vscode--diff--next-blue)](https://github.com/machine-made/vscode-diff-next) -Compare any two Git endpoints โ€” two branches of one repo, or branches of **two -different repos** in a multi-root workspace โ€” with a changed-file tree, commit -history, and one-click built-in diffs, all in a dedicated sidebar. +`vscode-diff-next` compares any two Git endpoints. The two endpoints are two branches of one repo, or branches of **two +different repos** in a multi-root workspace. A dedicated sidebar shows a changed-file tree, the commit +history and built-in diffs. **vscode-diff Next** is the actively maintained product on top of the classic [Diff Visualizer](https://github.com/lxliang912/diff-visualizer) lineage. The @@ -18,17 +19,17 @@ security posture, docs, and day-to-day tooling follow the same bar as ## Why this extension? -- ๐Ÿ”€ **Branch compare without leaving the editor.** Pick two endpoints +- **Branch compare without leaving the editor.** Pick two endpoints (`{folder} ยท {ref}`); see every changed path and the commits between them. -- ๐Ÿ—‚๏ธ **Cross-repo compare.** Each side can be a different repository in your +- **Cross-repo compare.** Each side can be a different repository in your workspace โ€” ideal for comparing versioned checkouts (`app-2.5` vs `app-2.6`) that don't share a git history. -- โœ… **Honest file status.** Status comes from `git diff --name-status` +- **File status.** Status comes from `git diff --name-status` (A/M/D/R/C, NUL-safe parsing, rename detection) โ€” not guessed from insert/delete counts. Renamed files diff old name โ†” new name. -- ๐Ÿ•˜ **Commit history.** Searchable list for the `base..target` range; subject +- **Commit history.** Searchable list for the `base..target` range; subject and body exactly as git wrote them. -- ๐Ÿ”’ **Hardened.** Nonce-based webview CSP, untrusted-input validation on every +- **Webview security.** Nonce-based webview CSP, untrusted-input validation on every ref and path crossing the webview boundary, no shell execution (refs and paths are passed to git as discrete arguments). @@ -36,19 +37,19 @@ security posture, docs, and day-to-day tooling follow the same bar as | Feature | Status | | ------- | ------ | -| Dual targets: any two workspace repos + branches | โœ… | -| Session tabs: hold several compares at once | โœ… | -| Folder-then-branch picker (searchable, not a short OS list) | โœ… | -| SCM-style list (M / U / D / R / C) with foldable groups | โœ… | -| M โ†’ side-by-side diff; U/D โ†’ single side; R โ†’ old โ†” new | โœ… | -| Images and PDFs open in their viewer, changed ones side by side | โœ… | -| Open Target 2 worktree file (โ†—) | โœ… | -| Editable diff + per-change revert arrow (โ†’) when Target 2 is checked out | โœ… | -| Discard: apply Target 1 โ†’ Target 2 worktree (binary-safe) | โœ… | -| Commit history + search (same-repo only, capped at 1000) | โœ… | -| Persist open tabs + last pair + list font size | โœ… | -| Unicode / unusual filenames | โœ… (`-z` parsing) | -| Windows / Linux / macOS | โœ… (`git` on `PATH`) | +| Dual targets: any two workspace repos + branches | yes | +| Session tabs: hold several compares at once | yes | +| Folder-then-branch picker (searchable, not a short OS list) | yes | +| SCM-style list (M / U / D / R / C) with foldable groups | yes | +| M โ†’ side-by-side diff; U/D โ†’ single side; R โ†’ old โ†” new | yes | +| Images and PDFs open in their viewer, changed ones side by side | yes | +| Open Target 2 worktree file (โ†—) | yes | +| Editable diff + per-change revert arrow (โ†’) when Target 2 is checked out | yes | +| Discard: apply Target 1 โ†’ Target 2 worktree (binary-safe) | yes | +| Commit history + search (same-repo only, capped at 1000) | yes | +| Persist open tabs + last pair + list font size | yes | +| Unicode / unusual filenames | yes (`-z` parsing) | +| Windows / Linux / macOS | yes (`git` on `PATH`) | ## Getting started diff --git a/assets/readme-banner-v3.jpg b/assets/readme-banner-v3.jpg new file mode 100644 index 0000000..f0fc231 Binary files /dev/null and b/assets/readme-banner-v3.jpg differ