Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: drop custom QML #58

Merged
merged 1 commit into from
Dec 26, 2024
Merged

refactor: drop custom QML #58

merged 1 commit into from
Dec 26, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Dec 26, 2024

move face template to ovos-gui, moving towards a non QT5 GUIs support

remove unused code

Summary by CodeRabbit

  • New Features

    • Updated GUI representation for sleep and wake states, enhancing user experience during transitions.
  • Bug Fixes

    • Streamlined wake-up animation process for improved performance.
  • Chores

    • Removed unused notification and speech handling functionalities to simplify operations.
    • Updated dependency version for ovos-bus-client to ensure compatibility with newer features.
  • Documentation

    • Updated method signatures to reflect changes in the NapTimeSkill class.
  • Style

    • Deleted outdated QML components related to facial expressions to improve code clarity.

move face template to ovos-gui, moving towards a non QT5 GUIs support
Copy link

coderabbitai bot commented Dec 26, 2024

Walkthrough

The pull request introduces modifications to the NapTimeSkill, focusing on simplifying GUI state management and updating dependency requirements. The changes involve updating the display methods for sleep and wake states in the __init__.py file, removing notification and speech-related methods, and deleting QML interface files (Face.qml, awake.qml, and resting.qml). Additionally, the requirements.txt file has been updated to raise the minimum version of the ovos-bus-client dependency.

Changes

File Change Summary
__init__.py - Updated display_sleep_face() to use self.gui.show_face() instead of show_page()
- Modified display_waking_face() to streamline wake-up animation
- Removed show_notification() and handle_speak() methods
gui/qt5/Face.qml - Deleted QML component for face rendering
gui/qt5/awake.qml - Removed Mycroft.CardDelegate with smiling face component
gui/qt5/resting.qml - Removed Mycroft.CardDelegate with resting face component
requirements.txt - Updated ovos-bus-client dependency from >=0.0.8,<2.0.0 to >=1.2.0,<2.0.0

Poem

🐰 A Rabbit's Naptime Tale 🌙

Sleepy skills, now lean and bright,
GUI dancing with pure delight
Methods trimmed, dependencies raised
A coding bunny, softly praised!

hop hop 🚀


📜 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 622f3e5 and d9328fc.

⛔ Files ignored due to path filters (5)
  • gui/qt5/face/Eyeball.svg is excluded by !**/*.svg
  • gui/qt5/face/GreySmile.svg is excluded by !**/*.svg
  • gui/qt5/face/Smile.svg is excluded by !**/*.svg
  • gui/qt5/face/lid.svg is excluded by !**/*.svg
  • gui/qt5/face/upper-lid.svg is excluded by !**/*.svg
📒 Files selected for processing (5)
  • __init__.py (1 hunks)
  • gui/qt5/Face.qml (0 hunks)
  • gui/qt5/awake.qml (0 hunks)
  • gui/qt5/resting.qml (0 hunks)
  • requirements.txt (1 hunks)
💤 Files with no reviewable changes (3)
  • gui/qt5/awake.qml
  • gui/qt5/resting.qml
  • gui/qt5/Face.qml
🔇 Additional comments (3)
__init__.py (2)

114-114: Looks good, but verify whether override_idle=True is desired across all platforms.

This update effectively replaces multiple QML views with a single call to show_face(). Ensure that this parameter correctly prevents any idle screens from overriding the sleeping face on all supported devices.


119-119: Great improvement for simplifying wake animations.

Replacing multiple calls with show_face(awake=True, override_idle=5) centralizes the wake-up logic, making it more maintainable. Confirm that the 5-second override is appropriate for all display types and user expectations.

requirements.txt (1)

3-3: Check compatibility and confirm no breaking changes with latest ovos-bus-client.

Raising the minimum version from 0.0.8 to 1.2.0 might include new features or deprecations. It’s advisable to test the skill thoroughly on devices using various versions of the bus client to prevent potential regressions.


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

@JarbasAl JarbasAl merged commit 5c55a0a into dev Dec 26, 2024
4 of 13 checks passed
@JarbasAl JarbasAl deleted the drop_qml branch December 26, 2024 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant