Skip to content

Comments

docs: add documentation for resolve.tsconfig#5844

Closed
shulaoda wants to merge 1 commit into08-22-feat_support_resolve.tsconfigfrom
08-22-docs_add_documentation_for_resolve.tsconfig
Closed

docs: add documentation for resolve.tsconfig#5844
shulaoda wants to merge 1 commit into08-22-feat_support_resolve.tsconfigfrom
08-22-docs_add_documentation_for_resolve.tsconfig

Conversation

@shulaoda
Copy link
Member

No description provided.

Copy link
Member Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@shulaoda shulaoda changed the title docs: add documentation for resolve.tsconfig docs: add documentation for resolve.tsconfig Aug 22, 2025
@shulaoda shulaoda marked this pull request as ready for review August 22, 2025 06:47
- Powered by [oxc-resolver](https://github.com/oxc-project/oxc-resolver), aligned with webpack's [enhanced-resolve](https://github.com/webpack/enhanced-resolve)
- `node_modules` resolution is enabled by default (equivalent of `@rollup/plugin-node-resolve`)
- tsconfig paths supported via `resolve.tsconfigFilename`.
- tsconfig paths supported via `resolve.tsconfig.configFile`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a breaking change, right?

Comment on lines +143 to +145
* - Type: `string | object | undefined`
* - Default: `undefined`
*
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* - Type: `string | object | undefined`
* - Default: `undefined`
*

The type in the JSDoc seems not in sync with the actual TS definition (and we can skip it + the default as the types should make it clear already.

@shulaoda shulaoda marked this pull request as draft August 22, 2025 07:39
@shulaoda shulaoda force-pushed the 08-22-feat_support_resolve.tsconfig branch from 14ca63e to df58838 Compare August 22, 2025 16:43
@shulaoda shulaoda force-pushed the 08-22-docs_add_documentation_for_resolve.tsconfig branch from 2af8a41 to 1d5682a Compare August 22, 2025 16:43
@shulaoda shulaoda closed this Aug 22, 2025
@shulaoda shulaoda deleted the 08-22-docs_add_documentation_for_resolve.tsconfig branch August 22, 2025 17:46
@shulaoda
Copy link
Member Author

Refactored the relevant logic and added relevant documents in the previous PR.

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.

2 participants