Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 7376edc

Browse filesBrowse files
guybedfordBethGriggs
guybedford
authored and
BethGriggs
committed
module: deprecate trailing slash pattern mappings
PR-URL: #40039 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
1 parent 01b1946 commit 7376edc
Copy full SHA for 7376edc

File tree

Expand file treeCollapse file tree

9 files changed

+57
-1
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

9 files changed

+57
-1
lines changed
Open diff view settings
Collapse file

‎doc/api/deprecations.md‎

Copy file name to clipboardExpand all lines: doc/api/deprecations.md
+14Lines changed: 14 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -2812,6 +2812,20 @@ Type: Documentation-only (supports [`--pending-deprecation`][])
28122812
The `'hash'` and `'mgf1Hash'` options are replaced with `'hashAlgorithm'`
28132813
and `'mgf1HashAlgorithm'`.
28142814

2815+
### DEP0155: Trailing slashes in pattern specifier resolutions
2816+
<!-- YAML
2817+
changes:
2818+
- version: REPLACEME
2819+
pr-url: https://github.com/nodejs/node/pull/40039
2820+
description: Documentation-only deprecation
2821+
with `--pending-deprecation` support.
2822+
-->
2823+
2824+
Type: Documentation-only (supports [`--pending-deprecation`][])
2825+
2826+
The remapping of specifiers ending in `"/"` like `import 'pkg/x/'` is deprecated
2827+
for package `"exports"` and `"imports"` pattern resolutions.
2828+
28152829
[Legacy URL API]: url.md#url_legacy_url_api
28162830
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
28172831
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
Collapse file

‎doc/api/esm.md‎

Copy file name to clipboardExpand all lines: doc/api/esm.md
+2Lines changed: 2 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1190,6 +1190,8 @@ _isImports_, _conditions_)
11901190
> _expansionKey_ up to but excluding the first _"*"_ character.
11911191
> 1. If _patternBase_ is not **null** and _matchKey_ starts with but is not
11921192
> equal to _patternBase_, then
1193+
> 1. If _matchKey_ ends with _"/"_, throw an _Invalid Module Specifier_
1194+
> error.
11931195
> 1. Let _patternTrailer_ be the substring of _expansionKey_ from the
11941196
> index after the first _"*"_ character.
11951197
> 1. If _patternTrailer_ has zero length, or if _matchKey_ ends with
Collapse file

‎lib/internal/modules/esm/resolve.js‎

Copy file name to clipboardExpand all lines: lib/internal/modules/esm/resolve.js
+20Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ const { sep, relative, resolve } = require('path');
4040
const preserveSymlinks = getOptionValue('--preserve-symlinks');
4141
const preserveSymlinksMain = getOptionValue('--preserve-symlinks-main');
4242
const typeFlag = getOptionValue('--input-type');
43+
const pendingDeprecation = getOptionValue('--pending-deprecation');
4344
const { URL, pathToFileURL, fileURLToPath } = require('internal/url');
4445
const {
4546
ERR_INPUT_TYPE_NOT_ALLOWED,
@@ -106,6 +107,22 @@ function emitFolderMapDeprecation(match, pjsonUrl, isExports, base) {
106107
);
107108
}
108109

