Skip to content

AGENTS.md

Latest commit

 

History

History
34 lines (29 loc) · 2.65 KB

AGENTS.md

File metadata and controls

34 lines (29 loc) · 2.65 KB

AGENTS.md

Build, Lint, and Test

  • Run all tests: ./run_tests.sh
  • Minimal tests: ./run_tests.sh -t minimal nvim --headless -u tests/minimal/init.lua -c "lua require('plenary.test_harness').test_directory('./tests/minimal', {minimal_init = './tests/minimal/init.lua', sequential = true})"
  • Unit tests: ./run_tests.sh -t unit nvim --headless -u tests/minimal/init.lua -c "lua require('plenary.test_harness').test_directory('./tests/unit', {minimal_init = './tests/minimal/init.lua'})"
  • Replay tests: ./run_tests.sh -t replay nvim --headless -u tests/minimal/init.lua -c "lua require('plenary.test_harness').test_directory('./tests/replay', {minimal_init = './tests/minimal/init.lua'})"
  • Run a single test: Replace the directory in the above command with the test file path, e.g.: nvim --headless -u tests/manual/init.lua -c "lua require('plenary.test_harness').test_directory('./tests/unit/job_spec.lua', {minimal_init = './tests/minimal/init.lua'})"
  • Manual/Visual tests: ./tests/manual/run_replay.sh - Replay captured event data for visual testing
  • Debug rendering in headless mode: nvim --headless -u tests/manual/init_replay.lua "+ReplayHeadless" "+ReplayLoad tests/data/FILE.json" "+ReplayAll 0" "+qa" This will replay events and dump the output buffer to stdout, useful for debugging rendering issues without a UI. You can also run to just a specific message # with (e.g. message # 12): nvim --headless -u tests/manual/init_replay.lua "+ReplayHeadless" "+ReplayLoad tests/data/message-removal.json" "+ReplayNext 12" "+qa"
  • Lint: No explicit lint command; follow Lua best practices.

Code Style Guidelines

  • Imports: local mod = require('mod') at the top. Group standard, then project imports.
  • Formatting: 2 spaces per indent. No trailing whitespace. Lines ≤ 100 chars.
  • Types: Use Lua annotations (---@class, ---@field, etc.) for public APIs/config.
  • Naming: Modules: snake_case.lua; functions/vars: snake_case; classes: CamelCase.
  • Error Handling: Use vim.notify for user-facing errors. Return early on error.
  • Comments: Avoid obvious comments that merely restate what the code does. Only add comments when necessary to explain why something is done, not what is being done. Prefer self-explanatory code.
  • Functions: Prefer local functions. Use M.func for module exports.
  • Config: Centralize in config.lua. Use deep merge for user overrides.
  • Tests: Place in tests/minimal/, tests/unit/, or tests/replay/. Manual/visual tests in tests/manual/.

Agentic coding agents must follow these conventions strictly for consistency and reliability.