Consistently use XDG base directiories #381

Cu3PO42 · 2024-04-03T20:47:03Z

Hi! First off: thank you for the wonderful work you've done in this project! Everything looks so extremely polished.

This PR serves two main functions:

First, it consistently uses the XDG base directory spec. Before, it was already used in many places (via the GLib functions get_user_xyz_dir), but not everywhere. Other locations used the default values for these paths directly (e.g. ~/.config and ~/.cache). While it is rare to see a system that changes these defaults, it could happen and the inconsistent handling would break your config.

Further, it moves some files from XDG_CONFIG_HOME and XDG_CACHE_HOME to XDG_STATE_HOME. This happens for two different reasons:

It removes any necessity to write to AGS' configuration folder, which greatly simplifies deployment via Nix and Home-Manager. applycolor.sh still writes to the config folders of other programs. Unfortunately, I do believe there is no simple, generic solution to avoid this.
XDG_CACHE_HOME should generally be safe to delete without breaking anything. However, some files stored there (such as firstrun.txt, todo.json) really should be kept.

I have done my best to seperate these changes into smaller commits that make sense individually.

I did not spot any regressions, but I'm not familiar with all of the features, so it's possible I missed some. In particular, much of the dynamic color feature does not currently/not yet work on my NixOS setup, therefore my tests pertaining it are rather superficial.

clsty · 2024-04-03T23:04:05Z

However, some files stored there (such as firstrun.txt, todo.json) really should be kept.

install.sh will overwrite everything except user_options.js in the ~/.config/ags folder.
Please post a list of files that should not be overwritten by install.sh for this PR. If it's merged, I'll handle the rest.

There's a problem though. I found that on my Arch Linux,

echo "1$XDG_CONFIG_HOME 2$XDG_CACHE_HOME 3$XDG_STATE_HOME"

Outputs 1 2 3 which means those vars are empty.

According to Arch Wiki, it seems that these vars are not set by default.

To solve this problem, if it's in a bash script, we can use ${XDG_CONFIG_HOME:-~/.config} to provide a fallback value for it. Though this is in js file for AGS, I'm not sure will it work.

Cu3PO42 · 2024-04-04T04:49:58Z

I don't believe install.sh currently poses any problem here. These files (firstrun.txt, ...) I was referring to were previously placed in XDG_CACHE_HOME (which may be deleted, albeit not by install.sh), but are now moved to XDG_STATE_HOME. This directory was not used by illogical-impulse prior to this PR and should not be affected by install.sh.

I do appreciate your help and offer, though.

As far as these variables not being defined, yes, that can happen and is perfectly compliant with the spec. The fix you propose is already included in this PR. If you check the first lines of the shell scripts I changed, you will find I have added the block

XDG_CONFIG_HOME="${XDG_CONFIG_HOME:-$HOME/.config}"
XDG_CACHE_HOME="${XDG_CACHE_HOME:-$HOME/.cache}"
XDG_STATE_HOME="${XDG_STATE_HOME:-$HOME/.local/state}"

This is done simply so we don't have to include the default value everywhere and keep the rest of the file easier to read.

As far as code in AGS is concerned, it doesn't need any particular workaround: GLib.get_user_*_dir() checks and uses the environment variable if it is defined and uses the same defaults otherwise.

clsty · 2024-04-04T10:25:44Z

As far as code in AGS is concerned, it doesn't need any particular workaround: GLib.get_user_*_dir() checks and uses the environment variable if it is defined and uses the same defaults otherwise.

As far as I know, the environment variables of a process are only passed to its sub-process, which means if AGS is running some bash scripts containing those default values for XDGs, AGS will not able to know these values, since AGS is their parent process.

I don't know well about AGS. Maybe you are right.

Cu3PO42 · 2024-04-04T13:26:43Z

As far as I know, the environment variables of a process are only passed to its sub-process

