archive/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-08-15 13:48:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

deps: update cjs-module-lexer to 2.0.0

Browse source 
Signed-off-by: Michael Dawson <mdawson@devrus.com>
PR-URL: https://github.com/nodejs/node/pull/56855
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
This commit is contained in:
Michael Dawson 2025-02-04 08:12:33 -05:00 • committed by GitHub
parent eb11adfc02
commit dd92abc405
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 6430 additions and 734 deletions
Download patch file Download diff file Expand all files Collapse all files

20
deps/cjs-module-lexer/LICENSE vendored
View file

@ -1,10 +1,10 @@
MIT License MIT License
----------- -----------
Copyright (C) 2018-2020 Guy Bedford Copyright (C) 2018-2020 Guy Bedford
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

926
deps/cjs-module-lexer/README.md vendored
View file

@ -1,462 +1,464 @@
# CJS Module Lexer # CJS Module Lexer
[![Build Status][travis-image]][travis-url] [![Build Status][travis-image]][travis-url]
A [very fast](#benchmarks) JS CommonJS module syntax lexer used to detect the most likely list of named exports of a CommonJS module. A [very fast](#benchmarks) JS CommonJS module syntax lexer used to detect the most likely list of named exports of a CommonJS module.
Outputs the list of named exports (`exports.name = ...`) and possible module reexports (`module.exports = require('...')`), including the common transpiler variations of these cases. Outputs the list of named exports (`exports.name = ...`) and possible module reexports (`module.exports = require('...')`), including the common transpiler variations of these cases.
Forked from https://github.com/guybedford/es-module-lexer. Forked from https://github.com/guybedford/es-module-lexer.
_Comprehensively handles the JS language grammar while remaining small and fast. - ~90ms per MB of JS cold and ~15ms per MB of JS warm, [see benchmarks](#benchmarks) for more info._ _Comprehensively handles the JS language grammar while remaining small and fast. - ~90ms per MB of JS cold and ~15ms per MB of JS warm, [see benchmarks](#benchmarks) for more info._
### Project Status ### Project Status
This project is used in Node.js core for detecting the named exports available when importing a CJS module into ESM, and is maintained for this purpose. This project is used in Node.js core for detecting the named exports available when importing a CJS module into ESM, and is maintained for this purpose.
PRs will be accepted and upstreamed for parser bugs, performance improvements or new syntax support only. PRs will be accepted and upstreamed for parser bugs, performance improvements or new syntax support only.
_Detection patterns for this project are **frozen**_. This is because adding any new export detection patterns would result in fragmented backwards-compatibility. Specifically, it would be very difficult to figure out why an ES module named export for CommonJS might work in newer Node.js versions but not older versions. This problem would only be discovered downstream of module authors, with the fix for module authors being to then have to understand which patterns in this project provide full backwards-compatibily. Rather, by fully freezing the detected patterns, if it works in any Node.js version it will work in any other. Build tools can also reliably treat the supported syntax for this project as a part of their output target for ensuring syntax support. _Detection patterns for this project are **frozen**_. This is because adding any new export detection patterns would result in fragmented backwards-compatibility. Specifically, it would be very difficult to figure out why an ES module named export for CommonJS might work in newer Node.js versions but not older versions. This problem would only be discovered downstream of module authors, with the fix for module authors being to then have to understand which patterns in this project provide full backwards-compatibily. Rather, by fully freezing the detected patterns, if it works in any Node.js version it will work in any other. Build tools can also reliably treat the supported syntax for this project as a part of their output target for ensuring syntax support.
### Usage ### Usage
``` ```
npm install cjs-module-lexer npm install cjs-module-lexer
``` ```
For use in CommonJS: For use in CommonJS:
```js ```js
const { parse } = require('cjs-module-lexer'); const { parse } = require('cjs-module-lexer');
// `init` return a promise for parity with the ESM API, but you do not have to call it // `init` return a promise for parity with the ESM API, but you do not have to call it
const { exports, reexports } = parse(` const { exports, reexports } = parse(`
// named exports detection // named exports detection
module.exports.a = 'a'; module.exports.a = 'a';
(function () { (function () {
exports.b = 'b'; exports.b = 'b';
})(); })();
Object.defineProperty(exports, 'c', { value: 'c' }); Object.defineProperty(exports, 'c', { value: 'c' });
/* exports.d = 'not detected'; */ /* exports.d = 'not detected'; */
// reexports detection // reexports detection
if (maybe) module.exports = require('./dep1.js'); if (maybe) module.exports = require('./dep1.js');
if (another) module.exports = require('./dep2.js'); if (another) module.exports = require('./dep2.js');
// literal exports assignments // literal exports assignments
module.exports = { a, b: c, d, 'e': f } module.exports = { a, b: c, d, 'e': f }
// __esModule detection // __esModule detection
Object.defineProperty(module.exports, '__esModule', { value: true }) Object.defineProperty(module.exports, '__esModule', { value: true })
`); `);
// exports === ['a', 'b', 'c', '__esModule'] // exports === ['a', 'b', 'c', '__esModule']
// reexports === ['./dep1.js', './dep2.js'] // reexports === ['./dep1.js', './dep2.js']
``` ```
When using the ESM version, Wasm is supported instead: When using the ESM version, Wasm is supported instead:
```js ```js
import { parse, init } from 'cjs-module-lexer'; import { parse, init } from 'cjs-module-lexer';
// init() needs to be called and waited upon, or use initSync() to compile // init() needs to be called and waited upon, or use initSync() to compile
// Wasm blockingly and synchronously. // Wasm blockingly and synchronously.
await init(); await init();
const { exports, reexports } = parse(source); const { exports, reexports } = parse(source);
``` ```
The Wasm build is around 1.5x faster and without a cold start. The Wasm build is around 1.5x faster and without a cold start.
### Grammar ### Grammar
CommonJS exports matches are run against the source token stream. CommonJS exports matches are run against the source token stream.
The token grammar is: The token grammar is:
``` ```
IDENTIFIER: As defined by ECMA-262, without support for identifier `\` escapes, filtered to remove strict reserved words: IDENTIFIER: As defined by ECMA-262, without support for identifier `\` escapes, filtered to remove strict reserved words:
"implements", "interface", "let", "package", "private", "protected", "public", "static", "yield", "enum" "implements", "interface", "let", "package", "private", "protected", "public", "static", "yield", "enum"
STRING_LITERAL: A `"` or `'` bounded ECMA-262 string literal. STRING_LITERAL: A `"` or `'` bounded ECMA-262 string literal.
MODULE_EXPORTS: `module` `.` `exports` MODULE_EXPORTS: `module` `.` `exports`
EXPORTS_IDENTIFIER: MODULE_EXPORTS_IDENTIFIER | `exports` EXPORTS_IDENTIFIER: MODULE_EXPORTS_IDENTIFIER | `exports`
EXPORTS_DOT_ASSIGN: EXPORTS_IDENTIFIER `.` IDENTIFIER `=` EXPORTS_DOT_ASSIGN: EXPORTS_IDENTIFIER `.` IDENTIFIER `=`
EXPORTS_LITERAL_COMPUTED_ASSIGN: EXPORTS_IDENTIFIER `[` STRING_LITERAL `]` `=` EXPORTS_LITERAL_COMPUTED_ASSIGN: EXPORTS_IDENTIFIER `[` STRING_LITERAL `]` `=`
EXPORTS_LITERAL_PROP: (IDENTIFIER (`:` IDENTIFIER)?) | (STRING_LITERAL `:` IDENTIFIER) EXPORTS_LITERAL_PROP: (IDENTIFIER (`:` IDENTIFIER)?) | (STRING_LITERAL `:` IDENTIFIER)
EXPORTS_SPREAD: `...` (IDENTIFIER | REQUIRE) EXPORTS_SPREAD: `...` (IDENTIFIER | REQUIRE)
EXPORTS_MEMBER: EXPORTS_DOT_ASSIGN | EXPORTS_LITERAL_COMPUTED_ASSIGN EXPORTS_MEMBER: EXPORTS_DOT_ASSIGN | EXPORTS_LITERAL_COMPUTED_ASSIGN
EXPORTS_DEFINE: `Object` `.` `defineProperty `(` EXPORTS_IDENFITIER `,` STRING_LITERAL EXPORTS_DEFINE: `Object` `.` `defineProperty `(` EXPORTS_IDENFITIER `,` STRING_LITERAL
EXPORTS_DEFINE_VALUE: EXPORTS_DEFINE `, {` EXPORTS_DEFINE_VALUE: EXPORTS_DEFINE `, {`
(`enumerable: true,`)? (`enumerable: true,`)?
( (
`value:` | `value:` |
`get` (`: function` IDENTIFIER? )? `() {` return IDENTIFIER (`.` IDENTIFIER | `[` STRING_LITERAL `]`)? `;`? `}` `,`? `get` (`: function` IDENTIFIER? )? `() {` return IDENTIFIER (`.` IDENTIFIER | `[` STRING_LITERAL `]`)? `;`? `}` `,`?
) )
`})` `})`
EXPORTS_LITERAL: MODULE_EXPORTS `=` `{` (EXPORTS_LITERAL_PROP | EXPORTS_SPREAD) `,`)+ `}` EXPORTS_LITERAL: MODULE_EXPORTS `=` `{` (EXPORTS_LITERAL_PROP | EXPORTS_SPREAD) `,`)+ `}`
REQUIRE: `require` `(` STRING_LITERAL `)` REQUIRE: `require` `(` STRING_LITERAL `)`
EXPORTS_ASSIGN: (`var` | `const` | `let`) IDENTIFIER `=` (`_interopRequireWildcard (`)? REQUIRE EXPORTS_ASSIGN: (`var` | `const` | `let`) IDENTIFIER `=` (`_interopRequireWildcard (`)? REQUIRE
MODULE_EXPORTS_ASSIGN: MODULE_EXPORTS `=` REQUIRE MODULE_EXPORTS_ASSIGN: MODULE_EXPORTS `=` REQUIRE
EXPORT_STAR: (`__export` | `__exportStar`) `(` REQUIRE EXPORT_STAR: (`__export` | `__exportStar`) `(` REQUIRE
EXPORT_STAR_LIB: `Object.keys(` IDENTIFIER$1 `).forEach(function (` IDENTIFIER$2 `) {` EXPORT_STAR_LIB: `Object.keys(` IDENTIFIER$1 `).forEach(function (` IDENTIFIER$2 `) {`
( (
( (
`if (` IDENTIFIER$2 `===` ( `'default'` | `"default"` ) `||` IDENTIFIER$2 `===` ( '__esModule' | `"__esModule"` ) `) return` `;`? `if (` IDENTIFIER$2 `===` ( `'default'` | `"default"` ) `||` IDENTIFIER$2 `===` ( '__esModule' | `"__esModule"` ) `) return` `;`?
( (
(`if (Object` `.prototype`? `.hasOwnProperty.call(` IDENTIFIER `, ` IDENTIFIER$2 `)) return` `;`?)? (`if (Object` `.prototype`? `.hasOwnProperty.call(` IDENTIFIER `, ` IDENTIFIER$2 `)) return` `;`?)?
(`if (` IDENTIFIER$2 `in` EXPORTS_IDENTIFIER `&&` EXPORTS_IDENTIFIER `[` IDENTIFIER$2 `] ===` IDENTIFIER$1 `[` IDENTIFIER$2 `]) return` `;`)? (`if (` IDENTIFIER$2 `in` EXPORTS_IDENTIFIER `&&` EXPORTS_IDENTIFIER `[` IDENTIFIER$2 `] ===` IDENTIFIER$1 `[` IDENTIFIER$2 `]) return` `;`)?
)? )?
) | ) |
`if (` IDENTIFIER$2 `!==` ( `'default'` | `"default"` ) (`&& !` (`Object` `.prototype`? `.hasOwnProperty.call(` IDENTIFIER `, ` IDENTIFIER$2 `)` | IDENTIFIER `.hasOwnProperty(` IDENTIFIER$2 `)`))? `)` `if (` IDENTIFIER$2 `!==` ( `'default'` | `"default"` ) (`&& !` (`Object` `.prototype`? `.hasOwnProperty.call(` IDENTIFIER `, ` IDENTIFIER$2 `)` | IDENTIFIER `.hasOwnProperty(` IDENTIFIER$2 `)`))? `)`
) )
( (
EXPORTS_IDENTIFIER `[` IDENTIFIER$2 `] =` IDENTIFIER$1 `[` IDENTIFIER$2 `]` `;`? | EXPORTS_IDENTIFIER `[` IDENTIFIER$2 `] =` IDENTIFIER$1 `[` IDENTIFIER$2 `]` `;`? |
`Object.defineProperty(` EXPORTS_IDENTIFIER `, ` IDENTIFIER$2 `, { enumerable: true, get` (`: function` IDENTIFIER? )? `() { return ` IDENTIFIER$1 `[` IDENTIFIER$2 `]` `;`? `}` `,`? `})` `;`? `Object.defineProperty(` EXPORTS_IDENTIFIER `, ` IDENTIFIER$2 `, { enumerable: true, get` (`: function` IDENTIFIER? )? `() { return ` IDENTIFIER$1 `[` IDENTIFIER$2 `]` `;`? `}` `,`? `})` `;`?
) )
`})` `})`
``` ```
Spacing between tokens is taken to be any ECMA-262 whitespace, ECMA-262 block comment or ECMA-262 line comment. Spacing between tokens is taken to be any ECMA-262 whitespace, ECMA-262 block comment or ECMA-262 line comment.
* The returned export names are taken to be the combination of: * The returned export names are taken to be the combination of:
1. All `IDENTIFIER` and `STRING_LITERAL` slots for `EXPORTS_MEMBER` and `EXPORTS_LITERAL` matches. 1. All `IDENTIFIER` and `STRING_LITERAL` slots for `EXPORTS_MEMBER` and `EXPORTS_LITERAL` matches.
2. The first `STRING_LITERAL` slot for all `EXPORTS_DEFINE_VALUE` matches where that same string is not an `EXPORTS_DEFINE` match that is not also an `EXPORTS_DEFINE_VALUE` match. 2. The first `STRING_LITERAL` slot for all `EXPORTS_DEFINE_VALUE` matches where that same string is not an `EXPORTS_DEFINE` match that is not also an `EXPORTS_DEFINE_VALUE` match.
* The reexport specifiers are taken to be the combination of: * The reexport specifiers are taken to be the combination of:
1. The `REQUIRE` matches of the last matched of either `MODULE_EXPORTS_ASSIGN` or `EXPORTS_LITERAL`. 1. The `REQUIRE` matches of the last matched of either `MODULE_EXPORTS_ASSIGN` or `EXPORTS_LITERAL`.
2. All _top-level_ `EXPORT_STAR` `REQUIRE` matches and `EXPORTS_ASSIGN` matches whose `IDENTIFIER` also matches the first `IDENTIFIER` in `EXPORT_STAR_LIB`. 2. All _top-level_ `EXPORT_STAR` `REQUIRE` matches and `EXPORTS_ASSIGN` matches whose `IDENTIFIER` also matches the first `IDENTIFIER` in `EXPORT_STAR_LIB`.
### Parsing Examples ### Parsing Examples
#### Named Exports Parsing #### Named Exports Parsing
The basic matching rules for named exports are `exports.name`, `exports['name']` or `Object.defineProperty(exports, 'name', ...)`. This matching is done without scope analysis and regardless of the expression position: The basic matching rules for named exports are `exports.name`, `exports['name']` or `Object.defineProperty(exports, 'name', ...)`. This matching is done without scope analysis and regardless of the expression position:
```js ```js
// DETECTS EXPORTS: a, b // DETECTS EXPORTS: a, b
(function (exports) { (function (exports) {
exports.a = 'a'; exports.a = 'a';
exports['b'] = 'b'; exports['b'] = 'b';
})(exports); })(exports);
``` ```
Because there is no scope analysis, the above detection may overclassify: Because there is no scope analysis, the above detection may overclassify:
```js ```js
// DETECTS EXPORTS: a, b, c // DETECTS EXPORTS: a, b, c
(function (exports, Object) { (function (exports, Object) {
exports.a = 'a'; exports.a = 'a';
exports['b'] = 'b'; exports['b'] = 'b';
if (false) if (false)
exports.c = 'c'; exports.c = 'c';
})(NOT_EXPORTS, NOT_OBJECT); })(NOT_EXPORTS, NOT_OBJECT);
``` ```
It will in turn underclassify in cases where the identifiers are renamed: It will in turn underclassify in cases where the identifiers are renamed:
```js ```js
// DETECTS: NO EXPORTS // DETECTS: NO EXPORTS
(function (e) { (function (e) {
e.a = 'a'; e.a = 'a';
e['b'] = 'b'; e['b'] = 'b';
})(exports); })(exports);
``` ```
#### Getter Exports Parsing #### Getter Exports Parsing
`Object.defineProperty` is detected for specifically value and getter forms returning an identifier or member expression: `Object.defineProperty` is detected for specifically value and getter forms returning an identifier or member expression:
```js ```js
// DETECTS: a, b, c, d, __esModule // DETECTS: a, b, c, d, __esModule
Object.defineProperty(exports, 'a', { Object.defineProperty(exports, 'a', {
enumerable: true, enumerable: true,
get: function () { get: function () {
return q.p; return q.p;
} }
}); });
Object.defineProperty(exports, 'b', { Object.defineProperty(exports, 'b', {
enumerable: true, enumerable: true,
get: function () { get: function () {
return q['p']; return q['p'];
} }
}); });
Object.defineProperty(exports, 'c', { Object.defineProperty(exports, 'c', {
enumerable: true, enumerable: true,
get () { get () {
return b; return b;
} }
}); });
Object.defineProperty(exports, 'd', { value: 'd' }); Object.defineProperty(exports, 'd', { value: 'd' });
Object.defineProperty(exports, '__esModule', { value: true }); Object.defineProperty(exports, '__esModule', { value: true });
``` ```
Value properties are also detected specifically: Value properties are also detected specifically:
```js ```js
Object.defineProperty(exports, 'a', { Object.defineProperty(exports, 'a', {
value: 'no problem' value: 'no problem'
}); });
``` ```
To avoid matching getters that have side effects, any getter for an export name that does not support the forms above will To avoid matching getters that have side effects, any getter for an export name that does not support the forms above will
opt-out of the getter matching: opt-out of the getter matching:
```js ```js
// DETECTS: NO EXPORTS // DETECTS: NO EXPORTS
Object.defineProperty(exports, 'a', { Object.defineProperty(exports, 'a', {
get () { get () {
return 'nope'; return 'nope';
} }
}); });
if (false) { if (false) {
Object.defineProperty(module.exports, 'a', { Object.defineProperty(module.exports, 'a', {
get () { get () {
return dynamic(); return dynamic();
} }
}) })
} }
``` ```
Alternative object definition structures or getter function bodies are not detected: Alternative object definition structures or getter function bodies are not detected:
```js ```js
// DETECTS: NO EXPORTS // DETECTS: NO EXPORTS
Object.defineProperty(exports, 'a', { Object.defineProperty(exports, 'a', {
enumerable: false, enumerable: false,
get () { get () {
return p; return p;
} }
}); });
Object.defineProperty(exports, 'b', { Object.defineProperty(exports, 'b', {
configurable: true, configurable: true,
get () { get () {
return p; return p;
} }
}); });
Object.defineProperty(exports, 'c', { Object.defineProperty(exports, 'c', {
get: () => p get: () => p
}); });
Object.defineProperty(exports, 'd', { Object.defineProperty(exports, 'd', {
enumerable: true, enumerable: true,
get: function () { get: function () {
return dynamic(); return dynamic();
} }
}); });
Object.defineProperty(exports, 'e', { Object.defineProperty(exports, 'e', {
enumerable: true, enumerable: true,
get () { get () {
return 'str'; return 'str';
} }
}); });
``` ```
`Object.defineProperties` is also not supported. `Object.defineProperties` is also not supported.
#### Exports Object Assignment #### Exports Object Assignment
A best-effort is made to detect `module.exports` object assignments, but because this is not a full parser, arbitrary expressions are not handled in the A best-effort is made to detect `module.exports` object assignments, but because this is not a full parser, arbitrary expressions are not handled in the
object parsing process. object parsing process.
Simple object definitions are supported: Simple object definitions are supported:
```js ```js
// DETECTS EXPORTS: a, b, c // DETECTS EXPORTS: a, b, c
module.exports = { module.exports = {
a, a,
'b': b, 'b': b,
c: c, c: c,
...d ...d
}; };
``` ```
Object properties that are not identifiers or string expressions will bail out of the object detection, while spreads are ignored: Object properties that are not identifiers or string expressions will bail out of the object detection, while spreads are ignored:
```js ```js
// DETECTS EXPORTS: a, b // DETECTS EXPORTS: a, b
module.exports = { module.exports = {
a, a,
...d, ...d,
b: require('c'), b: require('c'),
c: "not detected since require('c') above bails the object detection" c: "not detected since require('c') above bails the object detection"
} }
``` ```
`Object.defineProperties` is not currently supported either. `Object.defineProperties` is not currently supported either.
#### module.exports reexport assignment #### module.exports reexport assignment
Any `module.exports = require('mod')` assignment is detected as a reexport, but only the last one is returned: Any `module.exports = require('mod')` assignment is detected as a reexport, but only the last one is returned:
```js ```js
// DETECTS REEXPORTS: c // DETECTS REEXPORTS: c
module.exports = require('a'); module.exports = require('a');
(module => module.exports = require('b'))(NOT_MODULE); (module => module.exports = require('b'))(NOT_MODULE);
if (false) module.exports = require('c'); if (false) module.exports = require('c');
``` ```
This is to avoid over-classification in Webpack bundles with externals which include `module.exports = require('external')` in their source for every external dependency. This is to avoid over-classification in Webpack bundles with externals which include `module.exports = require('external')` in their source for every external dependency.
In exports object assignment, any spread of `require()` are detected as multiple separate reexports: In exports object assignment, any spread of `require()` are detected as multiple separate reexports:
```js ```js
// DETECTS REEXPORTS: a, b // DETECTS REEXPORTS: a, b
module.exports = require('ignored'); module.exports = require('ignored');
module.exports = { module.exports = {
...require('a'), ...require('a'),
...require('b') ...require('b')
}; };
``` ```
#### Transpiler Re-exports #### Transpiler Re-exports
For named exports, transpiler output works well with the rules described above. For named exports, transpiler output works well with the rules described above.
But for star re-exports, special care is taken to support common patterns of transpiler outputs from Babel and TypeScript as well as bundlers like RollupJS. But for star re-exports, special care is taken to support common patterns of transpiler outputs from Babel and TypeScript as well as bundlers like RollupJS.
These reexport and star reexport patterns are restricted to only be detected at the top-level as provided by the direct output of these tools. These reexport and star reexport patterns are restricted to only be detected at the top-level as provided by the direct output of these tools.
For example, `export * from 'external'` is output by Babel as: For example, `export * from 'external'` is output by Babel as:
```js ```js
"use strict"; "use strict";
exports.__esModule = true; exports.__esModule = true;
var _external = require("external"); var _external = require("external");
Object.keys(_external).forEach(function (key) { Object.keys(_external).forEach(function (key) {
if (key === "default" || key === "__esModule") return; if (key === "default" || key === "__esModule") return;
exports[key] = _external[key]; exports[key] = _external[key];
}); });
``` ```
Where the `var _external = require("external")` is specifically detected as well as the `Object.keys(_external)` statement, down to the exact Where the `var _external = require("external")` is specifically detected as well as the `Object.keys(_external)` statement, down to the exact
for of that entire expression including minor variations of the output. The `_external` and `key` identifiers are carefully matched in this for of that entire expression including minor variations of the output. The `_external` and `key` identifiers are carefully matched in this
detection. detection.
Similarly for TypeScript, `export * from 'external'` is output as: Similarly for TypeScript, `export * from 'external'` is output as:
```js ```js
"use strict"; "use strict";
function __export(m) { function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p]; for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
} }
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
__export(require("external")); __export(require("external"));
``` ```
Where the `__export(require("external"))` statement is explicitly detected as a reexport, including variations `tslib.__export` and `__exportStar`. Where the `__export(require("external"))` statement is explicitly detected as a reexport, including variations `tslib.__export` and `__exportStar`.
### Environment Support ### Environment Support
Node.js 10+, and [all browsers with Web Assembly support](https://caniuse.com/#feat=wasm). Node.js 10+, and [all browsers with Web Assembly support](https://caniuse.com/#feat=wasm).
### JS Grammar Support ### JS Grammar Support
* Token state parses all line comments, block comments, strings, template strings, blocks, parens and punctuators. * Token state parses all line comments, block comments, strings, template strings, blocks, parens and punctuators.
* Division operator / regex token ambiguity is handled via backtracking checks against punctuator prefixes, including closing brace or paren backtracking. * Division operator / regex token ambiguity is handled via backtracking checks against punctuator prefixes, including closing brace or paren backtracking.
* Always correctly parses valid JS source, but may parse invalid JS source without errors. * Always correctly parses valid JS source, but may parse invalid JS source without errors.
### Benchmarks ### Benchmarks
Benchmarks can be run with `npm run bench`. Benchmarks can be run with `npm run bench`.
Current results: Current results:
JS Build: JS Build:
``` ```
Module load time Module load time
> 4ms > 4ms
Cold Run, All Samples Cold Run, All Samples
test/samples/*.js (3635 KiB) test/samples/*.js (3635 KiB)
> 299ms > 299ms
Warm Runs (average of 25 runs) Warm Runs (average of 25 runs)
test/samples/angular.js (1410 KiB) test/samples/angular.js (1410 KiB)
> 13.96ms > 13.96ms
test/samples/angular.min.js (303 KiB) test/samples/angular.min.js (303 KiB)
> 4.72ms > 4.72ms
test/samples/d3.js (553 KiB) test/samples/d3.js (553 KiB)
> 6.76ms > 6.76ms
test/samples/d3.min.js (250 KiB) test/samples/d3.min.js (250 KiB)
> 4ms > 4ms
test/samples/magic-string.js (34 KiB) test/samples/magic-string.js (34 KiB)
> 0.64ms > 0.64ms
test/samples/magic-string.min.js (20 KiB) test/samples/magic-string.min.js (20 KiB)
> 0ms > 0ms
test/samples/rollup.js (698 KiB) test/samples/rollup.js (698 KiB)
> 8.48ms > 8.48ms
test/samples/rollup.min.js (367 KiB) test/samples/rollup.min.js (367 KiB)
> 5.36ms > 5.36ms
Warm Runs, All Samples (average of 25 runs) Warm Runs, All Samples (average of 25 runs)
test/samples/*.js (3635 KiB) test/samples/*.js (3635 KiB)
> 40.28ms > 40.28ms
``` ```
Wasm Build: Wasm Build:
``` ```
Module load time Module load time
> 10ms > 10ms
Cold Run, All Samples Cold Run, All Samples
test/samples/*.js (3635 KiB) test/samples/*.js (3635 KiB)
> 43ms > 43ms
Warm Runs (average of 25 runs) Warm Runs (average of 25 runs)
test/samples/angular.js (1410 KiB) test/samples/angular.js (1410 KiB)
> 9.32ms > 9.32ms
test/samples/angular.min.js (303 KiB) test/samples/angular.min.js (303 KiB)
> 3.16ms > 3.16ms
test/samples/d3.js (553 KiB) test/samples/d3.js (553 KiB)
> 5ms > 5ms
test/samples/d3.min.js (250 KiB) test/samples/d3.min.js (250 KiB)
> 2.32ms > 2.32ms
test/samples/magic-string.js (34 KiB) test/samples/magic-string.js (34 KiB)
> 0.16ms > 0.16ms
test/samples/magic-string.min.js (20 KiB) test/samples/magic-string.min.js (20 KiB)
> 0ms > 0ms
test/samples/rollup.js (698 KiB) test/samples/rollup.js (698 KiB)
> 6.28ms > 6.28ms
test/samples/rollup.min.js (367 KiB) test/samples/rollup.min.js (367 KiB)
> 3.6ms > 3.6ms
Warm Runs, All Samples (average of 25 runs) Warm Runs, All Samples (average of 25 runs)
test/samples/*.js (3635 KiB) test/samples/*.js (3635 KiB)
> 27.76ms > 27.76ms
``` ```
### Wasm Build Steps ### Wasm Build Steps
To build download the WASI SDK from https://github.com/WebAssembly/wasi-sdk/releases. The build uses docker and make, they must be installed first.
The Makefile assumes the existence of "wasi-sdk-11.0" and "wabt" (optional) as sibling folders to this project. To build the lexer wasm run `npm run build-wasm`.
The build through the Makefile is then run via `make lib/lexer.wasm`, which can also be triggered via `npm run build-wasm` to create `dist/lexer.js`. Optimization passes are run with [Binaryen](https://github.com/WebAssembly/binaryen)
prior to publish to reduce the Web Assembly footprint.
On Windows it may be preferable to use the Linux subsystem.
After building the lexer wasm, build the final distribution components
After the Web Assembly build, the CJS build can be triggered via `npm run build`. (lexer.js and lexer.mjs) by running `npm run build`.
Optimization passes are run with [Binaryen](https://github.com/WebAssembly/binaryen) prior to publish to reduce the Web Assembly footprint. If you need to build lib/lexer.wat (optional) you must first install
[wabt](https://github.com/WebAssembly/wabt) as a sibling folder to this
### License project. The wat file is then build by running `make lib/lexer.wat`
MIT ### License
[travis-url]: https://travis-ci.org/guybedford/es-module-lexer MIT
[travis-image]: https://travis-ci.org/guybedford/es-module-lexer.svg?branch=master
[travis-url]: https://travis-ci.org/guybedford/es-module-lexer
[travis-image]: https://travis-ci.org/guybedford/es-module-lexer.svg?branch=master

91
deps/cjs-module-lexer/dist/lexer-external.js vendored
View file

@ -1,91 +0,0 @@
"use strict";
exports.init = init;
exports.parse = parse;
let wasm;
const isLE = new Uint8Array(new Uint16Array([1]).buffer)[0] === 1;
function parse(source, name = '@') {
if (!wasm) throw new Error('Not initialized');
const len = source.length + 1;
// need 2 bytes per code point plus analysis space so we double again
const extraMem = (wasm.__heap_base.value || wasm.__heap_base) + len * 4 - wasm.memory.buffer.byteLength;
if (extraMem > 0) wasm.memory.grow(Math.ceil(extraMem / 65536));
const addr = wasm.sa(len);
(isLE ? copyLE : copyBE)(source, new Uint16Array(wasm.memory.buffer, addr, len));
const err_code = wasm.parseCJS(addr, source.length, 0, 0, 0);
if (err_code) {
const err = new Error(`Parse error ${name}${wasm.e()}:${source.slice(0, wasm.e()).split('\n').length}:${wasm.e() - source.lastIndexOf('\n', wasm.e() - 1)}`);
Object.assign(err, {
idx: wasm.e()
});
if (err_code === 5 || err_code === 6 || err_code === 7) Object.assign(err, {
code: 'ERR_LEXER_ESM_SYNTAX'
});
throw err;
}
let exports = new Set(),
reexports = new Set(),
unsafeGetters = new Set();
while (wasm.rre()) {
const reexptStr = decode(source.slice(wasm.res(), wasm.ree()));
if (reexptStr) reexports.add(reexptStr);
}
while (wasm.ru()) unsafeGetters.add(decode(source.slice(wasm.us(), wasm.ue())));
while (wasm.re()) {
let exptStr = decode(source.slice(wasm.es(), wasm.ee()));
if (exptStr !== undefined && !unsafeGetters.has(exptStr)) exports.add(exptStr);
}
return {
exports: [...exports],
reexports: [...reexports]
};
}
function decode(str) {
if (str[0] === '"' || str[0] === '\'') {
try {
const decoded = (0, eval)(str);
// Filter to exclude non-matching UTF-16 surrogate strings
for (let i = 0; i < decoded.length; i++) {
const surrogatePrefix = decoded.charCodeAt(i) & 0xFC00;
if (surrogatePrefix < 0xD800) {
// Not a surrogate
continue;
} else if (surrogatePrefix === 0xD800) {
// Validate surrogate pair
if ((decoded.charCodeAt(++i) & 0xFC00) !== 0xDC00) return;
} else {
// Out-of-range surrogate code (above 0xD800)
return;
}
}
return decoded;
} catch {}
} else {
return str;
}
}
function copyBE(src, outBuf16) {
const len = src.length;
let i = 0;
while (i < len) {
const ch = src.charCodeAt(i);
outBuf16[i++] = (ch & 0xff) << 8 | ch >>> 8;
}
}
function copyLE(src, outBuf16) {
const len = src.length;
let i = 0;
while (i < len) outBuf16[i] = src.charCodeAt(i++);
}
let initPromise;
function init() {
if (initPromise) return initPromise;
return initPromise = (async () => {
const compiled = await WebAssembly.compile((await import('node:fs')).readFileSync(new URL(import.meta.resolve('../lib/lexer.wasm'))));
const {
exports
} = await WebAssembly.instantiate(compiled);
wasm = exports;
})();
}

2
deps/cjs-module-lexer/dist/lexer.js vendored
View file

File diff suppressed because one or more lines are too long

4
deps/cjs-module-lexer/dist/lexer.mjs vendored
View file

File diff suppressed because one or more lines are too long

0
deps/cjs-module-lexer/lexer.js vendored Normal file → Executable file
View file

10
deps/cjs-module-lexer/src/.babelrc vendored Executable file
View file

@ -0,0 +1,10 @@
{
"plugins": [
[
"@babel/plugin-transform-modules-commonjs",
{
"strict": true
},
]
]
}

40
deps/cjs-module-lexer/src/CHANGELOG.md vendored Normal file
View file

@ -0,0 +1,40 @@
1.2.2
- Fix RollupJS reexports bug (https://github.com/nodejs/cjs-module-lexer/pull/59)
1.2.1
- Support Unicode escapes in strings (https://github.com/nodejs/cjs-module-lexer/pull/55)
- Filter export strings to valid surrogate pairs (https://github.com/nodejs/cjs-module-lexer/pull/56)
1.2.0
- Support for non-identifier exports (https://github.com/nodejs/cjs-module-lexer/pull/54, @nicolo-ribaudo)
1.1.1
- Better support for Babel reexport getter function forms (https://github.com/nodejs/cjs-module-lexer/issues/50)
- Support Babel interopRequireWildcard reexports patterns (https://github.com/nodejs/cjs-module-lexer/issues/52)
1.1.0
- Support for Babel reexport conflict filter (https://github.com/nodejs/cjs-module-lexer/issues/36, @nicolo-ribaudo)
- Support trailing commas in getter patterns (https://github.com/nodejs/cjs-module-lexer/issues/31)
- Support for RollupJS reexports property checks (https://github.com/nodejs/cjs-module-lexer/issues/38)
1.0.0
- Unsafe getter tracking (https://github.com/nodejs/cjs-module-lexer/pull/29)
0.6.0
- API-only breaking change: Unify JS and Wasm interfaces (https://github.com/nodejs/cjs-module-lexer/pull/27)
- Add type definitions (https://github.com/nodejs/cjs-module-lexer/pull/28)
0.5.2
- Support named getter functions (https://github.com/nodejs/cjs-module-lexer/pull/26)
0.5.1:
- Feature: Implement specific reexport getter forms (https://github.com/nodejs/cjs-module-lexer/pull/25)
0.5.0
- Breaking Change: No longer emit Object.defineProperty exports (https://github.com/nodejs/cjs-module-lexer/pull/24)
- Doc: Update link to WASI SDK (https://github.com/nodejs/cjs-module-lexer/pull/19)
0.4.3
- Support for Babel 7.12 reexports (https://github.com/nodejs/cjs-module-lexer/pull/16)
- Support module.exports = { ...require('x') } reexports (https://github.com/nodejs/cjs-module-lexer/pull/18)
- "if" keyword space parsing in exports matching (https://github.com/nodejs/cjs-module-lexer/pull/17)

10
deps/cjs-module-lexer/src/LICENSE vendored Executable file
View file

@ -0,0 +1,10 @@
MIT License
-----------
Copyright (C) 2018-2020 Guy Bedford
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

16
deps/cjs-module-lexer/src/Makefile vendored Executable file
View file

@ -0,0 +1,16 @@
WASM2WAT := ../wabt/bin/wasm2wat
WASM_OPT := ../binaryen/bin/wasm-opt
.PHONY: optimize clean
lib/lexer.wat: lib/lexer.wasm
$(WASM2WAT) lib/lexer.wasm -o lib/lexer.wat
lib/lexer.wasm: include-wasm/cjs-module-lexer.h src/lexer.c | lib/
node build/wasm.js --docker
lib/:
@mkdir -p $@
clean:
$(RM) lib/*

464
deps/cjs-module-lexer/src/README.md vendored Executable file
View file

@ -0,0 +1,464 @@
# CJS Module Lexer
[![Build Status][travis-image]][travis-url]
A [very fast](#benchmarks) JS CommonJS module syntax lexer used to detect the most likely list of named exports of a CommonJS module.
Outputs the list of named exports (`exports.name = ...`) and possible module reexports (`module.exports = require('...')`), including the common transpiler variations of these cases.
Forked from https://github.com/guybedford/es-module-lexer.
_Comprehensively handles the JS language grammar while remaining small and fast. - ~90ms per MB of JS cold and ~15ms per MB of JS warm, [see benchmarks](#benchmarks) for more info._
### Project Status
This project is used in Node.js core for detecting the named exports available when importing a CJS module into ESM, and is maintained for this purpose.
PRs will be accepted and upstreamed for parser bugs, performance improvements or new syntax support only.
_Detection patterns for this project are **frozen**_. This is because adding any new export detection patterns would result in fragmented backwards-compatibility. Specifically, it would be very difficult to figure out why an ES module named export for CommonJS might work in newer Node.js versions but not older versions. This problem would only be discovered downstream of module authors, with the fix for module authors being to then have to understand which patterns in this project provide full backwards-compatibily. Rather, by fully freezing the detected patterns, if it works in any Node.js version it will work in any other. Build tools can also reliably treat the supported syntax for this project as a part of their output target for ensuring syntax support.
### Usage
```
npm install cjs-module-lexer
```
For use in CommonJS:
```js
const { parse } = require('cjs-module-lexer');
// `init` return a promise for parity with the ESM API, but you do not have to call it
const { exports, reexports } = parse(`
// named exports detection
module.exports.a = 'a';
(function () {
exports.b = 'b';
})();
Object.defineProperty(exports, 'c', { value: 'c' });
/* exports.d = 'not detected'; */
// reexports detection
if (maybe) module.exports = require('./dep1.js');
if (another) module.exports = require('./dep2.js');
// literal exports assignments
module.exports = { a, b: c, d, 'e': f }
// __esModule detection
Object.defineProperty(module.exports, '__esModule', { value: true })
`);
// exports === ['a', 'b', 'c', '__esModule']
// reexports === ['./dep1.js', './dep2.js']
```
When using the ESM version, Wasm is supported instead:
```js
import { parse, init } from 'cjs-module-lexer';
// init() needs to be called and waited upon, or use initSync() to compile
// Wasm blockingly and synchronously.
await init();
const { exports, reexports } = parse(source);
```
The Wasm build is around 1.5x faster and without a cold start.
### Grammar
CommonJS exports matches are run against the source token stream.
The token grammar is:
```
IDENTIFIER: As defined by ECMA-262, without support for identifier `\` escapes, filtered to remove strict reserved words:
"implements", "interface", "let", "package", "private", "protected", "public", "static", "yield", "enum"
STRING_LITERAL: A `"` or `'` bounded ECMA-262 string literal.
MODULE_EXPORTS: `module` `.` `exports`
EXPORTS_IDENTIFIER: MODULE_EXPORTS_IDENTIFIER | `exports`
EXPORTS_DOT_ASSIGN: EXPORTS_IDENTIFIER `.` IDENTIFIER `=`
EXPORTS_LITERAL_COMPUTED_ASSIGN: EXPORTS_IDENTIFIER `[` STRING_LITERAL `]` `=`
EXPORTS_LITERAL_PROP: (IDENTIFIER (`:` IDENTIFIER)?) | (STRING_LITERAL `:` IDENTIFIER)
EXPORTS_SPREAD: `...` (IDENTIFIER | REQUIRE)
EXPORTS_MEMBER: EXPORTS_DOT_ASSIGN | EXPORTS_LITERAL_COMPUTED_ASSIGN
EXPORTS_DEFINE: `Object` `.` `defineProperty `(` EXPORTS_IDENFITIER `,` STRING_LITERAL
EXPORTS_DEFINE_VALUE: EXPORTS_DEFINE `, {`
(`enumerable: true,`)?
(
`value:` |
`get` (`: function` IDENTIFIER? )? `() {` return IDENTIFIER (`.` IDENTIFIER | `[` STRING_LITERAL `]`)? `;`? `}` `,`?
)
`})`
EXPORTS_LITERAL: MODULE_EXPORTS `=` `{` (EXPORTS_LITERAL_PROP | EXPORTS_SPREAD) `,`)+ `}`
REQUIRE: `require` `(` STRING_LITERAL `)`
EXPORTS_ASSIGN: (`var` | `const` | `let`) IDENTIFIER `=` (`_interopRequireWildcard (`)? REQUIRE
MODULE_EXPORTS_ASSIGN: MODULE_EXPORTS `=` REQUIRE
EXPORT_STAR: (`__export` | `__exportStar`) `(` REQUIRE
EXPORT_STAR_LIB: `Object.keys(` IDENTIFIER$1 `).forEach(function (` IDENTIFIER$2 `) {`
(
(
`if (` IDENTIFIER$2 `===` ( `'default'` | `"default"` ) `||` IDENTIFIER$2 `===` ( '__esModule' | `"__esModule"` ) `) return` `;`?
(
(`if (Object` `.prototype`? `.hasOwnProperty.call(` IDENTIFIER `, ` IDENTIFIER$2 `)) return` `;`?)?
(`if (` IDENTIFIER$2 `in` EXPORTS_IDENTIFIER `&&` EXPORTS_IDENTIFIER `[` IDENTIFIER$2 `] ===` IDENTIFIER$1 `[` IDENTIFIER$2 `]) return` `;`)?
)?
) |
`if (` IDENTIFIER$2 `!==` ( `'default'` | `"default"` ) (`&& !` (`Object` `.prototype`? `.hasOwnProperty.call(` IDENTIFIER `, ` IDENTIFIER$2 `)` | IDENTIFIER `.hasOwnProperty(` IDENTIFIER$2 `)`))? `)`
)
(
EXPORTS_IDENTIFIER `[` IDENTIFIER$2 `] =` IDENTIFIER$1 `[` IDENTIFIER$2 `]` `;`? |
`Object.defineProperty(` EXPORTS_IDENTIFIER `, ` IDENTIFIER$2 `, { enumerable: true, get` (`: function` IDENTIFIER? )? `() { return ` IDENTIFIER$1 `[` IDENTIFIER$2 `]` `;`? `}` `,`? `})` `;`?
)
`})`
```
Spacing between tokens is taken to be any ECMA-262 whitespace, ECMA-262 block comment or ECMA-262 line comment.
* The returned export names are taken to be the combination of:
1. All `IDENTIFIER` and `STRING_LITERAL` slots for `EXPORTS_MEMBER` and `EXPORTS_LITERAL` matches.
2. The first `STRING_LITERAL` slot for all `EXPORTS_DEFINE_VALUE` matches where that same string is not an `EXPORTS_DEFINE` match that is not also an `EXPORTS_DEFINE_VALUE` match.
* The reexport specifiers are taken to be the combination of:
1. The `REQUIRE` matches of the last matched of either `MODULE_EXPORTS_ASSIGN` or `EXPORTS_LITERAL`.
2. All _top-level_ `EXPORT_STAR` `REQUIRE` matches and `EXPORTS_ASSIGN` matches whose `IDENTIFIER` also matches the first `IDENTIFIER` in `EXPORT_STAR_LIB`.
### Parsing Examples
#### Named Exports Parsing
The basic matching rules for named exports are `exports.name`, `exports['name']` or `Object.defineProperty(exports, 'name', ...)`. This matching is done without scope analysis and regardless of the expression position:
```js
// DETECTS EXPORTS: a, b
(function (exports) {
exports.a = 'a';
exports['b'] = 'b';
})(exports);
```
Because there is no scope analysis, the above detection may overclassify:
```js
// DETECTS EXPORTS: a, b, c
(function (exports, Object) {
exports.a = 'a';
exports['b'] = 'b';
if (false)
exports.c = 'c';
})(NOT_EXPORTS, NOT_OBJECT);
```
It will in turn underclassify in cases where the identifiers are renamed:
```js
// DETECTS: NO EXPORTS
(function (e) {
e.a = 'a';
e['b'] = 'b';
})(exports);
```
#### Getter Exports Parsing
`Object.defineProperty` is detected for specifically value and getter forms returning an identifier or member expression:
```js
// DETECTS: a, b, c, d, __esModule
Object.defineProperty(exports, 'a', {
enumerable: true,
get: function () {
return q.p;
}
});
Object.defineProperty(exports, 'b', {
enumerable: true,
get: function () {
return q['p'];
}
});
Object.defineProperty(exports, 'c', {
enumerable: true,
get () {
return b;
}
});
Object.defineProperty(exports, 'd', { value: 'd' });
Object.defineProperty(exports, '__esModule', { value: true });
```
Value properties are also detected specifically:
```js
Object.defineProperty(exports, 'a', {
value: 'no problem'
});
```
To avoid matching getters that have side effects, any getter for an export name that does not support the forms above will
opt-out of the getter matching:
```js
// DETECTS: NO EXPORTS
Object.defineProperty(exports, 'a', {
get () {
return 'nope';
}
});
if (false) {
Object.defineProperty(module.exports, 'a', {
get () {
return dynamic();
}
})
}
```
Alternative object definition structures or getter function bodies are not detected:
```js
// DETECTS: NO EXPORTS
Object.defineProperty(exports, 'a', {
enumerable: false,
get () {
return p;
}
});
Object.defineProperty(exports, 'b', {
configurable: true,
get () {
return p;
}
});
Object.defineProperty(exports, 'c', {
get: () => p
});
Object.defineProperty(exports, 'd', {
enumerable: true,
get: function () {
return dynamic();
}
});
Object.defineProperty(exports, 'e', {
enumerable: true,
get () {
return 'str';
}
});
```
`Object.defineProperties` is also not supported.
#### Exports Object Assignment
A best-effort is made to detect `module.exports` object assignments, but because this is not a full parser, arbitrary expressions are not handled in the
object parsing process.
Simple object definitions are supported:
```js
// DETECTS EXPORTS: a, b, c
module.exports = {
a,
'b': b,
c: c,
...d
};
```
Object properties that are not identifiers or string expressions will bail out of the object detection, while spreads are ignored:
```js
// DETECTS EXPORTS: a, b
module.exports = {
a,
...d,
b: require('c'),
c: "not detected since require('c') above bails the object detection"
}
```
`Object.defineProperties` is not currently supported either.
#### module.exports reexport assignment
Any `module.exports = require('mod')` assignment is detected as a reexport, but only the last one is returned:
```js
// DETECTS REEXPORTS: c
module.exports = require('a');
(module => module.exports = require('b'))(NOT_MODULE);
if (false) module.exports = require('c');
```
This is to avoid over-classification in Webpack bundles with externals which include `module.exports = require('external')` in their source for every external dependency.
In exports object assignment, any spread of `require()` are detected as multiple separate reexports:
```js
// DETECTS REEXPORTS: a, b
module.exports = require('ignored');
module.exports = {
...require('a'),
...require('b')
};
```
#### Transpiler Re-exports
For named exports, transpiler output works well with the rules described above.
But for star re-exports, special care is taken to support common patterns of transpiler outputs from Babel and TypeScript as well as bundlers like RollupJS.
These reexport and star reexport patterns are restricted to only be detected at the top-level as provided by the direct output of these tools.
For example, `export * from 'external'` is output by Babel as:
```js
"use strict";
exports.__esModule = true;
var _external = require("external");
Object.keys(_external).forEach(function (key) {
if (key === "default" || key === "__esModule") return;
exports[key] = _external[key];
});
```
Where the `var _external = require("external")` is specifically detected as well as the `Object.keys(_external)` statement, down to the exact
for of that entire expression including minor variations of the output. The `_external` and `key` identifiers are carefully matched in this
detection.
Similarly for TypeScript, `export * from 'external'` is output as:
```js
"use strict";
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
Object.defineProperty(exports, "__esModule", { value: true });
__export(require("external"));
```
Where the `__export(require("external"))` statement is explicitly detected as a reexport, including variations `tslib.__export` and `__exportStar`.
### Environment Support
Node.js 10+, and [all browsers with Web Assembly support](https://caniuse.com/#feat=wasm).
### JS Grammar Support
* Token state parses all line comments, block comments, strings, template strings, blocks, parens and punctuators.
* Division operator / regex token ambiguity is handled via backtracking checks against punctuator prefixes, including closing brace or paren backtracking.
* Always correctly parses valid JS source, but may parse invalid JS source without errors.
### Benchmarks
Benchmarks can be run with `npm run bench`.
Current results:
JS Build:
```
Module load time
> 4ms
Cold Run, All Samples
test/samples/*.js (3635 KiB)
> 299ms
Warm Runs (average of 25 runs)
test/samples/angular.js (1410 KiB)
> 13.96ms
test/samples/angular.min.js (303 KiB)
> 4.72ms
test/samples/d3.js (553 KiB)
> 6.76ms
test/samples/d3.min.js (250 KiB)
> 4ms
test/samples/magic-string.js (34 KiB)
> 0.64ms
test/samples/magic-string.min.js (20 KiB)
> 0ms
test/samples/rollup.js (698 KiB)
> 8.48ms
test/samples/rollup.min.js (367 KiB)
> 5.36ms
Warm Runs, All Samples (average of 25 runs)
test/samples/*.js (3635 KiB)
> 40.28ms
```
Wasm Build:
```
Module load time
> 10ms
Cold Run, All Samples
test/samples/*.js (3635 KiB)
> 43ms
Warm Runs (average of 25 runs)
test/samples/angular.js (1410 KiB)
> 9.32ms
test/samples/angular.min.js (303 KiB)
> 3.16ms
test/samples/d3.js (553 KiB)
> 5ms
test/samples/d3.min.js (250 KiB)
> 2.32ms
test/samples/magic-string.js (34 KiB)
> 0.16ms
test/samples/magic-string.min.js (20 KiB)
> 0ms
test/samples/rollup.js (698 KiB)
> 6.28ms
test/samples/rollup.min.js (367 KiB)
> 3.6ms
Warm Runs, All Samples (average of 25 runs)
test/samples/*.js (3635 KiB)
> 27.76ms
```
### Wasm Build Steps
The build uses docker and make, they must be installed first.
To build the lexer wasm run `npm run build-wasm`.
Optimization passes are run with [Binaryen](https://github.com/WebAssembly/binaryen)
prior to publish to reduce the Web Assembly footprint.
After building the lexer wasm, build the final distribution components
(lexer.js and lexer.mjs) by running `npm run build`.
If you need to build lib/lexer.wat (optional) you must first install
[wabt](https://github.com/WebAssembly/wabt) as a sibling folder to this
project. The wat file is then build by running `make lib/lexer.wat`
### License
MIT
[travis-url]: https://travis-ci.org/guybedford/es-module-lexer
[travis-image]: https://travis-ci.org/guybedford/es-module-lexer.svg?branch=master

25
deps/cjs-module-lexer/src/build.js vendored Executable file
View file

@ -0,0 +1,25 @@
const fs = require('fs');
const terser = require('terser');
const MINIFY = true;
try { fs.mkdirSync('./dist'); }
catch (e) {}
const wasmBuffer = fs.readFileSync('./lib/lexer.wasm');
const jsSource = fs.readFileSync('./src/lexer.js').toString();
const pjson = JSON.parse(fs.readFileSync('./package.json').toString());
const jsSourceProcessed = jsSource.replace('WASM_BINARY', wasmBuffer.toString('base64'));
const minified = MINIFY && terser.minify(jsSourceProcessed, {
module: true,
output: {
preamble: `/* cjs-module-lexer ${pjson.version} */`
}
});
if (minified.error)
throw minified.error;
fs.writeFileSync('./dist/lexer.mjs', minified ? minified.code : jsSourceProcessed);

13
deps/cjs-module-lexer/src/build/Makefile vendored Executable file
View file

@ -0,0 +1,13 @@
lib/lexer.wasm: include-wasm/cjs-module-lexer.h src/lexer.c
@mkdir -p lib
clang --sysroot=/usr/share/wasi-sysroot -target wasm32-unknown-wasi src/lexer.c -I include-wasm -o lib/lexer.wasm -nostartfiles \
-Wl,-z,stack-size=13312,--no-entry,--compress-relocations,--strip-all,--export=__heap_base,\
--export=parseCJS,--export=sa,--export=e,--export=re,--export=es,--export=ee,--export=rre,--export=ree,--export=res,--export=ru,--export=us,--export=ue \
-Wno-logical-op-parentheses -Wno-parentheses \
-Oz
optimize: lib/lexer.wasm
${WASM_OPT} -Oz lib/lexer.wasm -o lib/lexer.wasm
clean:
rm lib/*

54
deps/cjs-module-lexer/src/build/wasm.js vendored Normal file
View file

@ -0,0 +1,54 @@
'use strict'
const WASM_BUILDER_CONTAINER = 'ghcr.io/nodejs/wasm-builder@sha256:975f391d907e42a75b8c72eb77c782181e941608687d4d8694c3e9df415a0970' // v0.0.9
const WASM_OPT = './wasm-opt'
const { execSync } = require('node:child_process')
const { writeFileSync, readFileSync, existsSync, mkdirSync } = require('node:fs')
const { join, resolve } = require('node:path')
const ROOT = resolve(__dirname, '../')
let platform = process.env.WASM_PLATFORM
if (!platform && process.argv[2]) {
platform = execSync('docker info -f "{{.OSType}}/{{.Architecture}}"').toString().trim()
}
if (process.argv[2] === '--docker') {
let cmd = `docker run --rm --platform=${platform.toString().trim()} `
if (process.platform === 'linux') {
cmd += ` --user ${process.getuid()}:${process.getegid()}`
}
if (!existsSync(`${ROOT}/dist`)){
mkdirSync(`${ROOT}/dist`);
}
cmd += ` --mount type=bind,source=${ROOT}/lib,target=/home/node/build/lib \
--mount type=bind,source=${ROOT}/src,target=/home/node/build/src \
--mount type=bind,source=${ROOT}/dist,target=/home/node/build/dist \
--mount type=bind,source=${ROOT}/node_modules,target=/home/node/build/node_modules \
--mount type=bind,source=${ROOT}/build/wasm.js,target=/home/node/build/wasm.js \
--mount type=bind,source=${ROOT}/build/Makefile,target=/home/node/build/Makefile \
--mount type=bind,source=${ROOT}/build.js,target=/home/node/build/build.js \
--mount type=bind,source=${ROOT}/package.json,target=/home/node/build/package.json \
--mount type=bind,source=${ROOT}/include-wasm,target=/home/node/build/include-wasm \
-t ${WASM_BUILDER_CONTAINER} node wasm.js`
console.log(`> ${cmd}\n\n`)
execSync(cmd, { stdio: 'inherit' })
process.exit(0)
}
const hasOptimizer = (function () {
try { execSync(`${WASM_OPT} --version`); return true } catch (error) { return false }
})()
// Build wasm binary
console.log('Building wasm');
execSync(`make lib/lexer.wasm`, { stdio: 'inherit' })
if (hasOptimizer) {
console.log('Optimizing wasm');
execSync(`make optimize`, { stdio: 'inherit' })
}
execSync(`node build.js`, { stdio: 'inherit' })

238
deps/cjs-module-lexer/src/include-wasm/cjs-module-lexer.h vendored Executable file
View file

@ -0,0 +1,238 @@
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <limits.h>
#include <string.h>
extern unsigned char __heap_base;
const uint16_t* source = (void*)&__heap_base;
uint32_t parse_error;
struct Slice {
const uint16_t* start;
const uint16_t* end;
struct Slice* next;
};
typedef struct Slice Slice;
struct StarExportBinding {
const uint16_t* specifier_start;
const uint16_t* specifier_end;
const uint16_t* id_start;
const uint16_t* id_end;
};
typedef struct StarExportBinding StarExportBinding;
Slice* first_export = NULL;
Slice* export_read_head = NULL;
Slice* export_write_head = NULL;
Slice* first_reexport = NULL;
Slice* reexport_read_head = NULL;
Slice* reexport_write_head = NULL;
Slice* first_unsafe_getter = NULL;
Slice* unsafe_getter_read_head = NULL;
Slice* unsafe_getter_write_head = NULL;
void* analysis_base;
void* analysis_head;
void bail (uint32_t err);
// allocateSource
const uint16_t* sa (uint32_t utf16Len) {
const uint16_t* sourceEnd = source + utf16Len + 1;
// ensure source is null terminated
*(uint16_t*)(source + utf16Len) = '\0';
analysis_base = (void*)sourceEnd;
analysis_head = analysis_base;
first_export = NULL;
export_write_head = NULL;
export_read_head = NULL;
first_reexport = NULL;
reexport_write_head = NULL;
reexport_read_head = NULL;
first_unsafe_getter = NULL;
unsafe_getter_write_head = NULL;
unsafe_getter_read_head = NULL;
return source;
}
// getErr
uint32_t e () {
return parse_error;
}
// getExportStart
uint32_t es () {
return export_read_head->start - source;
}
// getExportEnd
uint32_t ee () {
return export_read_head->end - source;
}
// getReexportStart
uint32_t res () {
return reexport_read_head->start - source;
}
// getReexportEnd
uint32_t ree () {
return reexport_read_head->end - source;
}
// getUnsafeGetterStart
uint32_t us () {
return unsafe_getter_read_head->start - source;
}
// getUnsafeGetterEnd
uint32_t ue () {
return unsafe_getter_read_head->end - source;
}
// readExport
bool re () {
if (export_read_head == NULL)
export_read_head = first_export;
else
export_read_head = export_read_head->next;
if (export_read_head == NULL)
return false;
return true;
}
// readReexport
bool rre () {
if (reexport_read_head == NULL)
reexport_read_head = first_reexport;
else
reexport_read_head = reexport_read_head->next;
if (reexport_read_head == NULL)
return false;
return true;
}
// readUnsafeGetter
bool ru () {
if (unsafe_getter_read_head == NULL)
unsafe_getter_read_head = first_unsafe_getter;
else
unsafe_getter_read_head = unsafe_getter_read_head->next;
if (unsafe_getter_read_head == NULL)
return false;
return true;
}
void _addExport (const uint16_t* start, const uint16_t* end) {
Slice* export = (Slice*)(analysis_head);
analysis_head = analysis_head + sizeof(Slice);
if (export_write_head == NULL)
first_export = export;
else
export_write_head->next = export;
export_write_head = export;
export->start = start;
export->end = end;
export->next = NULL;
}
void _addReexport (const uint16_t* start, const uint16_t* end) {
Slice* reexport = (Slice*)(analysis_head);
analysis_head = analysis_head + sizeof(Slice);
if (reexport_write_head == NULL)
first_reexport = reexport;
else
reexport_write_head->next = reexport;
reexport_write_head = reexport;
reexport->start = start;
reexport->end = end;
reexport->next = NULL;
}
void _addUnsafeGetter (const uint16_t* start, const uint16_t* end) {
Slice* unsafe_getter = (Slice*)(analysis_head);
analysis_head = analysis_head + sizeof(Slice);
if (unsafe_getter_write_head == NULL)
first_unsafe_getter = unsafe_getter;
else
unsafe_getter_write_head->next = unsafe_getter;
unsafe_getter_write_head = unsafe_getter;
unsafe_getter->start = start;
unsafe_getter->end = end;
unsafe_getter->next = NULL;
}
void _clearReexports () {
reexport_write_head = NULL;
first_reexport = NULL;
}
void (*addExport)(const uint16_t*, const uint16_t*) = &_addExport;
void (*addReexport)(const uint16_t*, const uint16_t*) = &_addReexport;
void (*addUnsafeGetter)(const uint16_t*, const uint16_t*) = &_addUnsafeGetter;
void (*clearReexports)() = &_clearReexports;
uint32_t parseCJS (uint16_t* source, uint32_t sourceLen, void (*addExport)(const uint16_t* start, const uint16_t* end), void (*addReexport)(const uint16_t* start, const uint16_t* end), void (*addUnsafeGetter)(const uint16_t*, const uint16_t*), void (*clearReexports)());
enum RequireType {
Import,
ExportAssign,
ExportStar
};
void tryBacktrackAddStarExportBinding (uint16_t* pos);
bool tryParseRequire (enum RequireType requireType);
void tryParseLiteralExports ();
bool readExportsOrModuleDotExports (uint16_t ch);
void tryParseModuleExportsDotAssign ();
void tryParseExportsDotAssign (bool assign);
void tryParseObjectDefineOrKeys (bool keys);
bool identifier (uint16_t ch);
void throwIfImportStatement ();
void throwIfExportStatement ();
void readImportString (const uint16_t* ss, uint16_t ch);
uint16_t readExportAs (uint16_t* startPos, uint16_t* endPos);
uint16_t commentWhitespace ();
void stringLiteral (uint16_t quote);
void regularExpression ();
void templateString ();
void blockComment ();
void lineComment ();
uint16_t readToWsOrPunctuator (uint16_t ch);
uint32_t fullCharCode (uint16_t ch);
uint32_t fullCharCodeAtLast (uint16_t* pos);
bool isIdentifierStart (uint32_t code);
bool isIdentifierChar (uint32_t code);
int charCodeByteLen (uint32_t ch);
bool isBr (uint16_t c);
bool isBrOrWs (uint16_t c);
bool isBrOrWsOrPunctuator (uint16_t c);
bool isBrOrWsOrPunctuatorNotDot (uint16_t c);
bool str_eq2 (uint16_t* pos, uint16_t c1, uint16_t c2);
bool str_eq3 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3);
bool str_eq4 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4);
bool str_eq5 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5);
bool str_eq6 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6);
bool str_eq7 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7);
bool str_eq8 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7, uint16_t c8);
bool str_eq9 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7, uint16_t c8, uint16_t c9);
bool str_eq10 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7, uint16_t c8, uint16_t c9, uint16_t c10);
bool str_eq13 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7, uint16_t c8, uint16_t c9, uint16_t c10, uint16_t c11, uint16_t c12, uint16_t c13);
bool str_eq18 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7, uint16_t c8, uint16_t c9, uint16_t c10, uint16_t c11, uint16_t c12, uint16_t c13, uint16_t c14, uint16_t c15, uint16_t c16, uint16_t c17, uint16_t c18);
bool str_eq22 (uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7, uint16_t c8, uint16_t c9, uint16_t c10, uint16_t c11, uint16_t c12, uint16_t c13, uint16_t c14, uint16_t c15, uint16_t c16, uint16_t c17, uint16_t c18, uint16_t c19, uint16_t c20, uint16_t c21, uint16_t c22);
bool readPrecedingKeyword2(uint16_t* pos, uint16_t c1, uint16_t c2);
bool readPrecedingKeyword3(uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3);
bool readPrecedingKeyword4(uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4);
bool readPrecedingKeyword5(uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5);
bool readPrecedingKeyword6(uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6);
bool readPrecedingKeyword7(uint16_t* pos, uint16_t c1, uint16_t c2, uint16_t c3, uint16_t c4, uint16_t c5, uint16_t c6, uint16_t c7);
bool keywordStart (uint16_t* pos);
bool isExpressionKeyword (uint16_t* pos);
bool isParenKeyword (uint16_t* pos);
bool isPunctuator (uint16_t charCode);
bool isExpressionPunctuator (uint16_t charCode);
bool isExpressionTerminator (uint16_t* pos);
void nextChar (uint16_t ch);
void nextCharSurrogate (uint16_t ch);
uint16_t readChar ();
void syntaxError (uint32_t code);

1
deps/cjs-module-lexer/src/lexer.d.mts vendored Normal file
View file

@ -0,0 +1 @@
export * from './lexer.js'

16
deps/cjs-module-lexer/lexer.d.ts → deps/cjs-module-lexer/src/lexer.d.ts vendored Normal file → Executable file
View file

@ -1,8 +1,8 @@
export interface Exports { export interface Exports {
exports: string[]; exports: string[];
reexports: string[]; reexports: string[];
} }
export declare function parse(source: string, name?: string): Exports; export declare function parse(source: string, name?: string): Exports;
export declare function init(): Promise<void>; export declare function init(): Promise<void>;
export declare function initSync(): void; export declare function initSync(): void;

1443
deps/cjs-module-lexer/src/lexer.js vendored Executable file
View file

File diff suppressed because it is too large Load diff

BIN
deps/cjs-module-lexer/src/lib/lexer.wasm vendored Executable file
View file

Binary file not shown.

1901
deps/cjs-module-lexer/src/package-lock.json generated vendored Normal file
View file

File diff suppressed because it is too large Load diff

96
deps/cjs-module-lexer/package.json → deps/cjs-module-lexer/src/package.json vendored Normal file → Executable file
View file

@ -1,48 +1,48 @@
{ {
"name": "cjs-module-lexer", "name": "cjs-module-lexer",
"version": "1.4.1", "version": "2.0.0",
"description": "Lexes CommonJS modules, returning their named exports metadata", "description": "Lexes CommonJS modules, returning their named exports metadata",
"main": "lexer.js", "main": "lexer.js",
"exports": { "exports": {
"import": { "import": {
"types": "./lexer.d.mts", "types": "./lexer.d.mts",
"default": "./dist/lexer.mjs" "default": "./dist/lexer.mjs"
}, },
"default": "./lexer.js" "default": "./lexer.js"
}, },
"types": "lexer.d.ts", "types": "lexer.d.ts",
"scripts": { "scripts": {
"test-js": "mocha -b -u tdd test/*.js", "test-js": "mocha -b -u tdd test/*.js",
"test-wasm": "cross-env WASM=1 mocha -b -u tdd test/*.js", "test-wasm": "cross-env WASM=1 mocha -b -u tdd test/*.js",
"test-wasm-sync": "cross-env WASM_SYNC=1 mocha -b -u tdd test/*.js", "test-wasm-sync": "cross-env WASM_SYNC=1 mocha -b -u tdd test/*.js",
"test": "npm run test-wasm ; npm run test-wasm-sync ; npm run test-js", "test": "npm run test-wasm ; npm run test-wasm-sync ; npm run test-js",
"bench": "node --expose-gc bench/index.mjs", "bench": "node --expose-gc bench/index.mjs",
"build": "node build.js ; babel dist/lexer.mjs -o dist/lexer.js ; terser dist/lexer.js -o dist/lexer.js", "build": "node build.js ; babel dist/lexer.mjs -o dist/lexer.js ; terser dist/lexer.js -o dist/lexer.js",
"build-wasm": "make lib/lexer.wasm ; node build.js", "build-wasm": "make lib/lexer.wasm ; node build.js",
"prepublishOnly": "make && npm run build", "prepublishOnly": "make && npm run build",
"footprint": "npm run build && cat dist/lexer.js | gzip -9f | wc -c" "footprint": "npm run build && cat dist/lexer.js | gzip -9f | wc -c"
}, },
"author": "Guy Bedford", "author": "Guy Bedford",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
"@babel/cli": "^7.5.5", "@babel/cli": "^7.5.5",
"@babel/core": "^7.5.5", "@babel/core": "^7.5.5",
"@babel/plugin-transform-modules-commonjs": "^7.5.0", "@babel/plugin-transform-modules-commonjs": "^7.5.0",
"cross-env": "^7.0.3", "cross-env": "^7.0.3",
"kleur": "^2.0.2", "kleur": "^2.0.2",
"mocha": "^9.1.3", "mocha": "^9.1.3",
"terser": "^4.1.4" "terser": "^4.1.4"
}, },
"files": [ "files": [
"dist", "dist",
"lexer.d.ts" "lexer.d.ts"
], ],
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/nodejs/cjs-module-lexer.git" "url": "git+https://github.com/nodejs/cjs-module-lexer.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/nodejs/cjs-module-lexer/issues" "url": "https://github.com/nodejs/cjs-module-lexer/issues"
}, },
"homepage": "https://github.com/nodejs/cjs-module-lexer#readme" "homepage": "https://github.com/nodejs/cjs-module-lexer#readme"
} }

1516
deps/cjs-module-lexer/src/src/lexer.c vendored Executable file
View file

File diff suppressed because one or more lines are too long

223
deps/cjs-module-lexer/dist/lexer-external.mjs → deps/cjs-module-lexer/src/src/lexer.js vendored Normal file → Executable file
View file

@ -1,104 +1,119 @@
let wasm; let wasm;
const isLE = new Uint8Array(new Uint16Array([1]).buffer)[0] === 1; const isLE = new Uint8Array(new Uint16Array([1]).buffer)[0] === 1;
export function parse (source, name = '@') { export function parse (source, name = '@') {
if (!wasm) if (!wasm)
throw new Error('Not initialized'); throw new Error('Not initialized');
const len = source.length + 1; const len = source.length + 1;
// need 2 bytes per code point plus analysis space so we double again // need 2 bytes per code point plus analysis space so we double again
const extraMem = (wasm.__heap_base.value || wasm.__heap_base) + len * 4 - wasm.memory.buffer.byteLength; const extraMem = (wasm.__heap_base.value || wasm.__heap_base) + len * 4 - wasm.memory.buffer.byteLength;
if (extraMem > 0) if (extraMem > 0)
wasm.memory.grow(Math.ceil(extraMem / 65536)); wasm.memory.grow(Math.ceil(extraMem / 65536));
const addr = wasm.sa(len); const addr = wasm.sa(len);
(isLE ? copyLE : copyBE)(source, new Uint16Array(wasm.memory.buffer, addr, len)); (isLE ? copyLE : copyBE)(source, new Uint16Array(wasm.memory.buffer, addr, len));
const err_code = wasm.parseCJS(addr, source.length, 0, 0, 0); const err_code = wasm.parseCJS(addr, source.length, 0, 0, 0);
if (err_code) { if (err_code) {
const err = new Error(`Parse error ${name}${wasm.e()}:${source.slice(0, wasm.e()).split('\n').length}:${wasm.e() - source.lastIndexOf('\n', wasm.e() - 1)}`); const err = new Error(`Parse error ${name}${wasm.e()}:${source.slice(0, wasm.e()).split('\n').length}:${wasm.e() - source.lastIndexOf('\n', wasm.e() - 1)}`);
Object.assign(err, { idx: wasm.e() }); Object.assign(err, { idx: wasm.e() });
if (err_code === 5 || err_code === 6 || err_code === 7) if (err_code === 5 || err_code === 6 || err_code === 7)
Object.assign(err, { code: 'ERR_LEXER_ESM_SYNTAX' }); Object.assign(err, { code: 'ERR_LEXER_ESM_SYNTAX' });
throw err; throw err;
} }
let exports = new Set(), reexports = new Set(), unsafeGetters = new Set(); let exports = new Set(), reexports = new Set(), unsafeGetters = new Set();
while (wasm.rre()) { while (wasm.rre()) {
const reexptStr = decode(source.slice(wasm.res(), wasm.ree())); const reexptStr = decode(source.slice(wasm.res(), wasm.ree()));
if (reexptStr) if (reexptStr)
reexports.add(reexptStr); reexports.add(reexptStr);
} }
while (wasm.ru()) while (wasm.ru())
unsafeGetters.add(decode(source.slice(wasm.us(), wasm.ue()))); unsafeGetters.add(decode(source.slice(wasm.us(), wasm.ue())));
while (wasm.re()) { while (wasm.re()) {
let exptStr = decode(source.slice(wasm.es(), wasm.ee())); let exptStr = decode(source.slice(wasm.es(), wasm.ee()));
if (exptStr !== undefined && !unsafeGetters.has(exptStr)) if (exptStr !== undefined && !unsafeGetters.has(exptStr))
exports.add(exptStr); exports.add(exptStr);
} }
return { exports: [...exports], reexports: [...reexports] }; return { exports: [...exports], reexports: [...reexports] };
} }
function decode (str) { function decode (str) {
if (str[0] === '"' || str[0] === '\'') { if (str[0] === '"' || str[0] === '\'') {
try { try {
const decoded = (0, eval)(str); const decoded = (0, eval)(str);
// Filter to exclude non-matching UTF-16 surrogate strings // Filter to exclude non-matching UTF-16 surrogate strings
for (let i = 0; i < decoded.length; i++) { for (let i = 0; i < decoded.length; i++) {
const surrogatePrefix = decoded.charCodeAt(i) & 0xFC00; const surrogatePrefix = decoded.charCodeAt(i) & 0xFC00;
if (surrogatePrefix < 0xD800) { if (surrogatePrefix < 0xD800) {
// Not a surrogate // Not a surrogate
continue; continue;
} }
else if (surrogatePrefix === 0xD800) { else if (surrogatePrefix === 0xD800) {
// Validate surrogate pair // Validate surrogate pair
if ((decoded.charCodeAt(++i) & 0xFC00) !== 0xDC00) if ((decoded.charCodeAt(++i) & 0xFC00) !== 0xDC00)
return; return;
} }
else { else {
// Out-of-range surrogate code (above 0xD800) // Out-of-range surrogate code (above 0xD800)
return; return;
} }
} }
return decoded; return decoded;
} }
catch {} catch {}
} }
else { else {
return str; return str;
} }
} }
function copyBE (src, outBuf16) { function copyBE (src, outBuf16) {
const len = src.length; const len = src.length;
let i = 0; let i = 0;
while (i < len) { while (i < len) {
const ch = src.charCodeAt(i); const ch = src.charCodeAt(i);
outBuf16[i++] = (ch & 0xff) << 8 | ch >>> 8; outBuf16[i++] = (ch & 0xff) << 8 | ch >>> 8;
} }
} }
function copyLE (src, outBuf16) { function copyLE (src, outBuf16) {
const len = src.length; const len = src.length;
let i = 0; let i = 0;
while (i < len) while (i < len)
outBuf16[i] = src.charCodeAt(i++); outBuf16[i] = src.charCodeAt(i++);
} }
let initPromise; function getWasmBytes() {
export function init () { const binary = 'WASM_BINARY'; // This string will be replaced by build.js.
if (initPromise) if (typeof Buffer !== 'undefined')
return initPromise; return Buffer.from(binary, 'base64');
return initPromise = (async () => { return Uint8Array.from(atob(binary), x => x.charCodeAt(0));
const compiled = await WebAssembly.compile( }
(await import('node:fs')).readFileSync(new URL(import.meta.resolve('../lib/lexer.wasm')))
); let initPromise;
const { exports } = await WebAssembly.instantiate(compiled); export function init () {
wasm = exports; if (initPromise)
})(); return initPromise;
} return initPromise = (async () => {
const compiled = await WebAssembly.compile(getWasmBytes());
const { exports } = await WebAssembly.instantiate(compiled);
wasm = exports;
})();
}
export function initSync () {
if (wasm) {
return;
}
const compiled = new WebAssembly.Module(getWasmBytes());
const { exports } = new WebAssembly.Instance(compiled);
wasm = exports;
return;
}

2
doc/api/esm.md
View file

@ -1144,7 +1144,7 @@ resolution for ESM specifiers is [commonjs-extension-resolution-loader][].
[`process.dlopen`]: process.md#processdlopenmodule-filename-flags [`process.dlopen`]: process.md#processdlopenmodule-filename-flags
[`require(esm)`]: modules.md#loading-ecmascript-modules-using-require [`require(esm)`]: modules.md#loading-ecmascript-modules-using-require
[`url.fileURLToPath()`]: url.md#urlfileurltopathurl-options [`url.fileURLToPath()`]: url.md#urlfileurltopathurl-options
[cjs-module-lexer]: https://github.com/nodejs/cjs-module-lexer/tree/1.2.2 [cjs-module-lexer]: https://github.com/nodejs/cjs-module-lexer/tree/2.0.0
[commonjs-extension-resolution-loader]: https://github.com/nodejs/loaders-test/tree/main/commonjs-extension-resolution-loader [commonjs-extension-resolution-loader]: https://github.com/nodejs/loaders-test/tree/main/commonjs-extension-resolution-loader
[custom https loader]: module.md#import-from-https [custom https loader]: module.md#import-from-https
[import.meta.resolve]: #importmetaresolvespecifier [import.meta.resolve]: #importmetaresolvespecifier

2
src/cjs_module_lexer_version.h
View file

@ -2,5 +2,5 @@
// Refer to tools/dep_updaters/update-cjs-module-lexer.sh // Refer to tools/dep_updaters/update-cjs-module-lexer.sh
#ifndef SRC_CJS_MODULE_LEXER_VERSION_H_ #ifndef SRC_CJS_MODULE_LEXER_VERSION_H_
#define SRC_CJS_MODULE_LEXER_VERSION_H_ #define SRC_CJS_MODULE_LEXER_VERSION_H_
#define CJS_MODULE_LEXER_VERSION "1.4.1" #define CJS_MODULE_LEXER_VERSION "2.0.0"
#endif // SRC_CJS_MODULE_LEXER_VERSION_H_ #endif // SRC_CJS_MODULE_LEXER_VERSION_H_

2
test/parallel/test-process-versions.js
View file

@ -4,7 +4,7 @@ const assert = require('assert');
// Import of pure js (non-shared) deps for comparison // Import of pure js (non-shared) deps for comparison
const acorn = require('../../deps/acorn/acorn/package.json'); const acorn = require('../../deps/acorn/acorn/package.json');
const cjs_module_lexer = require('../../deps/cjs-module-lexer/package.json'); const cjs_module_lexer = require('../../deps/cjs-module-lexer/src/package.json');
const expected_keys = [ const expected_keys = [
'ares', 'ares',

49
tools/dep_updaters/update-cjs-module-lexer.sh
View file

@ -27,7 +27,8 @@ console.log(name);
EOF EOF
)" )"
CURRENT_VERSION=$("$NODE" -p "require('./deps/cjs-module-lexer/package.json').version")
CURRENT_VERSION=$("$NODE" -p "require('./deps/cjs-module-lexer/src/package.json').version")
# This function exit with 0 if new version and current version are the same # This function exit with 0 if new version and current version are the same
compare_dependency_version "cjs-module-lexer" "$NEW_VERSION" "$CURRENT_VERSION" compare_dependency_version "cjs-module-lexer" "$NEW_VERSION" "$CURRENT_VERSION"
@ -44,15 +45,53 @@ cleanup () {
trap cleanup INT TERM EXIT trap cleanup INT TERM EXIT
CJS_MODULE_LEXER_ZIP="cjs-module-lexer-$NEW_VERSION"
# remove existing source and built files
rm -rf "$DEPS_DIR/cjs-module-lexer/src"
rm -rf "$DEPS_DIR/cjs-module-lexer/dist"
rm "$DEPS_DIR/cjs-module-lexer/lexer.js"
cd "$WORKSPACE" cd "$WORKSPACE"
"$NODE" "$NPM" init --yes curl -sL -o "$CJS_MODULE_LEXER_ZIP.zip" "https://github.com/nodejs/cjs-module-lexer/archive/refs/tags/$NEW_VERSION.zip"
"$NODE" "$NPM" install --global-style --no-bin-links --ignore-scripts "cjs-module-lexer@$NEW_VERSION" log_and_verify_sha256sum "cjs-module-lexer" "$CJS_MODULE_LEXER_ZIP.zip"
rm -rf "$DEPS_DIR/cjs-module-lexer" echo "Unzipping..."
unzip "$CJS_MODULE_LEXER_ZIP.zip" -d "src"
mv "src/$CJS_MODULE_LEXER_ZIP" "$DEPS_DIR/cjs-module-lexer/src"
rm "$CJS_MODULE_LEXER_ZIP.zip"
cd "$ROOT"
mv node_modules/cjs-module-lexer "$DEPS_DIR/cjs-module-lexer" (
# remove components we don't need to keep in nodejs/deps
# these are files that we don't need to build from source
cd "$DEPS_DIR/cjs-module-lexer/src"
rm -rf bench
rm -rf .github || true
rm -rf test
rm .gitignore
rm .travis.yml
rm CODE_OF_CONDUCT.md
rm CONTRIBUTING.md
# Rebuild components from source
rm lib/*.*
"$NODE" "$NPM" install --ignore-scripts
"$NODE" "$NPM" run build-wasm
"$NODE" "$NPM" run build
"$NODE" "$NPM" prune --production
# remove files we don't need in Node.js
rm -rf node_modules
# copy over the built files to the expected locations
mv dist ..
cp lexer.js ..
cp LICENSE ..
cp README.md ..
)
# update cjs_module_lexer_version.h # update cjs_module_lexer_version.h
cat > "$BASE_DIR/src/cjs_module_lexer_version.h" << EOL cat > "$BASE_DIR/src/cjs_module_lexer_version.h" << EOL