sight 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05abdb72bec3313b413b826f36a5f5a5590374d7d61640460a41eddd75a57ab6
+  data.tar.gz: 27d5fb5d877eebf0152ffa070201e2bb0755256cb466027bc3f61c26bccd4a16
+SHA512:
+  metadata.gz: 41a607fda53ab9822d968c8d2af280b71db14bb3edf96752dfd8ce26450277d44e19ad85f1677940506b75f80503f6511201291795d031d42aab10beb598bbe5
+  data.tar.gz: 254d6c49a5abb2ead9130daad53fc874523a282b1b69c50b9df0f015280ea7fb47ff8a099f3b21badd10b074c0b39941749c7b200f913a358a7e6635029954dd

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## [0.1.0] - 2026-03-04
+
+### Added
+
+- Interactive curses-based TUI for browsing git diffs
+- Color-coded add/delete/context lines with line-number gutter
+- Vim-style keybindings for scrolling and navigation
+- Per-file navigation with `n`/`p` keys
+- Help overlay with `?`
+- Fallback to `--cached` diff for initial commits
+- CLI with `--help` and `--version` flags

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"sight" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["arzezak@gmail.com"](mailto:"arzezak@gmail.com").

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,54 @@
+# Sight
+
+Terminal UI for browsing git diffs interactively with colors, scrolling, and file navigation.
+
+## Installation
+
+```bash
+gem install sight
+```
+
+## Usage
+
+Stage some changes (or have unstaged changes), then run:
+
+```bash
+sight
+```
+
+### Keybindings
+
+| Key | Action |
+|-----|--------|
+| `j` / `↓` | Scroll down |
+| `k` / `↑` | Scroll up |
+| `d` | Half page down |
+| `u` | Half page up |
+| `f` | Full page down |
+| `b` | Full page up |
+| `g` | Go to top |
+| `G` | Go to bottom |
+| `n` / `→` | Next file |
+| `p` / `←` | Previous file |
+| `?` | Toggle help |
+| `q` / `Esc` | Quit |
+
+## Development
+
+```bash
+bin/setup
+rake test
+bundle exec standardrb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arzezak/sight. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/arzezak/sight/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sight project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arzezak/sight/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/sight

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "sight"
+
+Sight::CLI.run(ARGV)

data/lib/sight/app.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require "curses"
+
+module Sight
+  class App
+    attr_reader :files, :file_lines
+    attr_accessor :file_idx, :offset
+
+    def initialize(files)
+      @files = files
+      @file_lines = files.map { build_file_lines(it) }
+      @file_idx = 0
+      @offset = 0
+    end
+
+    def run
+      init_curses
+
+      loop do
+        render
+
+        break unless handle_input
+      end
+    ensure
+      Curses.close_screen
+    end
+
+    private
+
+    def build_file_lines(file)
+      file.hunks.flat_map do |hunk|
+        hunk.lines.map do |diff_line|
+          text = (diff_line.type == :meta) ? diff_line.content : diff_line.content[1..]
+          DisplayLine.new(type: diff_line.type, text: text, lineno: diff_line.lineno)
+        end
+      end
+    end
+
+    def init_curses
+      Curses.init_screen
+      Curses.start_color
+      Curses.use_default_colors
+      Curses.cbreak
+      Curses.noecho
+      Curses.curs_set(0)
+      Curses.stdscr.keypad(true)
+      Curses.init_pair(1, Curses::COLOR_GREEN, -1)
+      Curses.init_pair(2, Curses::COLOR_RED, -1)
+      Curses.init_pair(3, Curses::COLOR_CYAN, -1)
+      Curses.init_pair(4, Curses::COLOR_YELLOW, -1)
+    end
+
+    def lines
+      file_lines[file_idx]
+    end
+
+    def render
+      win = Curses.stdscr
+      win.clear
+      width = Curses.cols
+      render_header(win, width)
+      render_content(win, width)
+      render_status_bar(win, width)
+      win.refresh
+    end
+
+    def render_header(win, width)
+      path = files[file_idx].path
+      win.setpos(0, 0)
+      win.attron(color_for(:header)) { win.addstr(path[0, width]) }
+      win.setpos(1, 0)
+      win.attron(color_for(:header)) { win.addstr("\u2500" * width) }
+    end
+
+    def render_content(win, width)
+      gutter = gutter_width
+      dim = Curses.color_pair(0) | Curses::A_DIM
+      content_width = width - gutter - 3
+
+      scroll_height.times do |row|
+        idx = offset + row
+        break if idx >= lines.size
+        line = lines[idx]
+        win.setpos(row + 2, 0)
+        win.attron(dim) { win.addstr("#{format_gutter(line.type, line.lineno, gutter)} │ ") }
+        win.attron(color_for(line.type)) { win.addstr(line.text[0, content_width]) }
+      end
+    end
+
+    def render_status_bar(win, width)
+      win.setpos(Curses.lines - 1, 0)
+      win.attron(Curses.color_pair(4) | Curses::A_REVERSE) do
+        status = " File #{file_idx + 1}/#{files.size} | Line #{offset + 1}/#{lines.size} "
+        win.addstr(status.ljust(width))
+      end
+    end
+
+    def format_gutter(type, lineno, width)
+      if lineno
+        lineno.to_s.rjust(width)
+      elsif type == :del
+        "~".rjust(width)
+      else
+        " " * width
+      end
+    end
+
+    def color_for(type)
+      case type
+      when :add then Curses.color_pair(1)
+      when :del then Curses.color_pair(2)
+      when :header then Curses.color_pair(4) | Curses::A_BOLD
+      else Curses.color_pair(0)
+      end
+    end
+
+    def scroll_height
+      Curses.lines - 3
+    end
+
+    def gutter_width
+      @gutter_width ||= begin
+        max = file_lines.flat_map { |file| file.filter_map { |line| line.lineno } }.max || 1
+        max.to_s.length
+      end
+    end
+
+    def scroll_to(delta)
+      max = [0, lines.size - scroll_height].max
+      self.offset = (offset + delta).clamp(0, max)
+    end
+
+    def handle_input
+      key = Curses.getch
+      case key
+      when "q", 27 then return false
+      when "j", Curses::KEY_DOWN then scroll_to(1)
+      when "k", Curses::KEY_UP then scroll_to(-1)
+      when "f" then scroll_to(scroll_height)
+      when "b" then scroll_to(-scroll_height)
+      when "d" then scroll_to(scroll_height / 2)
+      when "u" then scroll_to(-scroll_height / 2)
+      when "g" then self.offset = 0
+      when "G" then scroll_to(lines.size)
+      when "n", Curses::KEY_RIGHT then jump_file(1)
+      when "p", Curses::KEY_LEFT then jump_file(-1)
+      when "?" then show_help
+      end
+      true
+    end
+
+    HELP_KEYS = [
+      ["j / ↓", "Scroll down"],
+      ["k / ↑", "Scroll up"],
+      ["d", "Half Page down"],
+      ["u", "Half page up"],
+      ["f", "Full page down"],
+      ["b", "Full page up"],
+      ["g", "Go to top"],
+      ["G", "Go to bottom"],
+      ["n / →", "Next file"],
+      ["p / ←", "Previous file"],
+      ["q / Esc", "Quit"],
+      ["?", "Toggle this help"]
+    ].freeze
+
+    KEY_W = HELP_KEYS.map { |k, _| k.length }.max
+    HELP_LINES = HELP_KEYS.map { |k, desc| "#{k.ljust(KEY_W)}   #{desc}" }.freeze
+    HELP_WIDTH = HELP_LINES.map(&:length).max + 6
+    HELP_HEIGHT = HELP_LINES.size + 4
+
+    def show_help
+      win = Curses.stdscr
+      top = (Curses.lines - HELP_HEIGHT) / 2
+      left = (Curses.cols - HELP_WIDTH) / 2
+      draw_box(win, top, left, HELP_WIDTH, HELP_HEIGHT, "Keybindings", HELP_LINES)
+      win.refresh
+      Curses.getch
+    end
+
+    def draw_box(win, top, left, width, height, title, content_lines)
+      win.attron(Curses.color_pair(0)) do
+        win.setpos(top, left)
+        win.addstr("┌#{"─" * (width - 2)}┐")
+
+        win.setpos(top + 1, left)
+        pad = width - 2 - title.length
+        win.addstr("│#{" " * (pad / 2)}#{title}#{" " * (pad - pad / 2)}│")
+
+        win.setpos(top + 2, left)
+        win.addstr("├#{"─" * (width - 2)}┤")
+
+        content_lines.each_with_index do |line, i|
+          win.setpos(top + 3 + i, left)
+          win.addstr("│  #{line.ljust(width - 5)} │")
+        end
+
+        win.setpos(top + height - 1, left)
+        win.addstr("└#{"─" * (width - 2)}┘")
+      end
+    end
+
+    def jump_file(direction)
+      new_idx = (file_idx + direction).clamp(0, files.size - 1)
+      return if new_idx == file_idx
+      self.file_idx = new_idx
+      self.offset = 0
+    end
+  end
+end

data/lib/sight/cli.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sight
+  module CLI
+    module_function
+
+    def run(argv)
+      if argv.include?("--help") || argv.include?("-h")
+        puts "Usage: sight"
+        puts "Interactive git diff viewer (staged + unstaged)"
+        puts
+        puts "Keys: j/k/↑/↓ scroll, f/b page, d/u half-page, g/G top/bottom, n/p/→/← next/prev file, ? help, q quit"
+        return
+      end
+
+      if argv.include?("--version") || argv.include?("-v")
+        puts "sight #{VERSION}"
+        return
+      end
+
+      raw = Git.diff
+      if raw.empty?
+        warn "No diff output."
+        return
+      end
+
+      files = DiffParser.parse(raw)
+      App.new(files).run
+    end
+  end
+end

data/lib/sight/diff_parser.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Sight
+  DiffLine = Struct.new(:type, :content, :lineno, :old_lineno, keyword_init: true)
+  Hunk = Struct.new(:context, :lines, keyword_init: true)
+  DiffFile = Struct.new(:path, :hunks, keyword_init: true)
+
+  module DiffParser
+    module_function
+
+    def parse(raw)
+      files = []
+      current_file = nil
+      current_hunk = nil
+      new_lineno = nil
+      old_lineno = nil
+
+      raw.each_line(chomp: true) do |line|
+        if line.start_with?("diff --git ")
+          current_hunk = nil
+          path = line.split(" b/", 2).last
+          current_file = DiffFile.new(path: path, hunks: [])
+          files << current_file
+        elsif current_file.nil?
+          next
+        elsif line.start_with?("@@ ")
+          context, new_start, old_start = parse_hunk_header(line)
+          new_lineno = new_start
+          old_lineno = old_start
+          current_hunk = Hunk.new(context: context, lines: [])
+          current_file.hunks << current_hunk
+        elsif current_hunk
+          type = case line[0]
+          when "+" then :add
+          when "-" then :del
+          when "\\" then :meta
+          else :ctx
+          end
+          ln_old = (type == :add || type == :meta) ? nil : old_lineno
+          ln_new = (type == :del || type == :meta) ? nil : new_lineno
+          old_lineno += 1 if ln_old
+          new_lineno += 1 if ln_new
+          current_hunk.lines << DiffLine.new(type: type, content: line, lineno: ln_new, old_lineno: ln_old)
+        end
+        # skip other header lines (index, ---, +++)
+      end
+
+      files
+    end
+
+    def parse_hunk_header(line)
+      match = line.match(/@@ -(\d+)(?:,\d+)? \+(\d+)(?:,\d+)? @@(.*)/)
+      return [nil, 1, 1] unless match
+      context = match[3].strip
+      old_start = match[1].to_i
+      new_start = match[2].to_i
+      [context.empty? ? nil : context, new_start, old_start]
+    end
+  end
+end

data/lib/sight/display_line.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sight
+  DisplayLine = Struct.new(:type, :text, :lineno, keyword_init: true)
+end

data/lib/sight/git.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sight
+  module Git
+    module_function
+
+    def diff
+      output, success = run_cmd(["git", "diff", "--no-color", "HEAD"])
+      unless success
+        output, success = run_cmd(["git", "diff", "--no-color", "--cached"], err: [:child, :out])
+        raise Error, "git diff failed: #{output}" unless success
+      end
+      output
+    end
+
+    def run_cmd(cmd, err: IO::NULL)
+      output = IO.popen(cmd, err: err, &:read)
+      [output, $?.success?]
+    end
+  end
+end

data/lib/sight/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sight
+  VERSION = "0.1.0"
+end

data/lib/sight.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "sight/version"
+require_relative "sight/display_line"
+require_relative "sight/diff_parser"
+require_relative "sight/git"
+require_relative "sight/cli"
+require_relative "sight/app"
+
+module Sight
+  class Error < StandardError; end
+end

data/sig/sight.rbs

@@ -0,0 +1,4 @@
+module Sight
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: sight
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ariel Rzezak
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: A TUI tool to browse git diffs interactively with colors, file navigation,
+  and scrolling.
+email:
+- arzezak@gmail.com
+executables:
+- sight
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/sight
+- lib/sight.rb
+- lib/sight/app.rb
+- lib/sight/cli.rb
+- lib/sight/diff_parser.rb
+- lib/sight/display_line.rb
+- lib/sight/git.rb
+- lib/sight/version.rb
+- sig/sight.rbs
+homepage: https://github.com/arzezak/sight
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/arzezak/sight
+  source_code_uri: https://github.com/arzezak/sight
+  changelog_uri: https://github.com/arzezak/sight/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.7
+specification_version: 4
+summary: Interactive git diff viewer for the terminal
+test_files: []