dlond f755e49d66 Add git workflow reference to CLAUDE.md

Reference the shared git workflow at ../git-workflow.yaml to provide
Claude Code instances with standardized development process guidance.

Resolves #6

2025-08-20 14:30:30 +12:00

2.9 KiB

Raw Blame History

CLAUDE.md

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

Neovim Configuration Structure

This is a Neovim configuration forked from https://github.com/nvim-lua/kickstart.nvim and structured to minimize merge conflicts when updating from upstream. All custom modifications are isolated in the lua/custom/ directory, allowing the main init.lua and kickstart files to be updated with minimal conflicts.

The configuration is organized in a modular structure:

init.lua: Main configuration file that loads all settings, keymaps, and plugins
lua/custom/: Custom configuration modules
- options.lua: Custom vim options (indentation, Nerd Font settings)
- keymaps.lua: Custom key mappings
- plugins/: Plugin configurations
  - init.lua: Plugin imports and basic plugin setup
  - lsp/: LSP-specific configurations
    - lsp.lua: LSP server configurations (Python, Nix, Rust, Go, C/C++)
    - clangd_helper.lua: Advanced clangd setup with compile_commands.json detection and file watching

LSP Configuration

The LSP setup includes:

clangd: C/C++ with automatic compile_commands.json detection and file watching
pyright: Python language server with basic type checking
nixd: Nix language server
ruff: Python linter
texlab: LaTeX support
cmake: CMake language server

The clangd configuration in lua/custom/plugins/lsp/clangd_helper.lua automatically:

Searches for compile_commands.json files using fd
Watches for changes and restarts clangd when compile_commands.json is updated
Provides a :ReloadClangd command for manual restart

Key Features

Uses lazy.nvim for plugin management
Blink.cmp for autocompletion with LSP integration
Telescope for fuzzy finding
Treesitter for syntax highlighting
Which-key for keymap help
Mini.nvim modules for text objects, surround, and statusline
TokyoNight colorscheme

Common Commands

:Lazy - Manage plugins (install, update, etc.)
:checkhealth - Check Neovim configuration health
:ReloadClangd - Manually restart clangd LSP server
<space>sh - Search help documentation
<space>sf - Find files
<space>sg - Live grep search
<space>f - Format current buffer

Git Workflow

This project follows the standardized git workflow documented at: ../git-workflow.yaml

Key principles:

Never work directly on main branch
Issue-driven development with gh issue create
Always use worktrees for feature development
Complete cleanup after merge

Development Workflow

Configuration changes are made in lua/custom/ files
Plugin configurations go in lua/custom/plugins/
LSP servers are expected to be installed system-wide (via Nix/Home Manager based on comments)
The configuration uses lazy loading for most plugins to optimize startup time

2.9 KiB Raw Blame History