Skip to content

CLAUDE.md

Latest commit

 

History

History
35 lines (24 loc) · 1.88 KB

CLAUDE.md

File metadata and controls

35 lines (24 loc) · 1.88 KB

Appdirs

A Pony library for detecting platform-specific user directories (data, config, cache, logs, state, home). Port of the Python appdirs library. Cross-platform: Windows, macOS, Linux/Unix.

Building and Testing

make test       # build and run all tests (unit tests + build examples)
make unit-tests # run unit tests only
make test-one t=TestName       # run a single test by name
make clean      # clean build artifacts and dependencies

Uses corral for dependency management (fetched automatically by the Makefile). No external dependencies beyond the Pony standard library.

Project Structure

  • appdirs/appdirs.pony - Core AppDirs class and public API
  • appdirs/known_folders.pony - Windows FFI for SHGetKnownFolderPath
  • appdirs/windows_code_pages.pony - Windows codepage constants
  • appdirs/_test.pony - PonyTest unit tests
  • examples/simple-example/ - Example usage

Architecture

Single main class AppDirs with constructor parameters (env_vars, app_name, optional app_author, app_version, roaming, osx_as_unix) and eight public methods returning platform-appropriate directory paths. Platform logic is handled via a _Platform match type with ifdef used only at construction time. All public methods are partial (?) — they raise errors when the home directory is unavailable.

Windows support uses FFI to SHGetKnownFolderPath. macOS defaults to ~/Library/... paths but can be switched to XDG via osx_as_unix. Linux/Unix uses XDG base directory spec with standard fallbacks.

Conventions

  • Follows Pony standard library style guide (80-column line limit), enforced by pony-lint in CI
  • Test-file types annotated with \nodoc\
  • Tests are platform-conditional using ifdef directives
  • Squash merge only; PR titles become CHANGELOG entries