Skip to content

docs(visualizer): fix package name in README - #2297

Open
jxhhdx wants to merge 1 commit into
farm-fe:mainfrom
jxhhdx:fix/visualizer-readme-package-name
Open

docs(visualizer): fix package name in README#2297
jxhhdx wants to merge 1 commit into
farm-fe:mainfrom
jxhhdx:fix/visualizer-readme-package-name

Conversation

@jxhhdx

@jxhhdx jxhhdx commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

The README incorrectly used @farmfe/visualizer as the package name, but the correct package name is @farmfe/js-plugin-visualizer.

Closes #2208

Description:

BREAKING CHANGE:

Related issue (if exists):

Summary by CodeRabbit

  • Documentation
    • Updated visualizer plugin documentation with the latest package naming information in installation instructions and configuration examples.

The README incorrectly used `@farmfe/visualizer` as the package name,
but the correct package name is `@farmfe/js-plugin-visualizer`.

Closes farm-fe#2208
@changeset-bot

changeset-bot Bot commented Apr 9, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 78fbb5e

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.

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

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "farm-docs" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "bench" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

@vercel

vercel Bot commented Apr 9, 2026

Copy link
Copy Markdown

@jxhhdx is attempting to deploy a commit to the Farm Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Apr 9, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fb49f5c1-5e4f-48d3-a044-fbd189bdfdec

📥 Commits

Reviewing files that changed from the base of the PR and between 198bb3b and 78fbb5e.

📒 Files selected for processing (1)
  • js-plugins/visualizer/README.md

📝 Walkthrough

Walkthrough

Documentation update correcting the incorrect package name @farmfe/visualizer to the correct @farmfe/js-plugin-visualizer in the visualizer plugin README's installation and import instructions.

Changes

Cohort / File(s) Summary
Visualizer Plugin Documentation
js-plugins/visualizer/README.md
Updated package name from @farmfe/visualizer to @farmfe/js-plugin-visualizer in npm/yarn/pnpm installation commands and import statements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A typo in the docs caused quite a fuss,
The package name wasn't quite right for us,
But now we've fixed it with care and delight,
@farmfe/js-plugin-visualizer shines bright! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(visualizer): fix package name in README' clearly and concisely describes the main change - correcting the package name in the visualizer plugin documentation.
Linked Issues check ✅ Passed The PR addresses issue #2208 by correcting the package name from @farmfe/visualizer to @farmfe/js-plugin-visualizer, enabling users to successfully install the visualizer plugin as documented.
Out of Scope Changes check ✅ Passed All changes are within scope - the PR only updates package name references in the README to fix the documented issue, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

[Bug Report]: js-plugins的插件文档的说明有问题

1 participant