Skip to content

fix(useColorGenerator): removed unused parameter from required#2682

Open
Johudo wants to merge 1 commit into
mainfrom
fix/use-color-generator
Open

fix(useColorGenerator): removed unused parameter from required#2682
Johudo wants to merge 1 commit into
mainfrom
fix/use-color-generator

Conversation

@Johudo
Copy link
Copy Markdown
Contributor

@Johudo Johudo commented May 20, 2026

Summary by Sourcery

Align useColorGenerator hook props with context-based theming by introducing a dedicated props type and updating exports.

Enhancements:

  • Introduce a UseColorGeneratorProps type that reflects automatic theme resolution while keeping the theme field deprecated and optional.
  • Update useColorGenerator to consume the new props type and re-export it from the hook index for external use.

@Johudo Johudo requested review from ValeraS, amje and korvin89 as code owners May 20, 2026 12:16
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 20, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refactors the useColorGenerator hook to use a new props type that no longer requires the theme parameter, while keeping backward compatibility via an optional, deprecated theme field and re-exporting the new type from the hook index.

File-Level Changes

Change Details Files
Introduce a dedicated props type for the useColorGenerator hook and deprecate the unused theme parameter while keeping it optional for compatibility.
  • Add UseColorGeneratorProps type with required seed and optional, deprecated theme field
  • Switch useColorGenerator signature to accept UseColorGeneratorProps instead of GenerateColorProps
  • Ensure theme is still resolved internally via useThemeType, ignoring any passed theme in props
src/hooks/useColorGenerator/types.ts
src/hooks/useColorGenerator/useColorGenerator.ts
Update public exports to include the new props type for external consumers.
  • Export UseColorGeneratorProps from the useColorGenerator index barrel alongside existing types
src/hooks/useColorGenerator/index.ts

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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
Copy Markdown
Contributor

@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 - I've left some high level feedback:

  • In useColorGenerator.ts, the function now uses UseColorGeneratorProps but the file still only imports ColorDetails and GenerateColorProps from ./types, so you should add UseColorGeneratorProps to the type imports to avoid a type error.
  • Now that useColorGenerator no longer consumes theme, consider updating or adding a brief JSDoc on the hook itself to clarify that theme is resolved from context and that the theme prop (if passed) is ignored, matching the deprecation comment in the type.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In `useColorGenerator.ts`, the function now uses `UseColorGeneratorProps` but the file still only imports `ColorDetails` and `GenerateColorProps` from `./types`, so you should add `UseColorGeneratorProps` to the type imports to avoid a type error.
- Now that `useColorGenerator` no longer consumes `theme`, consider updating or adding a brief JSDoc on the hook itself to clarify that theme is resolved from context and that the `theme` prop (if passed) is ignored, matching the deprecation comment in the type.

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.

@gravity-ui
Copy link
Copy Markdown
Contributor

gravity-ui Bot commented May 20, 2026

Preview is ready.

@gravity-ui
Copy link
Copy Markdown
Contributor

gravity-ui Bot commented May 20, 2026

🎭 Component Tests Report is ready.

@Johudo Johudo force-pushed the fix/use-color-generator branch from a1e1d2c to bf32b9d Compare May 21, 2026 09:46
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