110+
function emitTrailingSlashPatternDeprecation(match, pjsonUrl, isExports, base) {
111+
if (!pendingDeprecation) return;
112+
const pjsonPath = fileURLToPath(pjsonUrl);
113+
if (emittedPackageWarnings.has(pjsonPath + '|' + match))
114+
return;
115+
emittedPackageWarnings.add(pjsonPath + '|' + match);
116+
process.emitWarning(
117+
`Use of deprecated trailing slash pattern mapping "${match}" in the ${
118+
isExports ? '"exports"' : '"imports"'} field module resolution of the ` +
119+
`package at ${pjsonPath}${base ? ` imported from ${fileURLToPath(base)}` :
120+
''}. Mapping specifiers ending in "/" is no longer supported.`,
121+
'DeprecationWarning',
122+
'DEP0155'
123+
);
124+
}
125+
109126
/**
110127
* @param {URL} url
111128
* @param {URL} packageJSONUrl
@@ -639,6 +656,9 @@ function packageExportsResolve(
639656
if (patternIndex !== -1 &&
640657
StringPrototypeStartsWith(packageSubpath,
641658
StringPrototypeSlice(key, 0, patternIndex))) {
659+
if (StringPrototypeEndsWith(packageSubpath, '/'))
660+
emitTrailingSlashPatternDeprecation(packageSubpath, packageJSONUrl,
661+
true, base);
642662
const patternTrailer = StringPrototypeSlice(key, patternIndex + 1);
643663
if (packageSubpath.length >= key.length &&
644664
StringPrototypeEndsWith(packageSubpath, patternTrailer) &&
Collapse file

‎test/es-module/test-esm-exports-deprecations.mjs‎

Copy file name to clipboardExpand all lines: test/es-module/test-esm-exports-deprecations.mjs
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
// Flags: --pending-deprecation
12
import { mustCall } from '../common/index.mjs';
23
import assert from 'assert';
34

45
let curWarning = 0;
56
const expectedWarnings = [
67
'"./sub/"',
78
'"./fallbackdir/"',
9+
'"./trailing-pattern-slash/"',
810
'"./subpath/"',
11+
'"./subpath/dir1/"',
12+
'"./subpath/dir2/"',
913
'no_exports',
1014
'default_index',
1115
];
Collapse file

‎test/es-module/test-esm-exports.mjs‎

Copy file name to clipboardExpand all lines: test/es-module/test-esm-exports.mjs
+6Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,19 @@ import fromInside from '../fixtures/node_modules/pkgexports/lib/hole.js';
4141
['pkgexports/dir2/dir2/trailer', { default: 'index' }],
4242
['pkgexports/a/dir1/dir1', { default: 'main' }],
4343
['pkgexports/a/b/dir1/dir1', { default: 'main' }],
44+
45+
// Deprecated:
46+
['pkgexports/trailing-pattern-slash/',
47+
{ default: 'trailing-pattern-slash' }],
4448
]);
4549

4650
if (isRequire) {
4751
validSpecifiers.set('pkgexports/subpath/file', { default: 'file' });
4852
validSpecifiers.set('pkgexports/subpath/dir1', { default: 'main' });
53+
// Deprecated:
4954
validSpecifiers.set('pkgexports/subpath/dir1/', { default: 'main' });
5055
validSpecifiers.set('pkgexports/subpath/dir2', { default: 'index' });
56+
// Deprecated:
5157
validSpecifiers.set('pkgexports/subpath/dir2/', { default: 'index' });
5258
} else {
5359
// No exports or main field
Collapse file

‎test/es-module/test-esm-local-deprecations.mjs‎

Copy file name to clipboardExpand all lines: test/es-module/test-esm-local-deprecations.mjs
+7Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// Flags: --pending-deprecation
2+
13
import '../common/index.mjs';
24
import assert from 'assert';
35
import fixtures from '../common/fixtures.js';
@@ -9,10 +11,14 @@ const selfDeprecatedFolders =
911
const deprecatedFoldersIgnore =
1012
fixtures.path('/es-modules/deprecated-folders-ignore/main.js');
1113

14+
const deprecatedTrailingSlashPattern =
15+
fixtures.path('/es-modules/pattern-trailing-slash.mjs');
16+
1217
const expectedWarnings = [
1318
'"./" in the "exports" field',
1419
'"#self/" in the "imports" field',
1520
'"./folder/" in the "exports" field',
21+
'"./trailing-pattern-slash/" in the "exports" field',
1622
];
1723

1824
process.addListener('warning', (warning) => {
@@ -28,5 +34,6 @@ process.on('exit', () => {
2834
(async () => {
2935
await import(pathToFileURL(selfDeprecatedFolders));
3036
await import(pathToFileURL(deprecatedFoldersIgnore));
37+
await import(pathToFileURL(deprecatedTrailingSlashPattern));
3138
})()
3239
.catch((err) => console.error(err));
Collapse file

‎test/fixtures/es-modules/pattern-trailing-slash.mjs‎

Copy file name to clipboard
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
import 'pkgexports/trailing-pattern-slash/';
Collapse file

‎test/fixtures/node_modules/pkgexports/package.json‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/pkgexports/package.json
+2-1Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Collapse file

‎test/fixtures/node_modules/pkgexports/trailing-pattern-slash/index.js‎

Copy file name to clipboardExpand all lines: test/fixtures/node_modules/pkgexports/trailing-pattern-slash/index.js
+1Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.