You are right that these variables are not passed to AGS. These variables aren't even passed to child processes: that only happens to variables marked with export. These fallback definitions as I have written them will not affect any other processes, they are relevant for the individual scripts.

However, this is fully intended and not a problem. Every script has its own fallback definitions and AGS does not explicitly need the fallbacks. The behavior of the built-in functions GLib.get_user_*_dir does the necessary computation on its own: if XDG_*_HOME is defined, it will use that variable, otherwise it will use the default values defined by the specification. These are ~/.config, ~/.cache, and ~/.local/state. These are also the defaults defined in the scripts. Therefore, the same, correct directories will be used even if XDG_*_HOME are not set.

Cu3PO42 · 2024-05-18T13:31:19Z

Hi! I just rebased this on current main and fixed any issues that cropped up (that I could find).

Is there anything I could do to help get this merged?

Cu3PO42 · 2024-05-18T19:41:20Z

Unfortunately, I have just found a potential issue with how the SCSS is handled. I'll look into it and patch it asap.

Cu3PO42 · 2024-05-19T13:01:27Z

It turns out this line in the dart-sass docs is only mildly accurate:

This option (abbreviated -I) adds an additional load path for Sass to look for stylesheets. It can be passed multiple times to provide multiple load paths. Earlier load paths will take precedence over later ones.

The current directory always wins over any load paths. Therefore I had to move _material.scss to a new folder; currently scss/fallback. It is applied whenever no other colors have been generated yet. I don't know if there's any sensible default beyond "whatever is currently in the repository".

end-4 · 2024-05-19T14:29:02Z

ugh
when i try this styling gets all messed up

Cu3PO42 · 2024-05-19T14:44:00Z

Thanks for trying it! It seems fine on my end:

Could you check if ~/.cache/ags/user/generated/style.css contains some error message?

end-4

No other problem in the code
Btw sorry for being lazy

end-4 · 2024-05-19T14:34:44Z

.config/ags/config.js

