Create directory for themes #92

jhff · 2023-07-03T22:15:14Z

This change addresses issue #65 by:

Adding themes folder to config directory
Adding default theme that is created when it is not in the config directory yet
Changing config file to take a theme filename instead of palette. If theme is not found, default Palette is used.
Allowing users to add their own theme files in themes directory

lodenrogue

I'm trying to run the code for this change but it's not creating the theme files in the theme directory.

Theme directory is created successfully though.

I'm on macOS.

lodenrogue · 2023-07-04T01:53:20Z

I'm trying to run the code for this change but it's not creating the theme files in the theme directory.

Theme directory is created successfully though.

I'm on macOS.

So it seems the issue is if you already have a config and have used the app before it doesn't go into this option in the main->load_from_state() function.

 _ => (
    Screen::Welcome(screen::Welcome::new()),
    Config::default(),
    Command::none(),
)

Which means that Config::create_themes_dir() is never called inside the Welcome::new() method.

If we add Config::create_themes_dir() at the start of the load_from_state() function it adds the theme files in the themes directory but it doesn't update the app UI until the next time you open the app.

jhff · 2023-07-04T07:50:55Z

I'm trying to run the code for this change but it's not creating the theme files in the theme directory.
Theme directory is created successfully though.
I'm on macOS.

So it seems the issue is if you already have a config and have used the app before it doesn't go into this option in the main->load_from_state() function.
 _ => (
    Screen::Welcome(screen::Welcome::new()),
    Config::default(),
    Command::none(),
)
Which means that Config::create_themes_dir() is never called inside the Welcome::new() method.

If we add Config::create_themes_dir() at the start of the load_from_state() function it adds the theme files in the themes directory but it doesn't update the app UI until the next time you open the app.

You're right, if you already had a config file, themes files weren't being created.

Moved Config::create_themes_dir() to main() so it runs at startup. It should only do this the first time you open the app without themes. 0b3ccb4

Main issue is that a config file with palette instead of theme param, will go into default theme. Any user who already used the app might not notice that palette has been deprecated, but I don't think it makes sense to add code specifically for that use case in such an early phase.

casperstorm · 2023-07-04T14:44:22Z

Great PR @jhff.
Personally, I wouldn't want us to create all those themes though 🤔
I would rather keep it simple and just make Halloy able to read from /themes/*.yaml - and then if: theme: "foobar.yaml" We use /themes/foobar.yaml - if theme is None, or invalid, we use the default theme.
Then, in the config.template.yaml we can instead point to our Wiki to encourage people to download and add new themes.

I think my reason behind this is that, as a user i would rather build a collection of themes i want, rather than a bunch of themes i never want to use.

jhff · 2023-07-04T14:55:55Z

Great PR @jhff. Personally, I wouldn't want us to create all those themes though 🤔 I would rather keep it simple and just make Halloy able to read from /themes/*.yaml - and then if: theme: "foobar.yaml" We use /themes/foobar.yaml - if theme is None, or invalid, we use the default theme. Then, in the config.template.yaml we can instead point to our Wiki to encourage people to download and add new themes.

I think my reason behind this is that, as a user i would rather build a collection of themes i want, rather than a bunch of themes i never want to use.

np, I'll rework this PR to remove those themes and leave the default one! It was just an initial approach with a set of hardcoded themes 🙂

jhff · 2023-07-04T16:32:00Z

Removed all themes except the default one ce6da49

Users can add their own theme files. Also expect "name" field in theme files so that we can list them in the future in the app if needed with the proper name.

tarkah · 2023-07-04T18:09:40Z

assets/themes/halloy.yaml

@@ -0,0 +1,11 @@
+name: "Halloy"


Do we need name or can the filename just be the key?

Name of the theme as the value is more user friendly in my opinion

I think the way to go is:

filename -> config file theme key

name -> theme name to display in the app

Let's say we add the file solarized_dark.yaml for the Solarized (Dark) theme. solarized_dark is used as the key and Solarized (Dark) can be used to display in the future command bar of the app, e.g..

In this PR name is not used anywhere, it's just there so users are already educated to add that instead of having to change their files in the future.

Agreed that makes sense

Should wiki be updated with name in the example themes?

I think it should yeah, @jhff.

tarkah · 2023-07-04T18:15:58Z

src/main.rs

+    // Create themes directory
+    Config::create_themes_dir();
+


Nit: A module namespace works better here than struct namespace... config::create...

casperstorm · 2023-07-05T06:44:22Z

The two last thing I have is that I would like to rename halloy (default theme) to ferra since thats the name of it, and then could you please fill out CHANGELOG with a sentence about your change?

Otherwise I am good to merge.

* Add themes folder to config directory * Add multiple themes * Load theme from config file at startup

... and add name to theme files

casperstorm

Lets go!

lodenrogue reviewed Jul 4, 2023

View reviewed changes

tarkah reviewed Jul 4, 2023

View reviewed changes

jhff added 6 commits July 5, 2023 07:55

Create directory for themes

7063ffb

* Add themes folder to config directory * Add multiple themes * Load theme from config file at startup

Create themes files at startup

e617551

Remove all themes except default one...

3268ec4

... and add name to theme files

Move create_themes_dir() away from Config

6bb7ffe

Rename theme Halloy -> Ferra

aac713e

Update CHANGELOG.md

b3b26a4

jhff force-pushed the jhff/themes_dir branch from fe179a6 to b3b26a4 Compare July 5, 2023 07:00

casperstorm approved these changes Jul 5, 2023

View reviewed changes

casperstorm merged commit 3a8c812 into squidowl:main Jul 5, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create directory for themes #92

Create directory for themes #92

jhff commented Jul 3, 2023 •

edited

lodenrogue left a comment

lodenrogue commented Jul 4, 2023 •

edited

jhff commented Jul 4, 2023 •

edited

casperstorm commented Jul 4, 2023

jhff commented Jul 4, 2023 •

edited

jhff commented Jul 4, 2023

tarkah Jul 4, 2023

lodenrogue Jul 4, 2023

jhff Jul 4, 2023

jhff Jul 4, 2023

tarkah Jul 4, 2023

jhff Jul 4, 2023

casperstorm Jul 5, 2023

tarkah Jul 4, 2023

jhff Jul 4, 2023

casperstorm commented Jul 5, 2023 •

edited

casperstorm left a comment

Create directory for themes #92

Create directory for themes #92

Conversation

jhff commented Jul 3, 2023 • edited

lodenrogue left a comment

Choose a reason for hiding this comment

lodenrogue commented Jul 4, 2023 • edited

jhff commented Jul 4, 2023 • edited

casperstorm commented Jul 4, 2023

jhff commented Jul 4, 2023 • edited

jhff commented Jul 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

casperstorm commented Jul 5, 2023 • edited

casperstorm left a comment

Choose a reason for hiding this comment

jhff commented Jul 3, 2023 •

edited

lodenrogue commented Jul 4, 2023 •

edited

jhff commented Jul 4, 2023 •

edited

jhff commented Jul 4, 2023 •

edited

casperstorm commented Jul 5, 2023 •

edited