chore: add commands to run tests and storybook in StrictMode

[chirokas]

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 options for enabling React's Strict Mode in development and testing environments.
• Chores
  • Added new scripts for strict development testing.
  • Updated and reorganized package dependencies for improved management.
• Configuration
  • Enhanced Storybook configuration with strict mode options and improved structure.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 86e5e39

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

[vercel]

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]

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

A member of the Team first needs to authorize it.

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

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]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 78d4216 and 3441b65.

Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

Files selected for processing (3)

• package.json (7 hunks)
• packages/storybook/.storybook/main.js (1 hunks)
• scripts/setup-test.ts (2 hunks)

Additional comments not posted (6)

packages/storybook/.storybook/main.js (2)

23-23: Stylistic Improvement: Trailing Comma Added

Adding a trailing comma after disableTelemetry is a good practice for cleaner diffs in version control systems.

---

18-20: Implementation of Strict Mode in Storybook looks correct.

The use of process.env.STRICT_MODE === "true" ensures that strict mode is only enabled when explicitly specified. This is a good practice to avoid unintentional activation.

Verification successful

---

Implementation of Strict Mode in Storybook looks correct.

The use of process.env.STRICT_MODE === "true" ensures that strict mode is only enabled when explicitly specified. This is a good practice to avoid unintentional activation. The environment variable STRICT_MODE was correctly set to 'true' during the simulated run.

• The environment variable STRICT_MODE is properly set and utilized.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that STRICT_MODE environment variable is properly set when running Storybook.

# Test: Check the environment variable during Storybook run.
echo "Ensure that the STRICT_MODE environment variable is set to 'true' or 'false' as expected when running Storybook."

Length of output: 246

---

---

Script:

#!/bin/bash
# Description: Verify that STRICT_MODE environment variable is properly set and utilized during Storybook run.

# Test: Check the environment variable during Storybook run.
# We will simulate running Storybook and print the value of STRICT_MODE.
# Note: This is a simulation and not the actual run of Storybook.

# Set the environment variable for testing
export STRICT_MODE="true"

# Simulate running Storybook and check the environment variable
node -e 'console.log("STRICT_MODE:", process.env.STRICT_MODE);'

Length of output: 183

---

---

Script:

#!/bin/bash
# Description: Verify that STRICT_MODE environment variable is properly set and utilized during Storybook run.

# Test: Check the environment variable during Storybook run.
# We will simulate running Storybook and print the value of STRICT_MODE.
# Note: This is a simulation and not the actual run of Storybook.

# Set the environment variable for testing
export STRICT_MODE="true"

# Simulate running Storybook and check the environment variable
echo "STRICT_MODE: $STRICT_MODE"

Length of output: 89

scripts/setup-test.ts (2)

2-2: Correct Import for Test Configuration

The import of configure from @testing-library/react is necessary for setting up the test environment. Ensure that it is used effectively in the rest of the file.

Verification successful

---

Correct Import and Usage of configure

The import of configure from @testing-library/react is correctly implemented and used in scripts/setup-test.ts.

• Line 2: import { configure } from "@testing-library/react";
• Usage: configure({ ... });

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify the usage of `configure` in test setups.

# Test: Search for `configure` usage in the file.
rg --type ts "configure" ./scripts/setup-test.ts

Length of output: 112

---

34-36: Proper Configuration of Strict Mode in Tests

Setting reactStrictMode based on the STRICT_MODE environment variable is a robust way to conditionally enable strict mode for tests.

Verification successful

---

Proper Configuration of Strict Mode in Tests

Setting reactStrictMode based on the STRICT_MODE environment variable is a robust way to conditionally enable strict mode for tests. The STRICT_MODE environment variable is properly set in the package.json file for the relevant scripts.

• package.json:
  • "dev:strict": "cross-env STRICT_MODE=true pnpm dev"
  • "test:strict": "cross-env STRICT_MODE=true pnpm test"
• scripts/setup-test.ts:
  • reactStrictMode: process.env.STRICT_MODE === "true"

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that STRICT_MODE environment variable is properly set when running tests.

# Test: Check the environment variable during test runs.
echo "Ensure that the STRICT_MODE environment variable is set to 'true' or 'false' as expected when running tests."

Length of output: 238

---

---

Script:

#!/bin/bash
# Description: Verify that the STRICT_MODE environment variable is properly set when running tests.

# Test: Check the value of the STRICT_MODE environment variable.
# We will print the value of STRICT_MODE to ensure it is being set correctly.

echo "STRICT_MODE is set to: $STRICT_MODE"

# Additionally, we can list all environment variables to see if STRICT_MODE is present
printenv | grep STRICT_MODE

Length of output: 163

---

---

Script:

#!/bin/bash
# Description: Search for any occurrences of the STRICT_MODE environment variable in the codebase.

# Search for STRICT_MODE in the codebase to verify its usage and setting.
rg --fixed-strings "STRICT_MODE"

Length of output: 251

package.json (2)

16-16: New Scripts for Strict Mode Execution

The addition of dev:strict and test:strict scripts using cross-env to set the STRICT_MODE environment variable is a practical approach to enable strict mode. Ensure to test these scripts to verify they function as intended.

Also applies to: 29-29

---

Line range hint 73-93: Dependency Updates Reviewed

Updates to dependencies like @storybook/react, concurrently, and cross-env are important for maintaining project health. Verify that these updates do not introduce compatibility issues with existing code.

Also applies to: 118-118, 123-136

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

packages/storybook/.storybook/addons/react-strict-mode/register.tsx (1)

8-21: Consider adding error handling for API interactions.

While the current implementation is straightforward, consider adding error handling for interactions with the Storybook API, such as when emitting events or setting query parameters, to ensure robustness.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3441b65 and 5bae67e.

Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

Files selected for processing (7)

• package.json (6 hunks)
• packages/storybook/.storybook/addons/react-strict-mode/index.tsx (1 hunks)
• packages/storybook/.storybook/addons/react-strict-mode/register.tsx (1 hunks)
• packages/storybook/.storybook/main.js (1 hunks)
• packages/storybook/.storybook/preview.tsx (2 hunks)
• packages/storybook/package.json (1 hunks)
• scripts/setup-test.ts (2 hunks)

Additional comments not posted (11)

packages/storybook/.storybook/main.js (2)

14-15: Add React Strict Mode addon.

The addition of the React Strict Mode addon is a good practice to catch potential issues early in development.

---

21-21: Consistent formatting with trailing commas.

The addition of trailing commas in objects is a good practice for cleaner diffs in version control.

packages/storybook/.storybook/addons/react-strict-mode/index.tsx (2)

7-21: Implement StrictModeDecorator for Storybook.

The StrictModeDecorator effectively toggles React Strict Mode based on query parameters, enhancing flexibility in testing.

---

23-29: Use of makeDecorator for Strict Mode.

The use of makeDecorator to integrate the strict mode switcher is a clean and modular approach.

scripts/setup-test.ts (1)

34-36: Configure React Strict Mode for testing.

The configuration for React Strict Mode based on the STRICT_MODE environment variable enhances test robustness and flexibility.

packages/storybook/.storybook/addons/react-strict-mode/register.tsx (2)

23-43: Enhance accessibility by associating the label with the input.

The label is correctly associated with the checkbox input via htmlFor and id. Ensure that this pattern is maintained throughout the codebase for accessibility compliance.

---

46-55: Ensure conditional registration is appropriate.

The addon is registered only in non-production environments. Verify that this aligns with your deployment strategy and that strict mode is not needed in production.

Verification successful

---

Conditional Registration is Appropriate

The addon registration is conditioned for non-production environments, which aligns with the overall codebase strategy of differentiating behavior based on the environment. The use of __PROD__ throughout the codebase supports this approach, ensuring that certain features are only active during development. This is consistent with best practices for managing environment-specific features.

• The addon is correctly registered only in non-production environments, which is suitable if it is used for development purposes.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the addon registration is correctly conditioned for non-production environments.

# Test: Check for any production environment conditional logic in the codebase.
rg --type tsx --type ts --type js --type jsx 'process.env.NODE_ENV === "production"'

Length of output: 114

---

Script:

#!/bin/bash
# Description: Verify that the addon registration is correctly conditioned for non-production environments.

# Test: Check for any production environment conditional logic in the codebase.
rg --type js --type jsx --type ts --type tsx 'process.env.NODE_ENV === "production"'

Length of output: 114

---

Script:

#!/bin/bash
# Description: Verify that the addon registration is correctly conditioned for non-production environments.

# Test: Check for any production environment conditional logic in the codebase.
rg --type js --type ts 'process.env.NODE_ENV === "production"'

Length of output: 150

---

Script:

#!/bin/bash
# Description: Find where the __PROD__ constant is used in the codebase.

# Test: Search for occurrences of __PROD__ to understand its usage.
rg '__PROD__'

Length of output: 789

packages/storybook/package.json (1)

47-48: Verify compatibility of new dependencies.

The new dependencies @storybook/manager-api and @storybook/preview-api have been added. Ensure they are compatible with the existing Storybook setup and other dependencies.

packages/storybook/.storybook/preview.tsx (1)

Line range hint 7-23:
Ensure withStrictModeSwitcher is correctly implemented.

The withStrictModeSwitcher is conditionally added to the decorators. Verify that its implementation aligns with the intended functionality and does not introduce side effects.

package.json (2)

28-28: Add test:strict script for stricter testing.

The addition of the "test:strict" script is a good practice for enforcing strict mode during testing, which helps catch potential issues early.

---

Line range hint 72-135:
Reorganize dependencies for clarity.

The reorganization of @storybook/react, tsx, intl-messageformat, and npm-check-updates within devDependencies can help clarify their usage. Ensure that these changes align with the project's needs and verify their impact on the build and runtime environments.