Skip to content
This repository was archived by the owner on Apr 16, 2020. It is now read-only.

doc: introduction #54

Closed
wants to merge 2 commits into from
Closed

doc: introduction #54

wants to merge 2 commits into from

Conversation

evanplaice
Copy link

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

Readable Version:

@evanplaice
Copy link
Author

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

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.
Copy link
Member

@devsnek devsnek Mar 9, 2019

Choose a reason for hiding this comment

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

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

Copy link
Author

Choose a reason for hiding this comment

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

Fixed. The CommonJS link points to the modules doc.

Copy link
Member

Choose a reason for hiding this comment

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

@devsnek Are all of your concerns addressed?

devsnek
devsnek previously requested changes Mar 9, 2019
@nodejs-ci nodejs-ci force-pushed the modules-lkgr branch 2 times, most recently from c6d1b01 to b4abd3a Compare March 13, 2019 08:06
Copy link
Contributor

@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.

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.
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
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
Copy link
Contributor

@devsnek do you still have any objections?

@devsnek devsnek dismissed their stale review March 13, 2019 15:30

stale

@MylesBorins
Copy link
Contributor

landed in 0a47098

@ljharb ljharb deleted the docs-intro branch March 13, 2019 20:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants