search

ransome1 / sleek

todo.txt manager for Linux, Windows and MacOS, free and open-source (FOSS)
https://github.com/ransome1/sleek/wiki
MIT License
1.33k stars 104 forks source link

Document where `user-preferences.json` is #487

Closed callegar closed 1 year ago

callegar commented 1 year ago

Is it an actual bug?

Probably so, since the file is mentioned in the wiki, but impossible to find.

Did you check if the bug has already been reported?

yes

Describe the bug

The wiki mentions a user-preferences.json file, but I do not appear to be able to find it. Does it get autocreated on first usage of the software?

To Reproduce

Seek the user-preferences.json file.

Do you see any error entries in sleeks developer tools?

N/A

Expected behavior

I expect to be able to find the user-preferences.json file. Saying where it is accessed in the About screen or in the wiki would help. The wiki only documents the Mac case. Other bugs suggest that on linux it should be in ~/.config/sleek, but I do not have that dir.

Screenshots

N/A

Desktop (please complete the following information):

callegar commented 1 year ago

OK, found the file in ~/.var/app/com.github.ransome1.sleek/config/sleek/user-preferences.json. Makes sense now, but not obvious... Please document it.

ransome1 commented 1 year ago

It's hard to document this, every OS and every distribution channel (Snap, Flat, AUR, Windows Standalone, Windows setup, Mac App Store, Brew on MacOS, Windows Store and so on) stores it in different locations. In sleek we use the default location of your user data, defined by the distribution channel.

This is why I stay vague on the documentation: These preferences can be changed in user-preferences.json which is located in your user data folder. For example on a Mac this is in /home/$USER/Application Support/sleek https://github.com/ransome1/sleek/wiki/Hidden-preferences,-custom-variables-and-command-line-parameters

If you for instance use Flathub, it is Flathub, which decides where it stores user data. Not sleek. Please understand I simply can't document this for each and every distribution.

As this is not a bug I would like to close this.

callegar commented 1 year ago

I understand. Given the variety of possible locations, I wonder if it could be possible to dynamically determine the location of the file and provide it in the about dialog.

ransome1 commented 1 year ago

@callegar that might be possible, let me see what can be done about that.