Skip to content

docs: add Deno to install instructions - #5315

Merged
fb55 merged 2 commits into
cheeriojs:mainfrom
bartlomieju:add-deno-install
Jul 30, 2026
Merged

fb55 merged 2 commits into
cheeriojs:mainfrom
bartlomieju:add-deno-install

Conversation

@bartlomieju

Copy link
Copy Markdown
Contributor

👋 Bartek from the Deno team here. Thanks for cheerio, it's a go-to for HTML scraping on Deno too.

The README's Installation section shows npm and bun. Since Deno is a drop-in replacement for npm these days, this adds a Deno line in parity:

deno install cheerio

(As of Deno 2.8, no npm: prefix needed, same shape as npm install.)

Totally fine to close this if you'd rather keep the list short. Happy to tweak.

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.

Copilot AI review requested due to automatic review settings July 30, 2026 12:08
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@fb55
fb55 enabled auto-merge (squash) July 30, 2026 12:08
@coderabbitai

coderabbitai Bot commented Jul 30, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to include Deno alongside npm, Yarn, and Bun.

Walkthrough

The README installation section now lists Deno alongside npm, yarn, and bun, with an added deno install cheerio example.

Changes

Installation documentation

Layer / File(s) Summary
Add Deno installation instructions
Readme.md
Installation guidance now includes Deno and its package installation command.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding Deno to the install instructions.
Description check ✅ Passed The description matches the README update and explains the added Deno install command.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@fb55
fb55 merged commit d641a60 into cheeriojs:main Jul 30, 2026
10 of 11 checks passed
@fb55

fb55 commented Jul 30, 2026

Copy link
Copy Markdown
Member

Thanks! Ooc: I've also been slowly adding Cheerio's dependencies to JSR, is that still worthwhile? The removal of the prefix sounds like JSR is deprecated?

Copilot AI 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.

🟡 Not ready to approve

The added Deno command uses deno install, which is likely to confuse readers compared to the canonical deno add dependency workflow.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Pull request overview

Updates the README installation instructions to include Deno alongside existing package manager examples, aiming for parity in “how to install” guidance.

Changes:

  • Adds Deno to the list of supported installation approaches in the Installation section.
  • Adds a Deno CLI command example next to npm and bun examples.
File summaries
File Description
Readme.md Extends Installation instructions by adding Deno alongside existing package manager commands.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Low

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Comment thread Readme.md
# or
bun add cheerio
# or
deno install cheerio

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Readme.md`:
- Around line 40-47: Update the Cheerio installation instructions near the Deno
command to either document Deno 2.8+ as the minimum required version or change
the command to use the npm:cheerio prefix, while keeping the npm, yarn, and bun
examples unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1da4f033-3750-4d91-a3d9-c649be6c2aac

📥 Commits

Reviewing files that changed from the base of the PR and between 0f142c9 and 831c421.

📒 Files selected for processing (1)
  • Readme.md

Comment thread Readme.md
Comment on lines +40 to +47
Install Cheerio using a package manager like npm, yarn, bun, or Deno.

```bash
npm install cheerio
# or
bun add cheerio
# or
deno install cheerio

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

sed -n '35,55p' Readme.md

Repository: cheeriojs/cheerio

Length of output: 625


🌐 Web query:

Deno documentation deno install npm package prefix version 2.8 unprefixed npm resolution

💡 Result:

In Deno 2.8 and later, unprefixed package names used in CLI commands such as deno install, deno add, deno remove, and deno uninstall are treated as npm packages by default [1][2][3]. Key details regarding this change include: Command Line Convenience: You no longer need to include the npm: prefix when running these commands at the CLI [4][3]. For example, deno install express is functionally equivalent to deno install npm:express [1][5]. Scope and Precedence: This default applies to local installs, global installs (deno install -g) [6], and package management commands [2][3]. Explicit prefixes like npm: or jsr: continue to take precedence over the default behavior, allowing you to override the npm default when necessary [7][8]. Import Specifiers: The npm: prefix remains required within import specifiers in your source code [1][2][3]. JSR Packages: JSR packages still require the jsr: prefix at the CLI to remain unambiguous [1][3]. Compatibility: This change was designed to make Deno CLI commands more familiar to users of other Node.js package managers [7][3]. The --npm flag remains available but is functionally a no-op because npm is now the default registry for unprefixed names [7][8].

Citations:


Document the Deno 2.8+ requirement.
deno install cheerio only works as written on Deno 2.8+, where unprefixed npm package names are supported. Older Deno versions need deno install npm:cheerio, so the README should call out the minimum version or use the prefixed form.

🤖 Prompt for AI Agents
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 40 - 47, Update the Cheerio installation instructions
near the Deno command to either document Deno 2.8+ as the minimum required
version or change the command to use the npm:cheerio prefix, while keeping the
npm, yarn, and bun examples unchanged.

@bartlomieju

Copy link
Copy Markdown
Contributor Author

Thanks! Ooc: I've also been slowly adding Cheerio's dependencies to JSR, is that still worthwhile? The removal of the prefix sounds like JSR is deprecated?

@fb55 it's not deprecated, but people were complaining that npm being more popular requires 4 additional characters, that's why we removed the prefix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants