Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maestro dumps its state files into $HOME #1798

Open
bartekpacia opened this issue Jul 12, 2024 · 1 comment
Open

Maestro dumps its state files into $HOME #1798

bartekpacia opened this issue Jul 12, 2024 · 1 comment
Labels
bug Something isn't working good first issue Good for newcomers wanting to contribute maestro cli Related to the command-line Maestro tool P3 Issues that are less important

Comments

@bartekpacia
Copy link
Contributor

bartekpacia commented Jul 12, 2024

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 Stop depending on AppleSimulatorUtils #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

@bartekpacia bartekpacia added bug Something isn't working maestro cli Related to the command-line Maestro tool labels Jul 12, 2024
@bartekpacia bartekpacia changed the title Maestro dumps all data into $HOME Maestro dumps its state files into $HOME Jul 12, 2024
@bartekpacia bartekpacia added the good first issue Good for newcomers wanting to contribute label Jul 12, 2024
@unlimitedcodeG

This comment has been minimized.

@bartekpacia bartekpacia added the P3 Issues that are less important label Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers wanting to contribute maestro cli Related to the command-line Maestro tool P3 Issues that are less important
Projects
None yet
Development

No branches or pull requests

2 participants