initial commit

Author: mosheavni

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Lua
+        uses: leafo/gh-actions-lua@v10
+        with:
+          luaVersion: "5.1"
+
+      - name: Setup LuaRocks
+        uses: leafo/gh-actions-luarocks@v4
+
+      - name: Install luacheck
+        run: luarocks install luacheck
+
+      - name: Run luacheck
+        run: luacheck lua/ --globals vim
+
+      - name: Install StyLua
+        uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: latest
+          args: --check lua/

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Tests
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: unit tests
+    strategy:
+      fail-fast: false
+      matrix:
+        neovim: [stable, nightly]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.neovim }}
+
+      - name: Cache stylua
+        uses: actions/cache@v4
+        with:
+          path: /usr/local/bin/stylua
+          key: stylua-${{ runner.os }}-${{ hashFiles('Makefile') }}
+
+      - name: Install dependencies
+        run: make prepare
+
+      - name: Run tests
+        run: |
+          nvim --version
+          make test

.gitignore

@@ -0,0 +1,18 @@
+# Lua
+*.luac
+lua_modules/
+.luarocks/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Test output
+.tests/

.luacheckrc

@@ -0,0 +1,37 @@
+-- Luacheck configuration for Neovim Lua plugins
+
+-- Global objects
+globals = {
+  "vim",
+}
+
+-- Read-only globals
+read_globals = {
+  "vim",
+}
+
+-- Don't report unused self arguments of methods
+self = false
+
+-- Don't report unused arguments when they start with underscore
+unused_args = false
+
+-- Max line length
+max_line_length = 120
+
+-- Ignore some warnings
+ignore = {
+  "212", -- Unused argument
+  "631", -- Line is too long
+}
+
+-- Exclude test files from some checks
+files["tests/**/*.lua"] = {
+  globals = {
+    "describe",
+    "it",
+    "before_each",
+    "after_each",
+    "assert",
+  }
+}

CLAUDE.md

@@ -0,0 +1,86 @@
+<!-- markdownlint-disable MD013 -->
+
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+search-replace.nvim is a Neovim plugin for enhanced search and replace with a floating dashboard. It provides quick keymaps to populate substitute commands, toggle flags (g/c/i), cycle through ranges/separators/magic modes, and shows a live dashboard during command-line editing.
+
+## Commands
+
+### Linting
+
+```bash
+luacheck lua/ --globals vim
+stylua --check lua/
+```
+
+### Formatting
+
+```bash
+stylua lua/
+```
+
+### Testing
+
+```bash
+# Run all tests (requires busted test framework)
+busted tests/
+
+# Run a specific test file
+busted tests/search-replace_spec.lua
+```
+
+## Architecture
+
+The plugin follows a modular architecture with four main components:
+
+### init.lua (Entry Point)
+
+- Handles `setup()` configuration merging
+- Sets up keymaps for normal/visual/command-line modes
+- Re-exports public API from core module
+
+### core.lua (Business Logic)
+
+- Manages search-replace state (`sar_state`) tracking active session, current word, separator, magic mode
+- Implements toggle functions that return keystroke sequences using `<C-\>e` expression pattern
+- All toggle functions use `set_cmd_and_pos()` helper to update both command text and cursor position atomically
+- Uses `should_sar()` to detect if current cmdline is a substitute command (either in active mode or auto-detected)
+
+### dashboard.lua (UI)
+
+- Parses substitute commands and displays current state in a floating window
+- Uses `CmdlineChanged` autocmd to auto-detect and display dashboard for any substitute command
+- Maintains a `hidden` state to respect user's manual toggle
+- Applies syntax highlighting using extmarks in a namespace
+
+### float.lua (Window Management)
+
+- Reusable floating window implementation inspired by mini.notify architecture
+- Handles buffer/window caching, creation, and cleanup
+- Uses `vim.cmd('redraw')` after updates for immediate display
+- Reschedules operations via `vim.schedule()` when in fast event context
+
+### utils.lua (Shared Utilities)
+
+- Pattern constants for substitute command detection
+- `parse_substitute_cmd()` - parses `:s` commands into range/separator/magic/search/replace/flags
+- `split_by_separator()` - splits strings while respecting escaped separators
+- `trigger_cmdline_refresh()` - uses fake keystroke (space + backspace) to force cmdline refresh
+
+## Key Implementation Details
+
+- Toggle functions return expression strings that Neovim evaluates (using `{ expr = true }` in keymap)
+- The `<C-\>e` pattern allows replacing the entire command line via expression evaluation
+- Dashboard refresh uses a fake keystroke technique because direct redraws don't work in cmdline mode
+- The plugin auto-detects any substitute command (not just those started via `<leader>r`) to show the dashboard
+
+## Code Style
+
+- Uses 2-space indentation
+- Single quotes preferred
+- Max line length: 120 characters
+- LuaDoc annotations for type hints (`---@class`, `---@param`, `---@return`)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Moshe Avni
+
+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.

Makefile

@@ -0,0 +1,23 @@
+.PHONY: all lint test prepare clean
+
+all: test
+
+lint:
+	stylua --check lua/
+	luacheck lua/ --globals vim
+
+test: prepare lint
+	nvim --headless --noplugin -u tests/minimal_init.vim -c "PlenaryBustedDirectory tests { minimal_init = './tests/minimal_init.vim' }"
+
+prepare:
+	@test -d ../plenary.nvim || git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ../plenary.nvim
+	@command -v stylua >/dev/null || { \
+		curl -L -o stylua.zip https://github.com/JohnnyMorganz/StyLua/releases/latest/download/stylua-linux-x86_64.zip && \
+		unzip stylua.zip && \
+		rm -f stylua.zip && \
+		chmod +x stylua && \
+		sudo mv stylua /usr/local/bin/; \
+	}
+
+clean:
+	rm -rf ../plenary.nvim