Skip to content

docs: add Deno to install instructions#7473

Merged
PavelVanecek merged 1 commit into
recharts:mainfrom
bartlomieju:add-deno-install
Jun 18, 2026
Merged

docs: add Deno to install instructions#7473
PavelVanecek merged 1 commit into
recharts:mainfrom
bartlomieju:add-deno-install

Conversation

@bartlomieju

@bartlomieju bartlomieju commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

👋 Bartek from the Deno team here.

The Installation section documents npm. Since Deno is a drop-in replacement for npm these days, this adds a short Deno subsection in parity:

deno add recharts react-is

Docs-only change (Recharts resolves and installs the same way under Deno). Totally fine to close this if you'd rather keep it npm-only. Happy to adjust.

Disclosure: I work on Deno, so I have an interest here. The goal is parity with the package managers you already list, not promotion. This PR was prepared with AI assistance under human supervision: I review every change myself and personally respond to any comments or review feedback.

Summary by CodeRabbit

  • Documentation
    • Updated installation guide with Deno support, enabling users to install Recharts via Deno package manager.

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The README installation section gains a new "Deno" subsection. It describes Deno as a drop-in replacement for npm and provides the command deno add recharts react-is to install the library.

Changes

Deno Installation Documentation

Layer / File(s) Summary
Deno installation subsection
README.md
Adds a "Deno" subsection under the installation section, describing Deno as an npm drop-in replacement and providing the deno add recharts react-is install command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description provides context and motivation but lacks several required template sections including Related Issue, How Has This Been Tested, Types of changes, and Checklist items. Add the missing required sections from the template: link to a related issue, describe testing approach, specify the type of change (documentation/new feature), and complete the checklist items.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add Deno to install instructions' directly and accurately summarizes the main change in the PR, which adds Deno installation documentation to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

53-59: 💤 Low value

Address markdown linting warning: dollar sign before command.

Line 58 triggers a markdown linter warning (MD014, commands-show-output) for using a dollar sign before a command without showing expected output. While the npm section at line 48 uses the same pattern, the coding guidelines state to ensure code lints (npm run lint).

Consider either removing the $ prefix or adding expected output to align with linting rules.

💡 Suggested alternatives

Option 1: Remove the dollar sign (simpler for documentation):

 Deno is a drop-in replacement for npm, so Recharts installs the same way:
 
 ```sh
-$ deno add recharts react-is
+deno add recharts react-is

**Option 2:** If you want to keep the `$` convention, consider updating line 48 consistently and adding expected output to both blocks.
</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @README.md around lines 53 - 59, The markdown linter is flagging the dollar
sign prefix in the Deno installation command block (MD014 violation) because it
shows a command prompt without displaying expected output. Remove the $ prefix
from the deno add recharts react-is command in the Deno section so the command
block starts directly with the deno command without the shell prompt indicator.
This will resolve the linting warning when you run npm run lint.


</details>

<!-- cr-comment:v1:5d02aa2353362626b0c9068e -->

_Source: Coding guidelines_

</blockquote></details>

</blockquote></details>

<details>
<summary>🤖 Prompt for all review comments with AI agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In @README.md:

  • Around line 53-59: The markdown linter is flagging the dollar sign prefix in
    the Deno installation command block (MD014 violation) because it shows a command
    prompt without displaying expected output. Remove the $ prefix from the deno add recharts react-is command in the Deno section so the command block starts
    directly with the deno command without the shell prompt indicator. This will
    resolve the linting warning when you run npm run lint.

</details>

---

<details>
<summary>ℹ️ Review info</summary>

<details>
<summary>⚙️ Run configuration</summary>

**Configuration used**: Organization UI

**Review profile**: CHILL

**Plan**: Pro

**Run ID**: `d0daa939-a6e2-4ef2-ae54-11f9a20a0c37`

</details>

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 1a61a02378fa6928d5bcd773ad218fd90c0592af and daa3afe6751cb1085114ccf1b44c69a405e80404.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `README.md`

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@PavelVanecek

Copy link
Copy Markdown
Collaborator

Hi @bartlomieju since you're here would you like to add an integration test for deno? Here is an example PR for vite8: recharts/recharts-integ@62c285b these tests run on every PR to recharts repository and ensure compatibility.

@codecov

codecov Bot commented Jun 18, 2026

Copy link
Copy Markdown

Bundle Report

Bundle size has no change ✅

@codecov

codecov Bot commented Jun 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.25%. Comparing base (1a61a02) to head (daa3afe).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7473   +/-   ##
=======================================
  Coverage   88.25%   88.25%           
=======================================
  Files         607      607           
  Lines       14102    14102           
  Branches     3545     3544    -1     
=======================================
  Hits        12446    12446           
  Misses       1469     1469           
  Partials      187      187           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@PavelVanecek
PavelVanecek merged commit 4f27699 into recharts:main Jun 18, 2026
58 checks passed
@bartlomieju

Copy link
Copy Markdown
Contributor Author

Thanks @PavelVanecek, I'll open a follow up PR

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