Skip to content

docs: prefer ConsolaInstance import from consola main entry - #440

Open
vittorioexp wants to merge 1 commit into
unjs:mainfrom
vittorioexp:docs/prefer-main-types-import
Open

docs: prefer ConsolaInstance import from consola main entry#440
vittorioexp wants to merge 1 commit into
unjs:mainfrom
vittorioexp:docs/prefer-main-types-import

Conversation

@vittorioexp

@vittorioexp vittorioexp commented Jul 23, 2026

Copy link
Copy Markdown

Summary

Related to #382

Test plan

  • README guidance is clear next to the core/basic/browser import examples

Summary by CodeRabbit

  • Documentation
    • Clarified which package path to use when importing types from the main consola entry.
    • Noted that the lightweight /core entry has separate, potentially incompatible types.

Related to unjs#382

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 93329021-cf22-4f3e-a62f-b65e6868a893

📥 Commits

Reviewing files that changed from the base of the PR and between c47faac and 87d53f1.

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

📝 Walkthrough

Walkthrough

README.md adds guidance to import types from "consola" instead of "consola/core" when using the main package entry point.

Changes

Type import guidance

Layer / File(s) Summary
Document compatible type imports
README.md
Adds an explanation and TypeScript example recommending type imports from "consola" for compatibility with the main package types.

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

🚥 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 clearly summarizes the doc update about importing types from the main consola entry instead of consola/core.
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

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.

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.

1 participant