Skip to content

modules: runtime deprecate subpath folder mappings #35747

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

Closed
guybedford wants to merge 8 commits into from
Closed

modules: runtime deprecate subpath folder mappings #35747

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f258111
modules: runtime deprecate subpath folder mappings
guybedford Oct 22, 2020
dda5369
update docs
guybedford Oct 22, 2020
8a517bd
update folder mappings link
guybedford Oct 22, 2020
0460eb4
Apply suggestions from code review
guybedford Oct 22, 2020
4caaf60
line length adjustments
guybedford Oct 22, 2020
6bf53be
more line length adjustments
guybedford Oct 22, 2020
e33c7ac
update imports
guybedford Oct 22, 2020
850772a
fixup docs link
guybedford Oct 22, 2020
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
update docs
  • Loading branch information
@guybedford
guybedford committed Oct 22, 2020
commit dda53692c0d6cf520bf80d69e0f649af3d56018e
23 changes: 3 additions & 20 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2690,26 +2690,9 @@ changes:

Type: Runtime (supports [`--pending-deprecation`][])

Prior to [subpath patterns][] support, it was possible to define folder mappings
in the [subpath exports][] or [subpath imports][] fields using a trailing `"/"`:

```json
{
"exports": {
"./features/": "./features/"
}
}
```

This usage is deprecated for using direct [subpath patterns][]:

```json
{
"exports": {
"./features/*": "./features/*.js"
}
}
```
Prior to [subpath patterns][] support, it was possible to define
[folder mappings][] in the [subpath exports][] or [subpath imports][] fields
Comment thread
guybedford marked this conversation as resolved.
Outdated
using a trailing `"/"`.

Without `--pending-deprecation`, runtime warnings occur only for exports
resolutions not in `node_modules`. This means there will not be deprecation
Expand Down
39 changes: 39 additions & 0 deletions doc/api/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,45 @@ treating the right hand side target pattern as a `**` glob against the list of
files within the package. Because `node_modules` paths are forbidden in exports
targets, this expansion is dependent on only the files of the package itself.

### Subpath folder mappings
<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/35746
description: Runtime deprecation.
- version: v14.13.0
pr-url: https://github.com/nodejs/node/pull/34718
description: Documentation-only deprecation.
-->

> Stability: 0 - Deprecated: Use subpath patterns instead.

Before subpath patterns were supported, a trailing `"/"` suffix was used to
support folder mappings:

```json
{
"exports": {
"./features/": "./features/"
}
}
```

_This feature will be removed in a future release._
Comment thread
guybedford marked this conversation as resolved.

Instead, use direct [subpath patterns][]:
Comment thread
guybedford marked this conversation as resolved.

```json
{
"exports": {
"./features/*": "./features/*.js"
}
}
```

The benefit of patterns over folder exports is that packages can always be
imported by consumers without subpath file extensions being necessary.

### Exports sugar

> Stability: 1 - Experimental
Expand Down