feat:prepare for other gui frameworks

[JarbasAl]

companion to OpenVoiceOS/ovos-bus-client#120

"all" is deprecated

Summary by CodeRabbit

• New Features

  • Enhanced identification of UI directories to support multiple GUI frameworks.
  • Improved logging for legacy UI directory detection.

• Bug Fixes

  • Fixed the path handling for locating UI directories.

[coderabbitai]

Walkthrough

The changes in the get_ui_directories function within ovos_utils/gui.py enhance the identification and retrieval of UI directories. The function now checks for a "ui" directory directly under the root_dir and maps it to the "qt5" framework if found. If not, it looks for a "gui" directory, iterating through its contents to log and add available frameworks to the ui_directories dictionary. This update improves support for multiple GUI frameworks based on the directory structure.

Changes

File	Change Summary
ovos_utils/gui.py	Modified get_ui_directories to check for "ui" and "gui" directories, enhancing dynamic framework support.

Possibly related PRs

• feat:standardize_lang_tag new utils #267: Introduces a new utility function in ovos_utils/lang/__init__.py, unrelated to the changes in get_ui_directories.

Poem

In the burrow where the code does flow,
A new path for UIs begins to grow.
With "ui" and "gui" now in the race,
Frameworks gather in their cozy space.
Hopping along, the changes are bright,
A rabbit's delight in the coding night! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 490fe97 and 5e2d377.

Files selected for processing (1)

• ovos_utils/gui.py (2 hunks)

Additional comments not posted (1)

ovos_utils/gui.py (1)

90-97: LGTM! The updated function enhances support for multiple GUI frameworks.

The changes made to the get_ui_directories function improve its ability to handle multiple GUI frameworks by:

1. Checking for a legacy "ui" directory and mapping it to the "qt5" framework, ensuring backward compatibility.
2. Dynamically adding frameworks and their corresponding paths based on the contents of the "gui" directory, allowing for greater flexibility and adaptability.

These updates align with the PR objective of preparing the codebase for compatibility with additional GUI frameworks while maintaining support for existing implementations.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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 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.

[codecov]

Codecov Report

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 43.75%. Comparing base (4548352) to head (5e2d377).
Report is 16 commits behind head on dev.

Files with missing lines	Patch %	Lines
ovos_utils/gui.py	12.50%	7 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##              dev     #270       +/-   ##
===========================================
- Coverage   53.80%   43.75%   -10.05%     
===========================================
  Files          60       31       -29     
  Lines        3942     3259      -683     
===========================================
- Hits         2121     1426      -695     
- Misses       1821     1833       +12     

Flag	Coverage Δ
	43.90% <12.50%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.