Merge pull request #1 from ryutaro-asada/feature/vscode

vscode_like diff

Author: ryutaro-asada

.gitignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -1,52 +1,132 @@
 # partial-diff.nvim
 
-This repository contains a set of commands for Neovim that allow you to perform partial diffs on your code.
-## demo
+A Neovim plugin for performing partial diffs on selected code regions with advanced character-level diff highlighting powered by VSCode's diff algorithm.
 
+## Features
+
+- 🎯 **Partial Diff**: Compare any two selected regions of code
+
+## Demo
 
 https://github.com/ryutaro-asada/partial-diff.nvim/assets/58899265/6eaae6a9-2ecb-489e-8d38-c4bd9ff41690
 
+## Installation
+
+### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
+
+```lua
+  {
+    "ryutaro-asada/partial-diff.nvim",
+  },
+```
+
+### configuration
+
+```lua
+require('partial-diff').setup({
+  -- Debug options
+  debug = false,
+  -- Highlight customization
+  highlights = {
+    -- Link to existing highlight groups
+    line_change = 'DiffChange',
+    line_add = 'DiffAdd',
+    line_delete = 'DiffDelete',
+    -- Specify custom colors
+    char_add = {
+      bg = '#2d5a2d',   -- Background color
+      fg = '#a9dc76',   -- Foreground color
+      bold = true,      -- Bold
+      italic = false,   -- Italic
+      underline = false -- Underline
+    },
+    char_delete = {
+      bg = '#5a2d2d',
+      fg = '#ff6188',
+    },
+    char_change = {
+      bg = '#4a4a0e',
+      fg = '#ffd866',
+      bold = true
+    }
+  }
+})
+```
 
+### VSCode Diff Algorithm (Optional but Recommended)
+
+For better character-level diff highlighting, install the VSCode diff algorithm:
+
+1. Ensure Node.js is installed on your system
+2. Run `:PartialDiffInstallVSCode` in Neovim
+3. This will install the required npm packages in the plugin directory
+
+Without this, the plugin will fall back to Neovim's built-in diff.
 
 ## Commands
 
-- `PartialDiffA`: Marks a range of lines as the first part of the diff.
-- `PartialDiffB`: Marks a range of lines as the second part of the diff.
-- `PartialDiffDelete`: Deletes the current partial diff.
+### Primary Commands
+
+- `:PartialDiffFrom` - Mark a range of lines as the source (what you're diffing from)
+- `:PartialDiffTo` - Mark a range of lines as the target (what you're diffing to) and display the diff
+- `:PartialDiffDelete` - Close the current diff view
+- `:PartialDiffInstallVSCode` - Install VSCode diff algorithm dependencies
+
+### Legacy Commands (Backward Compatibility)
+
+- `:PartialDiffA` - Alias for `:PartialDiffFrom`
+- `:PartialDiffB` - Alias for `:PartialDiffTo`
+
+### Debug Commands
+
+- `:PartialDiffShowLog` - Show the debug log file
+- `:PartialDiffClearLog` - Clear the debug log file
 
 ## Usage
 
-Follow the steps below to use these commands:
+### Basic Workflow
 
-1. Select the range of lines with visual mode.
-2. Type `:PartialDiffA`.
-3. Select another range of lines with visual mode.
-4. Type `:PartialDiffB`.
-5. View the diff.
+1. Select the first range of lines in visual mode
+2. Execute `:PartialDiffFrom` (or use your keymap)
+3. Select the second range of lines in visual mode
+4. Execute `:PartialDiffTo` (or use your keymap)
+5. View the diff in a new tab with side-by-side comparison
 
-```vim
-:'<,'>PartialDiffA
-:'<,'>PartialDiffB
-```
+### Example
 
-To delete the current diff, use the `PartialDiffDelete` command.
+```vim
+" Select lines 10-20 in visual mode
+:'<,'>PartialDiffFrom
 
+" Select lines 30-40 in visual mode
+:'<,'>PartialDiffTo
 
-## Installation
+" Close the diff when done
+:PartialDiffDelete
+```
 
-Using [lazy.nvim](https://github.com/folke/lazy.nvim)
+## Configuration
 
 ```lua
-  {
-    "ryutaro-asada/partial-diff.nvim",
-  },
+require("partial-diff").setup({
+  debug = false,  -- Enable debug logging
+  log_file_path = vim.fn.stdpath('cache') .. '/partial-diff.log',  -- Custom log path
+})
 ```
 
+## Powered By
+
+- [vscode-diff](https://github.com/micnil/vscode-diff) - Advanced character-level diff computation
+
+## Requirements
+
+- Neovim 0.10.0 or later
+- (Optional) Node.js for VSCode diff algorithm
+
 ## Contributing
 
 If you have any suggestions or improvements, feel free to open an issue or submit a pull request.
 
 ## License
 
 This project is licensed under the MIT License.
-