import-js/eslint-import-resolver-typescript

Docs: some enhancement declaring default values for options.

Open

#430 opened on Apr 12, 2025

View on GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (73 forks)github user discovery
PR welcomedocumentgood first issue

Repository metrics

Stars
 (825 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It was not clear for any default value of options except these four: https://github.com/import-js/eslint-import-resolver-typescript?tab=readme-ov-file#options-from-unrs-resolver

It took me some time to reed through codes to find out that alwaysTryTypes is true by default.

It would be great if every default value of options are implicitly declared in README.

BTW, I can not make this PR myself as I am still confusing about the default behavior without project option after spending a few time with codes.

Contributor guide

Research direction
Read the source code to identify default values for each option and update the README.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80