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.

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: clarify extensionless esm #30657

Closed
wants to merge 5 commits into from
Closed

doc: clarify extensionless esm #30657

wants to merge 5 commits into from

Conversation

azz
Copy link
Contributor

@azz azz commented Nov 26, 2019

Fixes #30655

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 26, 2019
MylesBorins
MylesBorins requested changes Nov 27, 2019
View reviewed changes
Copy link
Member

@MylesBorins MylesBorins left a comment

Choose a reason for hiding this comment

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

I don't think we should be documenting using a non-standard flag here in the docs... but we could improve the documentation above to make the difference between extensionless file path (path has no extension) and extensionless specifiers (path has extension, specifier doesn't, node resolves extension) clearer

doc/api/esm.md Outdated
@@ -92,6 +92,9 @@ if the nearest parent `package.json` contains `"type": "module"`.
```js
// my-app.js, part of the same example as above
import './startup.js'; // Loaded as ES module because of package.json

// Extensionless. Requires 'node --es-module-specifier-resolution=node'
import './startup'; // Loaded as ES module because of package.json
Copy link
Member

Choose a reason for hiding this comment

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

Extensionless files, as documented above, are different from extensionless specifiers (which you are documenting here). Extensionless files mean the file path itself has no extension e.g. /path/to/file, not the specifier e.g. './file' where path is /path/to/file.js.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah I see. Yeah it could definitely be clarified.

Copy link
Member

Choose a reason for hiding this comment

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

Would you be ok removing this line and instead clarifying above?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Had trouble writing it succinctly so let me know if it makes sense.

@MylesBorins MylesBorins added the esm Issues and PRs related to the ECMAScript Modules implementation. label Nov 27, 2019
@azz
Copy link
Contributor Author

azz commented Nov 27, 2019

I don't think we should be documenting using a non-standard flag here

What do you mean by "non-standard flag"?

@MylesBorins
Copy link
Member

@azz it is an experimental flag, not an agreed upon official feature. Not having it labelled experimental was actually an oversight.

I'm actually working on making that clearer in #30678

@azz azz changed the title doc: clarify required flag for extensionless esm doc: clarify extensionless esm Dec 3, 2019
MylesBorins
MylesBorins approved these changes Dec 4, 2019
View reviewed changes
Copy link
Member

@MylesBorins MylesBorins left a comment

Choose a reason for hiding this comment

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

Took a quick stab at some slightly different text, unsure if it is better. Happy to see this land with the suggested changes ignore or landed.

doc/api/esm.md Outdated Show resolved Hide resolved
doc/api/esm.md Outdated Show resolved Hide resolved
azz and others added 2 commits December 5, 2019 18:03
@azz @MylesBorins
doc: reword extensionless definition
bb49307 
Co-Authored-By: Myles Borins <myles.borins@gmail.com>
@azz @MylesBorins
doc: reword clarification
e05c651 
Co-Authored-By: Myles Borins <myles.borins@gmail.com>
MylesBorins
MylesBorins reviewed Dec 16, 2019
View reviewed changes
doc/api/esm.md Outdated Show resolved Hide resolved
@azz @MylesBorins
doc: remove "note that"
ff75ccb 
Co-Authored-By: Myles Borins <myles.borins@gmail.com>
@juanarbol
Copy link
Member

I don't know if is necessary, but in #30699, CJS module will give suggestions when file extension is not provided, maybe it would be nice in this docs.

MylesBorins pushed a commit that referenced this pull request Dec 18, 2019
@azz @MylesBorins
doc: clarify required flag for extensionless esm
3e5967b 
Fixes: #30655

PR-URL: #30657
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@MylesBorins
Copy link
Member

Landed in 3e5967b

@juanarbol I think documenting #30699 is a great idea, but should likely happen in that PR (so we don't land the docs before the change is landed)

BridgeAR pushed a commit that referenced this pull request Jan 3, 2020
@azz @BridgeAR
doc: clarify required flag for extensionless esm
a386114 
Fixes: #30655

PR-URL: #30657
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Jan 7, 2020
Merged
MylesBorins pushed a commit that referenced this pull request Jan 12, 2020
@azz @MylesBorins
doc: clarify required flag for extensionless esm
c6b6e3f 
Fixes: #30655

PR-URL: #30657
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@targos targos mentioned this pull request Jan 15, 2020
Closed
BethGriggs pushed a commit that referenced this pull request Feb 6, 2020
@azz @BethGriggs
doc: clarify required flag for extensionless esm
2cbb358 
Fixes: #30655

PR-URL: #30657
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Feb 8, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MylesBorins MylesBorins MylesBorins approved these changes

@yorkie yorkie yorkie approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. esm Issues and PRs related to the ECMAScript Modules implementation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

doc: confusing support for extensionless ESM
5 participants
@azz @MylesBorins @juanarbol @yorkie @nodejs-github-bot