-Utils.exec(`bash -c 'echo "" > ${App.configDir}/scss/_musicwal.scss'`); // reset music styles
-Utils.exec(`bash -c 'echo "" > ${App.configDir}/scss/_musicmaterial.scss'`); // reset music styles
+Utils.exec(`bash -c 'echo "" > ${GLib.get_user_state_dir()}/ags/scss/_musicwal.scss'`); // reset music styles
+Utils.exec(`bash -c 'echo "" > ${GLib.get_user_state_dir()}/ags/scss/_musicmaterial.scss'`); // reset music styles
 async function applyStyle() {
    Utils.exec(`mkdir -p ${COMPILED_STYLE_DIR}`);
-    Utils.exec(`sass ${App.configDir}/scss/main.scss ${COMPILED_STYLE_DIR}/style.css`);
+    Utils.exec(`sass -I "${GLib.get_user_state_dir()}/ags/scss" -I "${App.configDir}/scss/fallback" "${App.configDir}/scss/main.scss" "${COMPILED_STYLE_DIR}/style.css"`);


messes up styles ¯_(ツ)_/¯

end-4 · 2024-05-19T14:34:57Z

.config/ags/config_overviewOnly.js

-Utils.exec(`bash -c 'echo "" > ${App.configDir}/scss/_musicwal.scss'`); // reset music styles
-Utils.exec(`bash -c 'echo "" > ${App.configDir}/scss/_musicmaterial.scss'`); // reset music styles
 const COMPILED_STYLE_DIR = `${GLib.get_user_cache_dir()}/ags/user/generated`
+Utils.exec(`bash -c 'echo "" > ${GLib.get_user_state_dir()}/ags/scss/_musicwal.scss'`); // reset music styles
+Utils.exec(`bash -c 'echo "" > ${GLib.get_user_state_dir()}/ags/scss/_musicmaterial.scss'`); // reset music styles
 async function applyStyle() {
    Utils.exec(`mkdir -p ${COMPILED_STYLE_DIR}`);
-    Utils.exec(`sass ${App.configDir}/scss/main.scss ${COMPILED_STYLE_DIR}/style.css`);
+    Utils.exec(`sass -I "${GLib.get_user_state_dir()}/ags/scss" -I "${App.configDir}/scss/fallback" "${App.configDir}/scss/main.scss" "${COMPILED_STYLE_DIR}/style.css"`);


end-4 · 2024-05-19T14:54:10Z

Thanks for trying it! It seems fine on my end:

Could you check if ~/.cache/ags/user/generated/style.css contains some error message?

/* Error: Can't find stylesheet to import.
 *   ,
 * 2 | @import 'musicmaterial';
 *   |         ^^^^^^^^^^^^^^^
 *   '
 *   .config/ags/scss/_music.scss 2:9  @import
 *   .config/ags/scss/main.scss 27:9   root stylesheet */

body::before {
  font-family: "Source Code Pro", "SF Mono", Monaco, Inconsolata, "Fira Mono",
      "Droid Sans Mono", monospace, monospace;
  white-space: pre;
  display: block;
  padding: 1em;
  margin-bottom: 1em;
  border-bottom: 2px solid black;
  content: "Error: Can't find stylesheet to import.\a   \2577 \a 2 \2502  @import 'musicmaterial';\a   \2502          ^^^^^^^^^^^^^^^\a   \2575 \a   .config/ags/scss/_music.scss 2:9  @import\a   .config/ags/scss/main.scss 27:9   root stylesheet";
}

Cu3PO42 · 2024-05-19T15:03:16Z

No need to be sorry! I'm thankful you're developing this!

I believe I know the issue and why it's working for me and not for you. I forgot to create ~/.local/state/ags/scss if it doesn't already exist. I must have inadvertently done that and not realized that step is missing. I'll push a fix for this.

end-4 · 2024-05-19T15:27:49Z

seems good, i'll merge

end-4 · 2024-05-19T15:28:43Z

is there anything else that needs to be done to make sure nix users are happy?
(except providing a flake.nix since i'm not capable)

Cu3PO42 · 2024-05-19T18:43:14Z

Thanks for merging!

I have a lot of things working right now in a Nix environment. You can simply run nix run github:Cu3PO42/gleaming-glacier/next#illogical-impulse. Some system requirements need to be satisfied externally, for example I can't put a user into groups from a simple Nix package. This also only starts AGS in a configured state, it does not set up Hyprland or anything else.

If one also (manually) applied your other configs, I imagine dynamic color generation would work. In my setup it works only for AGS, but not for Hyprland, since my Hyprland config is also read-only. I'm still working on making more things work and as I discover ways to do that, I'll discuss and submit more patches.

EDIT: The code for my Nix package is here (technically also here and here).

This reverts commit 44988b0, reversing changes made to f181fd3.

it's not needed anymore This reverts commit 8f3721e.

Cu3PO42 force-pushed the xdg-paths branch from bf9a6c6 to d52578c Compare April 3, 2024 20:56

Cu3PO42 added 2 commits May 18, 2024 15:20

chore: always use XDG_CACHE_DIR in AGS

dc28ab3

feat: use XDG base directories

9c56e6d

Cu3PO42 force-pushed the xdg-paths branch from d52578c to d214a07 Compare May 18, 2024 13:26

Cu3PO42 force-pushed the xdg-paths branch 2 times, most recently from f7afed2 to 21fae43 Compare May 18, 2024 19:24

Cu3PO42 changed the title ~~Consistently use XDG base directiories~~ Draft: Consistently use XDG base directiories May 18, 2024

Cu3PO42 force-pushed the xdg-paths branch from 21fae43 to 2641792 Compare May 19, 2024 12:58

Cu3PO42 changed the title ~~Draft: Consistently use XDG base directiories~~ Consistently use XDG base directiories May 19, 2024

end-4 reviewed May 19, 2024

View reviewed changes

Cu3PO42 added 3 commits May 19, 2024 17:05

chore: move color .scss files to XDG_STATE_HOME

a2c9ce0

chore: move firstrun.txt to XDG_STATE_HOME

425dad9

chore: move more files to XDG_STATE_HOME

797c3a2

Cu3PO42 force-pushed the xdg-paths branch from 2641792 to 797c3a2 Compare May 19, 2024 15:05

ai: store data in state dir instead of cache

6ba1db0

end-4 merged commit 44988b0 into end-4:main May 19, 2024

l4v3nx added a commit to l4v3nx/dots-hyprland that referenced this pull request May 22, 2024

Revert "Consistently use XDG base directiories (end-4#381)"

99252f0

This reverts commit 44988b0, reversing changes made to f181fd3.

end-4 added a commit to Soliprem/dots-hyprland that referenced this pull request May 24, 2024

Consistently use XDG base directiories (end-4#381)

37ad920

l4v3nx added a commit to l4v3nx/dots-hyprland that referenced this pull request May 25, 2024

Revert "Consistently use XDG base directiories (end-4#381)"

2846db3

This reverts commit 44988b0, reversing changes made to f181fd3.

l4v3nx added a commit to l4v3nx/dots-hyprland that referenced this pull request May 25, 2024

Revert "Consistently use XDG base directiories (end-4#381)"

8f3721e

This reverts commit 44988b0, reversing changes made to f181fd3.

l4v3nx added a commit to l4v3nx/dots-hyprland that referenced this pull request May 27, 2024

Reapply "Consistently use XDG base directiories (end-4#381)"

e37b0e7

it's not needed anymore This reverts commit 8f3721e.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consistently use XDG base directiories #381

Consistently use XDG base directiories #381

Cu3PO42 commented Apr 3, 2024

clsty commented Apr 3, 2024 •

edited

Cu3PO42 commented Apr 4, 2024

clsty commented Apr 4, 2024 •

edited

Cu3PO42 commented Apr 4, 2024

Cu3PO42 commented May 18, 2024

Cu3PO42 commented May 18, 2024

Cu3PO42 commented May 19, 2024

end-4 commented May 19, 2024 •

edited

Cu3PO42 commented May 19, 2024

end-4 left a comment •

edited

end-4 May 19, 2024

end-4 May 19, 2024

end-4 commented May 19, 2024

Cu3PO42 commented May 19, 2024

end-4 commented May 19, 2024

end-4 commented May 19, 2024 •

edited

Cu3PO42 commented May 19, 2024 •

edited

Consistently use XDG base directiories #381

Consistently use XDG base directiories #381

Conversation

Cu3PO42 commented Apr 3, 2024

clsty commented Apr 3, 2024 • edited

Cu3PO42 commented Apr 4, 2024

clsty commented Apr 4, 2024 • edited

Cu3PO42 commented Apr 4, 2024

Cu3PO42 commented May 18, 2024

Cu3PO42 commented May 18, 2024

Cu3PO42 commented May 19, 2024

end-4 commented May 19, 2024 • edited

Cu3PO42 commented May 19, 2024

end-4 left a comment • edited

Choose a reason for hiding this comment

end-4 May 19, 2024

Choose a reason for hiding this comment

end-4 May 19, 2024

Choose a reason for hiding this comment

end-4 commented May 19, 2024

Cu3PO42 commented May 19, 2024

end-4 commented May 19, 2024

end-4 commented May 19, 2024 • edited

Cu3PO42 commented May 19, 2024 • edited

clsty commented Apr 3, 2024 •

edited

clsty commented Apr 4, 2024 •

edited

end-4 commented May 19, 2024 •

edited

end-4 left a comment •

edited

end-4 commented May 19, 2024 •

edited

Cu3PO42 commented May 19, 2024 •

edited