Skip to content

module: fix async resolution error within the sync findPackageJSON #56382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 8 commits into from
Dec 31, 2024
Merged

module: fix async resolution error within the sync findPackageJSON #56382

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a7b91e3
module: fix async resolution error within the sync `findPackageJSON`
JakobJingleheimer Dec 28, 2024
10fa02d
implement resolveSync with defaultResolve & polish test-cases
aduh95 Dec 28, 2024
1619459
revert basic implementation of resolveSync; use defaultResolve directly
JakobJingleheimer Dec 30, 2024
9cef635
de-lint
JakobJingleheimer Dec 30, 2024
e3972d2
add (temporary) limitation caveat to `findPackageJSON` doc entry
JakobJingleheimer Dec 30, 2024
9ea1146
english → american 😅
JakobJingleheimer Dec 30, 2024
fcb4470
fix typos
JakobJingleheimer Dec 30, 2024
208fa8f
other typos
JakobJingleheimer Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add (temporary) limitation caveat to findPackageJSON doc entry
  • Loading branch information
@JakobJingleheimer
JakobJingleheimer committed Dec 30, 2024
commit e3972d2d85888570739b1e009f56024132527201
8 changes: 6 additions & 2 deletions doc/api/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,18 @@ added: v23.2.0
* `base` {string|URL} The absolute location (`file:` URL string or FS path) of the
containing module. For CJS, use `__filename` (not `__dirname`!); for ESM, use
`import.meta.url`. You do not need to pass it if `specifier` is an `absolute specifier`.
* Returns: {string|undefined} A path if the `package.json` is found. When `startLocation`
* Returns: {string|undefined} A path if the `package.json` is found. When `specifier`
is a package, the package's root `package.json`; when a relative or unresolved, the closest
`package.json` to the `startLocation`.
`package.json` to the `specifier`.

> **Caveat**: Do not use this to try to determine module format. There are many things effecting
> that determination; the `type` field of package.json is the _least_ definitive (ex file extension
> superceeds it, and a loader hook superceeds that).

> **Caveat**: This currently leverages only the built-in default resolver; if
> [`resolve` customization hooks][resolve hook] are registered, they will not effect the resolution.
Comment thread
JakobJingleheimer marked this conversation as resolved.
Resolved
> This may change in future.
Comment thread
JakobJingleheimer marked this conversation as resolved.
Resolved

```text
/path/to/project
├ packages/
Expand Down