Massive rework of the templates

[neilenns]

Fixes #357

Summary by CodeRabbit

Summary by CodeRabbit

• Refactor

  • Simplified default image path handling across multiple controllers.
  • Consolidated template paths to use a single default template.
  • Removed specific image paths for different states (muted, unavailable, etc.).

• Bug Fixes

  • Ensured consistent fallback behavior for image paths when custom values are not set.

[coderabbitai]

Walkthrough

The pull request introduces a systematic refactoring of default image path handling across multiple controller files. The changes consolidate various state-specific template paths (muted, unavailable, blocked) into a single defaultTemplatePath across different controllers like AtisLetterController, HotlineController, StationStatusController, and StationVolumeController. This modification simplifies the image path logic by using a uniform template path when no custom image is specified, reducing redundancy in path definitions.

Changes

File	Changes
src/controllers/atisLetter.ts	Removed defaultUnavailableTemplatePath, modified unavailableImagePath getter to use defaultTemplatePath
src/controllers/hotline.ts	Removed defaultUnavailableTemplatePath, modified unavailableImagePath getter to use defaultTemplatePath
src/controllers/stationStatus.ts	Removed constants for defaultUnavailableTemplatePath, defaultBlockedCommsImagePath, and defaultMutedImagePath, updated getters to use defaultTemplatePath
src/controllers/stationVolume.ts	Removed defaultMutedTemplatePath, defaultNotMutedTemplatePath, and defaultUnavailableTemplatePath; added defaultTemplatePath with value "images/actions/stationVolume/template.svg"

Assessment against linked issues

Objective	Addressed	Explanation
Clean up templates (#[357])	✅
Reduce unnecessary items in path definitions (#[357])	✅

Poem

🐰 A Rabbit's Path Simplification Tale 🖼️
One template to rule them all, so neat
No more paths that seemed a bit discreet
From muted to blocked, from current to spare
A single SVG path with minimal care
Coding efficiency, hopping with glee! 🎉

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84ab342 and c6df9a2.

📒 Files selected for processing (1)

• src/controllers/hotline.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/controllers/hotline.ts

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Build for this pull request:
StreamDeck-TrackAudio.zip

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/controllers/hotline.ts (1)

10-10: Consider removing the redundant template path constant.

While the change aligns with the PR's objective by using the same template, consider removing defaultUnavailableTemplatePath entirely and directly using defaultTemplatePath in the unavailableImagePath getter, consistent with the approach taken in other controller files.

Apply this diff to align with other controllers:

-const defaultUnavailableTemplatePath = "images/actions/hotline/template.svg";

Then update the unavailableImagePath getter:

-    return this._unavailableImagePath ?? defaultUnavailableTemplatePath;
+    return this._unavailableImagePath ?? defaultTemplatePath;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b01e21c and 84ab342.

⛔ Files ignored due to path filters (15)

• com.neil-enns.trackaudio.sdPlugin/images/actions/atisLetter/template.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/hotline/template.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/hotline/unavailable.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/pushToTalk/black.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/pushToTalk/orange.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/pushToTalk/pushtotalk.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/pushToTalk/template.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationStatus/blocked.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationStatus/stationstatus.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationStatus/template.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationStatus/unavailable.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationVolume/muted.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationVolume/notMuted.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationVolume/template.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationVolume/unavailable.svg is excluded by !**/*.svg

📒 Files selected for processing (4)

• src/controllers/atisLetter.ts (2 hunks)
• src/controllers/hotline.ts (1 hunks)
• src/controllers/stationStatus.ts (3 hunks)
• src/controllers/stationVolume.ts (4 hunks)

🔇 Additional comments (5)

src/controllers/atisLetter.ts (2)

127-127: LGTM! Template path consolidation.

The consolidation of template paths by using defaultTemplatePath instead of a separate defaultUnavailableTemplatePath aligns with the PR's objective of simplifying template path handling.

---

249-249: LGTM! State parameter correction.

The state parameter has been correctly updated to "unavailable" to accurately represent the unavailable state in the template.

src/controllers/stationVolume.ts (2)

9-9: LGTM! Template path definition.

The addition of defaultTemplatePath with a consistent path pattern aligns with the PR's template consolidation objective.

---

49-49: LGTM! Consistent template path usage.

The getters for notMutedTemplatePath, mutedTemplatePath, and unavailableTemplatePath have been consistently updated to use the consolidated defaultTemplatePath.

Also applies to: 63-63, 77-77

src/controllers/stationStatus.ts (1)

75-75: LGTM! Consistent template path consolidation.

The getters for mutedImagePath, blockedCommsImagePath, and unavailableImagePath have been consistently updated to use the consolidated defaultTemplatePath, aligning with the PR's objective and the approach taken in other controllers.

Also applies to: 113-113, 143-143

[github-actions]

Build for this pull request:
StreamDeck-TrackAudio.zip