Custom formatting via config.toml #8

dotaxis · 2024-07-24T21:44:44Z

This allows customizing the output of spotifatius using the config.toml.

Includes {status} var which will print a play/pause unicode character depending on if the track is playing or paused.

Open to any suggestions on how to make it better, just let me know.

Also address #5

AndreasBackx

This looks great, thank you! I think I primarily want to move the replace logic to the OutputFormatter. It would be nice if we additionally didn't hardcode the unicode icons. I've left a possible solution for that as well that would be relatively simple, even if a bit boilerplate-y.

AndreasBackx · 2024-07-27T15:10:14Z

src/commands/monitor.rs

+                            let status_icon = match status {
+                                TrackStatus::Playing => " ",
+                                TrackStatus::Paused => " ",
+                                _ => "" // unable to get player state
+                            };
+                            output_format
+                                .replace("{artist}", &artist)
+                                .replace("{title}", &title)
+                                .replace("{separator}", separator)
+                                .replace("{status}", status_icon)


Could you move this to OutputFormatter? If the replacing is done on all Output.text, we could make the other messages below configurable as well.

Additionally, the tooltip can be configurable.

You'll need to add a template_fields: HashMap<String, String> or something similar where you pass what needs replacing. Otherwise the OutputFormatter won't know.

AndreasBackx · 2024-07-27T15:19:09Z

src/shared/config.rs

+    #[serde(default = "default_format")]
+    pub format: String,


What do you think about having some extra formatting options?

pub struct TemplateConfigs { #[serde(default = "default_text_template")] pub text: TemplateConfig, #[serde(default = "default_tooltip_template")] pub tooltip: TemplateConfig, } pub struct TemplateConfig { pub default: String, pub playing: String, pub stopped: String, pub paused: String, pub added: String, pub removed: String, }

This would allow configuration of icons and more so we do not hardcode those 2 unicode characters.

dotaxis · 2024-07-30T14:01:30Z

I'll take a look at this today and see what I can come up with.

dotaxis · 2024-07-30T18:37:07Z

I've done a bit more work on this. If you like the direction it's going I can add tooltip customization, but would rather wait to see if you want it refactored at all first.

I also started a review regarding the TrackStatus::Added/Removed triggers because I don't think they work.

AndreasBackx · 2024-07-31T09:13:38Z

Thank you! I'll try to give this a review this evening after work.

src/commands/output.rs

README.md

AndreasBackx · 2024-08-01T12:44:52Z

Forgot to leave a final comment with the review.

While I think the config can be improved, this is an improvement and I'm happy to extend it so it's better for you to use. I left some suggestions and with those applied, I think we can merge this.

Also please add an "Added" section to the Unreleased section of CHANGELOG.md. I'll put up a new version once it's merged and handle it appropriately. See https://keepachangelog.com/en/1.1.0/ for more info.

Co-authored-by: Andreas Backx <[email protected]>

Apply suggestions from code review Co-authored-by: Andreas Backx <[email protected]>

AndreasBackx · 2024-08-01T19:54:16Z

Also please add an "Added" section to the Unreleased section of CHANGELOG.md. I'll put up a new version once it's merged and handle it appropriately. See keepachangelog.com/en/1.1.0 for more info.

Should be good to merge after this.

dotaxis · 2024-08-01T20:00:31Z

Still waiting on some feedback on the Added/Removed logic not triggering

AndreasBackx · 2024-08-01T20:16:27Z

@dotaxis I'm unsure if you're referring to feedback from me. You mentioned the below earlier but I'm not sure what you mean with that review.

I also started a review regarding the TrackStatus::Added/Removed triggers because I don't think they work.

Let me know if you need any of my help.

src/commands/output.rs

dotaxis · 2024-08-01T21:23:56Z

@dotaxis I'm unsure if you're referring to feedback from me. You mentioned the below earlier but I'm not sure what you mean with that review.

I also started a review regarding the TrackStatus::Added/Removed triggers because I don't think they work.

Let me know if you need any of my help.

I forgot to submit my review so only I could see it. Oops.

dotaxis · 2024-08-03T18:58:49Z

Also please add an "Added" section to the Unreleased section of CHANGELOG.md. I'll put up a new version once it's merged and handle it appropriately. See keepachangelog.com/en/1.1.0 for more info.

Should be good to merge after this.

Sorry for the delay, been busy all week. Will get this done over the weekend.

AndreasBackx · 2024-08-03T20:02:13Z

No rush at all, take all the time you need. You're the primary user for it.

dotaxis · 2024-08-07T16:16:31Z

Okay, I added a line in the changelog. Let me know if you need anything else done.

AndreasBackx

Thanks, though make sure to test that they work. 😅 It does not compile right now.

CHANGELOG.md

AndreasBackx · 2024-08-12T20:43:43Z

src/commands/output.rs

@@ -25,6 +27,68 @@ pub struct OutputFormatter {
 }

