docs: document resolver option defaults

[oiahoon]

Summary

• document the resolver-specific defaults for project, alwaysTryTypes, bun, and noWarnOnMultipleProjects
• keep the existing unrs-resolver default collections and pass-through options unchanged

Closes #430.

Validation

• yarn build
• yarn lint
• yarn typecov (843/843, 100%)
• yarn prettier --check README.md
• yarn test: all 16 end-to-end cases pass; the unit file cannot resolve the Vitest source alias when the local checkout path contains a space, before test collection

Summary by CodeRabbit

• Documentation
  • Added a “Default options” table documenting resolver-specific default option values for project, alwaysTryTypes, bun, and noWarnOnMultipleProjects.

[changeset-bot]

⚠️ No Changeset found

Latest commit: e5b4065

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 14c4c7c6-cfbc-46ac-b225-f04bf48e2bbc

📥 Commits

Reviewing files that changed from the base of the PR and between 194a10e and e5b4065.

📒 Files selected for processing (1)

• README.md

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README now includes a resolver-specific defaults table for project, alwaysTryTypes, bun, and noWarnOnMultipleProjects.

Changes

Resolver option documentation

Layer / File(s)	Summary
Document resolver defaults README.md	Adds a table under “Default options” listing defaults for four resolver-specific options.

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 states the main change: documenting resolver option defaults.
Linked Issues check	✅ Passed	The README now documents the default values requested in [#430], including alwaysTryTypes=true and project behavior.
Out of Scope Changes check	✅ Passed	The changes are confined to README documentation and match the stated objective.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/eslint-import-resolver-typescript@483

commit: e5b4065

[coderabbitai]

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`:
- Line 346: Update the README entry for noWarnOnMultipleProjects to state that
the warning is shown only when an explicit project option resolves to multiple
project files, not when default discovery finds multiple tsconfig.json or
jsconfig.json files.

🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 34d70570-a1a7-4a1c-9e7e-a9743ee421cd

📥 Commits

Reviewing files that changed from the base of the PR and between 724c47d and 194a10e.

📒 Files selected for processing (1)

• README.md