Skip to content

docs: fix Deno setup without package.json - #4896

Merged
escapedcat merged 2 commits into
conventional-changelog:masterfrom
awnoa:docs/deno-node-modules
Jul 18, 2026
Merged

escapedcat merged 2 commits into
conventional-changelog:masterfrom
awnoa:docs/deno-node-modules

Conversation

@awnoa

@awnoa awnoa commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Description

Add a local node_modules installation step to the Deno setup instructions.

Motivation and Context

Deno projects without a package.json resolve npm packages from the global cache by default. commitlint loads shareable configs through Node.js module resolution, so the documented command fails in that setup. Installing with --node-modules-dir=auto gives commitlint the local module tree it expects.

Fixes #4593.

Usage examples

deno add -D npm:@commitlint/cli npm:@commitlint/config-conventional
deno install --node-modules-dir=auto

How Has This Been Tested?

  • Checked the command syntax and option availability with Deno 2.6.3
  • Previewed the updated Markdown on GitHub

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have verified that any documentation examples I added/changed actually work.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • For a feature/bug fix, my commits follow the test-driven flow.

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@greptile-apps

greptile-apps Bot commented Jul 17, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

Filename Overview
docs/guides/getting-started.md Clarifies that the local Node.js module resolution setup command applies to Deno 2.

Reviews (2): Last reviewed commit: "docs: clarify Deno 2 requirement" | Re-trigger Greptile

Comment thread docs/guides/getting-started.md
@escapedcat

Copy link
Copy Markdown
Member

Thanks!

@escapedcat
escapedcat merged commit 5afb449 into conventional-changelog:master Jul 18, 2026
12 checks passed
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.

fix: Deno Instructions Not Working

3 participants