Skip to content

CLAUDE.md

Latest commit

 

History

History
52 lines (44 loc) · 2.81 KB

CLAUDE.md

File metadata and controls

52 lines (44 loc) · 2.81 KB

Loki Development Guide

Build & Test Commands

make all                      # build all binaries
make loki                     # build loki only
make logcli                   # build logcli only
make test                     # run all unit tests
make test-integration         # run integration tests
go test ./...                 # run all tests with Go directly
go test -v ./pkg/logql/...    # run tests in specific package
go test -run TestName ./pkg/path  # run a specific test
BUILD_IN_CONTAINER=true NONINTERACTIVE=true make lint  # run all linters (use in CI-like environment)
make format                   # format code (gofmt and goimports)

Note: Use BUILD_IN_CONTAINER=true NONINTERACTIVE=true make lint to run linting in a container environment that matches CI exactly. The NONINTERACTIVE=true flag prevents Docker from trying to allocate a TTY, which is necessary in non-interactive environments like claude-code. The Makefile automatically detects and handles git worktrees by using git rev-parse --git-dir and git rev-parse --git-common-dir to mount the appropriate git directories, ensuring git commands work correctly in the container regardless of worktree structure.

Building the Frontend

The Loki UI/frontend (different from the query-frontend) is located in pkg/ui/frontend and is built with Vite. From pkg/ui/frontend, you can use the following commands.

make build          # build the frontend
make check-deps     # check for vulnerabilities in the frontend dependencies
make clean          # clean the frontend
make dev            # start the frontend in development mode
make lint           # lint the frontend code
make test           # run the frontend tests

Code Style Guidelines

  • Follow standard Go formatting (gofmt/goimports)
  • Import order: standard lib, external packages, then Loki packages
  • Error handling: Always check errors with if err != nil { return ... }
  • Use structured logging with leveled logging (go-kit/log)
  • Use CamelCase for exported identifiers, camelCase for non-exported
  • Document all exported functions, types, and variables
  • Use table-driven tests when appropriate
  • Follow Conventional Commits format: <change type>: Your change
  • For frontend: use TypeScript, functional components, component composition
  • Frontend naming: lowercase with dashes for directories (components/auth-wizard)

Documentation Standards

  • Follow the Grafana Writers' Toolkit Style Guide
  • Use CommonMark flavor of markdown for documentation
  • Create LIDs (Loki Improvement Documents) for large functionality changes
  • Document upgrading steps in docs/sources/setup/upgrade/_index.md
  • Preview docs locally with make docs from the /docs directory
  • Include examples and clear descriptions for public APIs