Skip to content

CLAUDE.md

Latest commit

 

History

History
38 lines (27 loc) · 2.16 KB

CLAUDE.md

File metadata and controls

38 lines (27 loc) · 2.16 KB

Claude Assistant Guide for Dotfiles Repository

Development Commands

  • Code formatting: Uses Neovim with conform.nvim (stylua, fish_indent, shfmt, prettierd, yapf)
  • Edit configuration: chezmoi edit <file>
  • Apply changes: chezmoi apply
  • Update repository: chezmoi update
  • Search codebase: rg <pattern> or use Fish function rg_fzf_search

Code Style Guidelines

  • Fish shell: Use fish_indent for consistent formatting
  • Lua: Format with stylua, follow Neovim Lua style conventions
  • Shell scripts: Format with shfmt
  • Python: Use yapf formatter, pyright and ruff for linting
  • JavaScript/TypeScript: Follow ESLint rules, use TypeScript for type safety
  • Configuration files: Use YAML or TOML with proper schema validation
  • Naming: Use snake_case for Fish functions, follow language conventions elsewhere
  • Documentation: Include README.md files in directories explaining purpose
  • Markdown callouts: Use GitHub-flavored markdown callouts (NOTE, TIP, IMPORTANT, WARNING, CAUTION) sparingly and only when they provide genuine value to the content. Do not overuse or create artificial reasons to include them. Format: > [!WARNING] followed by > callout text on subsequent lines (no optional title after [!CALLOUT])

Repository Structure

  • Managed using chezmoi dotfile manager
  • Configuration organized by tool with README files explaining usage
  • Secrets kept in secrets/ directory (excluded from version control)

Active Technologies

  • Markdown (GitHub-flavored), Mermaid for diagrams + Documentation tools (markdown linters: markdownlint-cli), diagram generation (mermaid-cli for pre-rendering diagrams), repository analysis tools (tree, ripgrep for codebase surveying) (001-comprehensive-docs)
  • Markdown files stored in repository (co-located with configurations), static documentation assets (001-comprehensive-docs)

Recent Changes

  • 001-comprehensive-docs: Added Markdown (GitHub-flavored), Mermaid for diagrams + Documentation tools (markdown linters: markdownlint-cli), diagram generation (mermaid-cli for pre-rendering diagrams), repository analysis tools (tree, ripgrep for codebase surveying)

@AGENTS_BEADS.md