Skip to content
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

Jump to bottom

doc: add spec for contains module syntax #52059

Merged
merged 2 commits into from
Mar 20, 2024
Merged

doc: add spec for contains module syntax #52059

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f06e855
doc: add spec for contains module syntax
GeoffreyBooth Mar 12, 2024
931460f
invert
GeoffreyBooth Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 17 additions & 2 deletions doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,8 +1086,8 @@ _isImports_, _conditions_)
> 10. If _url_ ends in _".js"_, then
> 1. If _packageType_ is not **null**, then
> 1. Return _packageType_.
> 2. If `--experimental-detect-module` is enabled and the source of
> module contains static import or export syntax, then
> 2. If `--experimental-detect-module` is enabled and the result of
> **CONTAINS\_MODULE\_SYNTAX**(_source_) is true, then
> 1. Return _"module"_.
> 3. Return _"commonjs"_.
> 11. If _url_ does not have any extension, then
Expand Down Expand Up @@ -1124,6 +1124,21 @@ _isImports_, _conditions_)
> 1. Throw an _Invalid Package Configuration_ error.
> 4. Return the parsed JSON source of the file at _pjsonURL_.

**CONTAINS\_MODULE\_SYNTAX**(_source_)
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps DETECT_MODULE_SYNTAX to capture that this is the "detection path".


> 1. Parse _source_ as a CommonJS module.
> 2. If the parse is successful, return **false**.
> 3. Else inspect the error message thrown. Return **true** if it is a syntax
> error thrown by any of the following:
> * `import` statement (static only, _not_ dynamic `import()`)
> * `export` statement
> * `import.meta`
> * `await` at the top level
> * A lexical redeclaration of any of the CommonJS wrapper variables
> (`require`, `exports`, `module`, `__filename`, `__dirname`) at the top
> level
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
> * `import` statement (static only, _not_ dynamic `import()`)
> * `export` statement
> * `import.meta`
> * `await` at the top level
> * A lexical redeclaration of any of the CommonJS wrapper variables
> (`require`, `exports`, `module`, `__filename`, `__dirname`) at the top
> level
> * A static `import` statement.
> * An `export` statement.
> * Usage of the `import.meta` meta property.
> * An `await` expression at the top level.
> * A lexical redeclaration of any of the CommonJS wrapper variables
> (`require`, `exports`, `module`, `__filename`, `__dirname`) at the top
> level.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it's important to clarify that this is only for import statements and not expressions.

Copy link
Contributor

Choose a reason for hiding this comment

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

Note that [[HasTLA]] is already an ECMAScript module field - https://tc39.es/ecma262/#sec-cyclic-module-records.

> 4. Else return **false**.

### Customizing ESM specifier resolution algorithm

[Module customization hooks][] provide a mechanism for customizing the ESM
Expand Down