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

types: improve getCurrentStyle type #363

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chouchouji
Copy link

@chouchouji chouchouji commented Jan 8, 2025

Summary by Sourcery

Enhancements:

  • Define the return type of getCurrentStyle as ComputedRef<Record<string, string>> for better type safety.

Issue

close #361

@chouchouji chouchouji requested a review from megasanjay as a code owner January 8, 2025 01:47
Copy link

sourcery-ai bot commented Jan 8, 2025

Reviewer's Guide by Sourcery

This PR improves the type definition of the getCurrentStyle computed property. It changes the type from any to a more specific type ComputedRef<Record<string, string>>, which provides better type safety and clarity.

Class diagram showing the type improvement for getCurrentStyle

classDiagram
    class Vue3Marquee {
        -getCurrentStyle: ComputedRef<Record<string, string>>
        +cssVariables: Record<string, string>
        +animationStyles: Record<string, string>
    }
    note for Vue3Marquee "Type changed from 'any' to
ComputedRef<Record<string, string>>"
Loading

File-Level Changes

Change Details Files
The type of the getCurrentStyle computed property was updated to ComputedRef<Record<string, string>>.
  • Import ComputedRef type from 'vue'.
  • Explicitly type getCurrentStyle as ComputedRef<Record<string, string>>.
packages/vue3-marquee/src/vue3-marquee.vue

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

vercel bot commented Jan 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vue3-marquee ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 1:49am

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @chouchouji - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

[Improvement] improve computed return type
1 participant