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

Refractored ParseValue and Simplified cycleColorSpace Logic #29840

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

Conversation

leyvae
Copy link

@leyvae leyvae commented Dec 6, 2024

Closes #

What I did

  • Refactored the parseValue function into smaller, more maintainable helper functions.
  • Improved the cycleColorSpace function for better readability.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • [x ] stories
  • [x ] unit tests
  • [x ] integration tests
  • [x ] end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run yarn storybook (or the relevant task for your environment).
  2. Open Storybook in your browser.
  3. Navigate to the color control stories.
  4. Verify that:
    - The color picker still works as expected.
    - Changing color formats (RGB/HSL/HEX) cycles correctly.
    - Editing the color input updates the component properly.
    - Using presets and adding new presets is still functional.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Refactored color parsing logic in Color.tsx by breaking down the monolithic parseValue function and simplifying cycleColorSpace calculation for improved maintainability.

  • Split parseValue into three specialized helper functions: parseRgb, parseHsl, and parseHexOrKeyword in code/lib/blocks/src/controls/Color.tsx
  • Simplified cycleColorSpace function using modulo operator for cleaner index calculation
  • Added comprehensive test coverage through stories and unit tests
  • Maintained backward compatibility with existing color picker functionality

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines +148 to +149
const [r, g, b, a] = stringToArgs(value);
const [h, s, l] = convert.rgb.hsl([r, g, b]) || [0, 0, 0];
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: potential undefined access when convert.rgb.hsl returns null - should handle this case explicitly

Comment on lines +165 to +166
const [h, s, l, a] = stringToArgs(value);
const [r, g, b] = convert.hsl.rgb([h, s, l]) || [0, 0, 0];
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: potential undefined access when convert.hsl.rgb returns null - should handle this case explicitly

Comment on lines 182 to 183
const rgb = convert.keyword.rgb(plain as any) || convert.hex.rgb(plain);
const hsl = convert.rgb.hsl(rgb);
Copy link
Contributor

Choose a reason for hiding this comment

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

style: casting to 'any' here bypasses type safety - consider using proper type checking

Comment on lines +305 to +307
const updatedValue = color?.[nextSpace] || '';
setValue(updatedValue);
onChange(updatedValue);
Copy link
Contributor

Choose a reason for hiding this comment

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

style: setValue and onChange could be batched together to avoid multiple rerenders

Copy link

nx-cloud bot commented Dec 9, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 05994ca. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: controls ci:normal maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants