Skip to content

Conversation

@inseong01
Copy link

@inseong01 inseong01 commented Jul 3, 2025

Summary

Option "jest --init" has been deprecated.

Test plan

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to recommend using the create-jest command instead of jest --init.

Option "init" has been deprecated.
@inseong01 inseong01 requested a review from kulshekhar as a code owner July 3, 2025 01:08
@coderabbitai
Copy link

coderabbitai bot commented Jul 3, 2025

Walkthrough

The installation documentation was updated to recommend using the create-jest command instead of jest --init for initializing Jest configuration. Other instructions regarding TypeScript configuration remain unchanged.

Changes

File Path Change Summary
website/versioned_docs/version-29.3/getting-started/installation.md Updated Jest initialization command in documentation

Poem

In the docs a change appears,
A new command for eager ears—
"create-jest" now leads the way,
For setting Jest up, hooray!
Rabbits hop and cheer with glee,
Clearer steps for all to see!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
website/versioned_docs/version-29.3/getting-started/installation.md (1)

45-46: Add explicit command examples for better copy-&-paste UX

Since earlier sections provide concrete copy-pasteable commands (npx ts-jest config:init, yarn ts-jest config:init), consider mirroring that style here so readers don’t have to infer the exact syntax of the new recommendation.

-You can also use the `create-jest` command (prefixed with either `npx` or `yarn` depending on what you're using) to have more options related to Jest.
+You can also use the `create-jest` command to access the interactive Jest initializer:
+
+```npm tab
+npx create-jest
+```
+
+```Yarn tab
+yarn create jest
+```
+
+```pnpm tab
+pnpm create jest
+```
+
+This offers more configuration options for Jest during setup.

Keeps the documentation consistent and immediately actionable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4288e9c and 8928a81.

📒 Files selected for processing (1)
  • website/versioned_docs/version-29.3/getting-started/installation.md (1 hunks)

@ahnpnl
Copy link
Collaborator

ahnpnl commented Jul 3, 2025

Thanks, I included this in #4929 to release a new version for doc

@ahnpnl ahnpnl closed this Jul 3, 2025
@inseong01 inseong01 deleted the patch-1 branch July 4, 2025 03:47
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.

2 participants