mobile-dev-inc/maestro

Maestro dumps its state files into `$HOME`

Open

#1,798 opened on Jul 12, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Kotlin (6,111 stars) (306 forks)batch import
P3buggood first issuemaestro cli

Description

Some users don't like when programs write tmp/state/config files to their $HOME (me included).

Current behavior

Upon installation, Maestro creates the ~/.maestro directory and stores some data there.

Expected behavior

There exist a spec called XDG Base Directory Specification. Maestro should follow it.

Implementation idea

$ ls -1F ~/.maestro
bin/
deps/
lib/
sessions
tests/
tmp/
uuid

I suggest the following:

  • bin/ should be in the path made for that, e.g. /usr/local/bin (or wherever your OS package manager installs programs)
  • deps/ contains only the applesimutil binary, which we may not need soon, see #1797
  • lib/ contains JARs. Not sure where they exactly they should go (let's look at how other JVM apps do this)
  • sessions -> XDG_STATE_HOME
  • tests/ -> XDG_STATE_HOME
  • tmp/ -> XDG_CACHE_HOME (not sure what goes in there, it's always empty on my machine)
  • uuid -> XDG_STATE_HOME

To support existing CLI installs, we should first look for ~/.maestro, and then fallback to XDG base dir spec.

Additional context

Contributor guide

Tech stack
kotlin
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of XDG Base Directory SpecificationBasic Kotlin programmingUnderstanding of Maestro's file structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Look at the Maestro source code to identify where `~/.maestro` paths are used. The issue lists directories: bin/, deps/, lib/, sessions, tests/, tmp/, uuid. Implement logic to check for `~/.maestro` first for backward compatibility, then fallback to XDG base directories. Use `XDG STATE HOME` for sessions, tests, uuid; `XDG CACHE HOME` for tmp; and system paths for bin/ and lib/. Refer to the linked code for logs in `~/Library/Logs/maestro`. Ensure changes are tested and follow the existing code style.