nextui icon indicating copy to clipboard operation
nextui copied to clipboard

chore: add commands to run tests and storybook in StrictMode

Open chirokas opened this issue 1 year ago • 4 comments

Closes #

📝 Description

Developing in strict mode is the best practice for React because it helps teams catch bugs earlier.

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Introduced strict mode options for development and testing environments.
  • Chores
    • Added new scripts for strict development and testing.
    • Updated and reorganized package dependencies.
  • Configuration
    • Enhanced Storybook configuration with strict mode options and improved formatting.

chirokas avatar Jun 28 '24 13:06 chirokas

⚠️ No Changeset found

Latest commit: 86e5e39c993e7ac43c527aa2acba8b12e111ce82

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Jun 28 '24 13:06 changeset-bot[bot]

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 8, 2024 7:23am

vercel[bot] avatar Jun 28 '24 13:06 vercel[bot]

@chirokas is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Jun 28 '24 13:06 vercel[bot]

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The updates introduce stricter mode options for both development and testing environments through new scripts in package.json and configuration changes in Storybook and testing setup. Key dependencies were added and updated to support these changes. The goal is to ensure more rigorous code quality checks during development and testing phases.

Changes

File Change Summary
package.json Added "test:strict" script, moved and reevaluated dependencies, updated various package versions.
packages/storybook/.storybook/main.js Integrated React Strict Mode with an options object and added a trailing comma in the core section.
packages/storybook/.storybook/addons/react-strict-mode/index.tsx Introduced StrictModeDecorator for conditional wrapping of stories in React's Strict Mode.
packages/storybook/.storybook/addons/react-strict-mode/register.tsx Implemented StrictModeSwitcher component to toggle Strict Mode based on a query parameter.
packages/storybook/.storybook/preview.tsx Imported withStrictModeSwitcher to conditionally apply the decorator in the preview configuration.
scripts/setup-test.ts Added configuration for reactStrictMode based on the STRICT_MODE environment variable.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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.

coderabbitai[bot] avatar Jun 28 '24 13:06 coderabbitai[bot]