Skip to content

esm: source hooks #30986

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

Closed
GeoffreyBooth wants to merge 16 commits into from
Closed

esm: source hooks #30986

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d55bf00
module: add esm loader hook for transforming source
GeoffreyBooth Dec 15, 2019
44ffec6
module: add esm loader hook for getting source
GeoffreyBooth Dec 15, 2019
5c925a0
module: new hooks apply to all relevant translators
GeoffreyBooth Dec 16, 2019
11296b8
module: more prominent warnings about future changes
GeoffreyBooth Dec 16, 2019
23743bf
module: extract getFormat hook
bfarias-godaddy Dec 18, 2019
88e6e64
module: don't need parent in unknown file extension error
GeoffreyBooth Jan 2, 2020
3171408
module: standardize signatures for hooks; recurse
GeoffreyBooth Jan 2, 2020
d1b149a
module: all esm hooks use options object as signature
GeoffreyBooth Jan 3, 2020
348bfec
module: getFormat should be called outside of resolve
GeoffreyBooth Jan 3, 2020
21e28cb
module: all esm hooks should return objects
GeoffreyBooth Jan 3, 2020
66ad43f
module: update docs
GeoffreyBooth Jan 3, 2020
20dd0e3
module: change hook signatures
GeoffreyBooth Jan 4, 2020
dc34757
module: split getFormat into its own file
GeoffreyBooth Jan 4, 2020
564b551
module: move source hooks into their own files
GeoffreyBooth Jan 4, 2020
bba0814
module: don't destructure in examples
GeoffreyBooth Jan 5, 2020
b1b2df4
module: reorganize hooks docs, improve examples
GeoffreyBooth Jan 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
module: don't destructure in examples
  • Loading branch information
@GeoffreyBooth
GeoffreyBooth committed Jan 5, 2020
commit bba0814284eb6a539a7120ef1f4788e04cd35eac
41 changes: 20 additions & 21 deletions doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,7 +1012,9 @@ CommonJS modules loaded.
> signature may change. Do not rely on the API described below.

The `resolve` hook returns the resolved file URL for a given module specifier
and parent file URL:
and parent URL. The module specifier is the string in an `import` statement or
`import()` expression, and the parent URL is the URL of the module that imported
this one, or `undefined` if this is the main entry point for the application.

```js
import { URL, pathToFileURL } from 'url';
Expand All @@ -1026,9 +1028,8 @@ const baseURL = pathToFileURL(process.cwd()).href;
* @returns {object} response
* @returns {string} response.url
*/
export async function resolve(specifier,
{ parentURL = baseURL },
defaultResolve) {
export async function resolve(specifier, context, defaultResolve) {
const { parentURL = baseURL } = context;
return {
url: new URL(specifier, parentUrl).href
};
Expand Down Expand Up @@ -1064,17 +1065,16 @@ const baseURL = pathToFileURL(process.cwd()).href;
* @returns {object} response
* @returns {string} response.url
*/
export async function resolve(specifier,
{ parentURL = baseURL },
defaultResolve) {
export async function resolve(specifier, context, defaultResolve) {
const { parentURL = baseURL } = context;
if (builtins.includes(specifier)) {
return {
url: specifier
};
}
if (/^\.{0,2}[/]/.test(specifier) !== true && !specifier.startsWith('file:')) {
// For node_modules support:
// return defaultResolve(specifier, parentURL);
// return defaultResolve(specifier, context, defaultResolve);
throw new Error(
`imports must begin with '/', './', or '../'; '${specifier}' does not`);
}
Expand Down Expand Up @@ -1156,7 +1156,7 @@ the source code of an ES module specifier. This would allow a loader to
potentially avoid reading files from disk.

```js
import { get } from 'https';
import { request } from 'https';

/**
* @param {string} url
Expand All @@ -1166,17 +1166,17 @@ import { get } from 'https';
* @returns {object} response
* @returns {string|buffer} response.source
*/
export async function getSource(url, { format }, defaultGetSource) {
export async function getSource(url, context, defaultGetSource) {
if (url.startsWith('https://')) {
return new Promise((resolve, reject) => {
get(url, (res) => {
request(url, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => resolve({ source: data }));
}).on('error', (err) => reject(err));
});
}
return defaultGetSource(url, { format }, defaultGetSource);
return defaultGetSource(url, context, defaultGetSource);
}

/**
Expand All @@ -1187,9 +1187,8 @@ export async function getSource(url, { format }, defaultGetSource) {
* @returns {object} response
* @returns {string} response.url
*/
export async function resolve(specifier,
{ parentURL },
defaultResolve) {
export async function resolve(specifier, context, defaultResolve) {
const { parentURL = null } = context;
if (specifier.startsWith('https://')) {
return {
url: specifier
Expand Down Expand Up @@ -1231,7 +1230,7 @@ unknown-to-Node.js file extensions.
import CoffeeScript from 'coffeescript';

/**
* @param {string} source
* @param {string|buffer} source
* @param {object} context
* @param {string} context.url
* @param {string} context.format
Expand All @@ -1240,15 +1239,15 @@ import CoffeeScript from 'coffeescript';
* @returns {string|buffer} response.source
*/
export async function transformSource(source,
Comment thread
guybedford marked this conversation as resolved.
Outdated
{ url, format },
context,
defaultTransformSource) {
if (/\.coffee$|\.litcoffee$|\.coffee\.md$/.test(url)) {
return {
source: CoffeeScript.compile(source)
};
} else {
return defaultTransformSource(
source, { url, format }, defaultTransformSource);
source, context, defaultTransformSource);
}
}

Expand All @@ -1267,9 +1266,9 @@ const EXTENSIONS_REGEX = /\.coffee$|\.litcoffee$|\.coffee\.md$/;
* @returns {object} response
* @returns {string} response.url
*/
export async function resolve(specifier,
{ parentURL = baseURL },
defaultResolve) {
export async function resolve(specifier, context, defaultResolve) {
const { parentURL = baseURL } = context;

if (EXTENSIONS_REGEX.test(specifier)) {
const resolved = new URL(specifier, parentURL);
return {
Expand Down