 impl OutputFormatter {
+    pub fn format_output(&self, response: MonitorResponse, status: TrackStatus, output_format: &str) -> Output {
+        let text_template = &self.config.text_template;
+        if let Some(track) = response.track {


You're not closing this properly:

error: unexpected closing delimiter: `}` --> src/commands/output.rs:120:1 | 42 | (Some(artist), Some(title)) => { | - this delimiter might not be properly closed... ... 53 | }; | - ...as it matches this but it has different indentation ... 120 | } | ^ unexpected closing delimiter error: could not compile `spotifatius` (bin "spotifatius") due to 1 previous error

dotaxis · 2024-08-13T14:09:40Z

There was an extra closing brace in the change you requested on line 52.

AndreasBackx · 2024-08-13T19:05:09Z

Thanks again! It might take me some time to create a new version however. You should be able to use it yourself in the meantime however.

dotaxis added 3 commits July 24, 2024 15:28

Add format variable to config.toml

8f11f83

Add format explanation to readme

d7a38c3

Use serde defaults

e47695a

AndreasBackx requested changes Jul 27, 2024

View reviewed changes

Move replace logic to OutputFormatter

b5b82ae

dotaxis force-pushed the custom-formatting branch from ca49290 to b5b82ae Compare July 30, 2024 17:23

dotaxis added 2 commits July 30, 2024 12:34

Configure icons in config.toml

afadc0e

Add {album} to format options

89e11f3

AndreasBackx requested changes Aug 1, 2024

View reviewed changes

src/commands/output.rs Outdated Show resolved Hide resolved

src/commands/output.rs Outdated Show resolved Hide resolved

src/commands/output.rs Show resolved Hide resolved

README.md Show resolved Hide resolved

dotaxis and others added 2 commits August 1, 2024 09:08

Update README.md

acf50be

Co-authored-by: Andreas Backx <[email protected]>

Improve liked_icon logic readability

3e47a9f

Apply suggestions from code review Co-authored-by: Andreas Backx <[email protected]>

AndreasBackx assigned AndreasBackx and unassigned AndreasBackx Aug 1, 2024

dotaxis commented Aug 1, 2024

View reviewed changes

src/commands/output.rs Show resolved Hide resolved

src/commands/output.rs Show resolved Hide resolved

src/commands/output.rs Outdated Show resolved Hide resolved

dotaxis force-pushed the custom-formatting branch from 6339820 to 08a5342 Compare August 7, 2024 16:15

AndreasBackx requested changes Aug 12, 2024

View reviewed changes

Update CHANGELOG.md

47d32a4

dotaxis force-pushed the custom-formatting branch from bd6ed5f to 47d32a4 Compare August 13, 2024 14:02

Remove extra closing brace

e0d8467

AndreasBackx merged commit 945a0c4 into AndreasBackx:main Aug 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom formatting via config.toml #8

Custom formatting via config.toml #8

dotaxis commented Jul 24, 2024 •

edited

Loading

AndreasBackx left a comment

AndreasBackx Jul 27, 2024

AndreasBackx Jul 27, 2024

dotaxis commented Jul 30, 2024

dotaxis commented Jul 30, 2024 •

edited

Loading

AndreasBackx commented Jul 31, 2024

AndreasBackx commented Aug 1, 2024

AndreasBackx commented Aug 1, 2024

dotaxis commented Aug 1, 2024

AndreasBackx commented Aug 1, 2024 •

edited

Loading

dotaxis commented Aug 1, 2024

dotaxis commented Aug 3, 2024

AndreasBackx commented Aug 3, 2024 •

edited

Loading

dotaxis commented Aug 7, 2024

AndreasBackx left a comment

AndreasBackx Aug 12, 2024

dotaxis commented Aug 13, 2024 •

edited

Loading

AndreasBackx commented Aug 13, 2024

Custom formatting via config.toml #8

Custom formatting via config.toml #8

Conversation

dotaxis commented Jul 24, 2024 • edited Loading

AndreasBackx left a comment

Choose a reason for hiding this comment

AndreasBackx Jul 27, 2024

Choose a reason for hiding this comment

AndreasBackx Jul 27, 2024

Choose a reason for hiding this comment

dotaxis commented Jul 30, 2024

dotaxis commented Jul 30, 2024 • edited Loading

AndreasBackx commented Jul 31, 2024

AndreasBackx commented Aug 1, 2024

AndreasBackx commented Aug 1, 2024

dotaxis commented Aug 1, 2024

AndreasBackx commented Aug 1, 2024 • edited Loading

dotaxis commented Aug 1, 2024

dotaxis commented Aug 3, 2024

AndreasBackx commented Aug 3, 2024 • edited Loading

dotaxis commented Aug 7, 2024

AndreasBackx left a comment

Choose a reason for hiding this comment

AndreasBackx Aug 12, 2024

Choose a reason for hiding this comment

dotaxis commented Aug 13, 2024 • edited Loading

AndreasBackx commented Aug 13, 2024

dotaxis commented Jul 24, 2024 •

edited

Loading

dotaxis commented Jul 30, 2024 •

edited

Loading

AndreasBackx commented Aug 1, 2024 •

edited

Loading

AndreasBackx commented Aug 3, 2024 •

edited

Loading

dotaxis commented Aug 13, 2024 •

edited

Loading