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

doc: introduction #54

Closed
wants to merge 2 commits into
base: modules-lkgr
from

Conversation

Projects
None yet
5 participants
@evanplaice
Copy link
Contributor

evanplaice commented Mar 9, 2019

This PR includes the Introduction section for ESM including links to the MDN documentation for import and export.

Readable Version:

@evanplaice

This comment has been minimized.

Copy link
Contributor Author

evanplaice commented Mar 9, 2019

Kept it short, sweet, and noncontroversial as possible. Feedback welcome.

@evanplaice evanplaice force-pushed the docs-intro branch from 2b7bc4b to f28f3dc Mar 9, 2019

Show resolved Hide resolved doc/api/esm.md Outdated

ECMAScript modules are the official standard format to package Javascript code for reuse. Modules are defined using a variety of [import][] and [export][] statements.

Node fully supports the format as it is currently specified, as well as provides limited compatibility with the existing module (CommonJS) format.

This comment has been minimized.

@devsnek

devsnek Mar 9, 2019

Member
Suggested change
Node fully supports the format as it is currently specified, as well as provides limited compatibility with the existing module (CommonJS) format.
Node.js fully supports ECMAScript modules as they are currently specified and provides limited interoperability between them and the existing module format, CommonJS.

you should also change the commonjs to a link

This comment has been minimized.

@evanplaice

evanplaice Mar 9, 2019

Author Contributor

Fixed. The CommonJS link points to the modules doc.

This comment has been minimized.

@GeoffreyBooth

GeoffreyBooth Mar 9, 2019

Contributor

@devsnek Are all of your concerns addressed?

Show resolved Hide resolved doc/api/esm.md Outdated

@evanplaice evanplaice force-pushed the docs-intro branch from f28f3dc to d88fdc3 Mar 9, 2019

Show resolved Hide resolved doc/api/esm.md
Show resolved Hide resolved doc/api/esm.md

@MylesBorins MylesBorins force-pushed the modules-lkgr branch from bec588f to ea59221 Mar 11, 2019

@nodejs-ci nodejs-ci force-pushed the modules-lkgr branch 2 times, most recently from c6d1b01 to b4abd3a Mar 12, 2019

evanplaice added some commits Mar 9, 2019

@MylesBorins MylesBorins force-pushed the docs-intro branch from 9189574 to 61cfca0 Mar 13, 2019

@MylesBorins
Copy link
Member

MylesBorins left a comment

LGTM with a tiny nit

@@ -5,6 +5,12 @@

> Stability: 1 - Experimental
## Introduction

ECMAScript modules are the official standard format to package JavaScript code for reuse. Modules are defined using a variety of [`import`][] and [`export`][] statements.

This comment has been minimized.

@MylesBorins

MylesBorins Mar 13, 2019

Member
Suggested change
ECMAScript modules are the official standard format to package JavaScript code for reuse. Modules are defined using a variety of [`import`][] and [`export`][] statements.
ECMAScript modules are the standard format to package JavaScript code for reuse. Modules are defined using a variety of [`import`][] and [`export`][] statements.
@MylesBorins

This comment has been minimized.

Copy link
Member

MylesBorins commented Mar 13, 2019

@devsnek do you still have any objections?

stale

@MylesBorins

This comment has been minimized.

Copy link
Member

MylesBorins commented Mar 13, 2019

landed in 0a47098

@ljharb ljharb deleted the docs-intro branch Mar 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.