yank-for-claude.nvim: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This is a Neovim plugin called yank-for-claude.nvim that helps users yank code references in Claude AI's preferred format (@filename#L10-20).

Current Status: The project is fully implemented with a simplified API. Stack functionality has been removed to focus on core features.

Development Commands

Testing

# Run all tests (using bun)
bun test

# Run tests directly with Neovim
nvim --headless -u tests/minimal_init.vim -c "PlenaryBustedDirectory tests/" +qa

# Run a single test file
nvim --headless -u tests/minimal_init.vim -c "PlenaryBustedFile tests/yank-for-claude_spec.lua" +qa

Code Formatting & Linting

# Format code
bun format
# or
stylua .

# Check formatting
stylua --check .

# Lint code
luacheck .

Git Hooks (Lefthook)

# Install git hooks
bun prepare
# or
lefthook install

# The following hooks are configured:
# - pre-commit: format check, lint, and tests
# - pre-push: tests
# - commit-msg: conventional commit format check

Architecture

Core Components

1. Main Module (lua/yank-for-claude/init.lua):

   • Provides commands: YankForClaude and YankForClaudeWithContent
   • Contains core logic for formatting references
   • Handles command arguments (line1, line2) for range support
   • Exports direct mapping functions from yank.lua

2. Config Module (lua/yank-for-claude/config.lua):

   • Simple configuration management
   • Only contains notify option (boolean)

3. Yank Module (lua/yank-for-claude/yank.lua):

   • Direct functions for key mappings
   • Each function first performs normal yank to trigger TextYankPost
   • Then replaces clipboard with formatted reference
   • Functions: yank_visual(), yank_line(), yank_visual_with_content(), yank_line_with_content()

Key Design Decisions

1. TextYankPost Compatibility:
   • The yank.lua functions perform normal yank operations first
   • This ensures TextYankPost autocmds are triggered for highlight integration
   • Clipboard content is then replaced with the formatted reference