https://github.com/whatwg/loader

Loader Standard
https://github.com/whatwg/loader

Last synced: about 2 months ago
JSON representation

Loader Standard

• Host: GitHub
• URL: https://github.com/whatwg/loader
• Owner: whatwg
• License: cc0-1.0
• Created: 2014-09-30T22:22:27.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2021-04-30T22:01:10.000Z (over 3 years ago)
• Last Synced: 2024-06-03T17:46:10.385Z (4 months ago)
• Language: JavaScript
• Homepage: https://whatwg.github.io/loader/
• Size: 376 KB
• Stars: 609
• Watchers: 99
• Forks: 45
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
This repository hosts the [JavaScript Loader Standard](http://whatwg.github.io/loader).

### Code of conduct

We are committed to providing a friendly, safe and welcoming environment for all. Please read and

respect the [WHATWG Code of Conduct](https://whatwg.org/code-of-conduct).

# Status

A good chunk of this spec is out of date and is undergoing revision to realign it with Service Worker, the JS Realms API, and the dynamic import() feature.

# Loader

Section 15.2 of the [ES2015 specification](http://www.ecma-international.org/ecma-262/6.0/) describes the syntax for the new `import` and `export` declarations, but does not specify how modules are to be loaded. This repository consolidates work on the ECMAScript module loading semantics with the integration points of Web browsers, as well as Node.js.

The main spec is available at https://whatwg.github.io/loader, generated from the `index.bs` file.

## Building the spec

Building the spec is a two-step process. First, the majority of the conversion work is done via [Bikeshed](https://github.com/tabatkins/bikeshed). Second, we run a custom portion of the [Ecmarkup](https://github.com/bterlson/ecmarkup) pipeline to convert the algorithms from [Ecmarkdown](https://github.com/domenic/ecmarkdown) syntax into HTML, and to automatically add cross-references. This second step requires [io.js](https://iojs.org/) to be installed.

### Bikeshed

To run Bikeshed locally, [install Bikeshed](https://github.com/tabatkins/bikeshed/blob/master/docs/quick-start.md) and then run `bikeshed spec` in the working directory.

Alternately, you can use the command

```

curl https://api.csswg.org/bikeshed/ -F [email protected] > index.tmp.html

```

to use Bikeshed's web interface without installing anything.

### Ecmarkup

To run the Ecmarkup step, be sure you've done `npm install` in the root directory, then run

```

npm run ecmarkupify index.tmp.html index.html

```

### Local Watch

If you have Bikeshed installed locally, and have run `npm install`, you can try running

```

npm run local-watch

```

to start a watcher on `index.bs` that will update `index.html` as you edit.

### Implementation status

This spec is currently undergoing potentially-large redesigns (see [#147](https://github.com/whatwg/loader/issues/147) and [#149](https://github.com/whatwg/loader/issues/149)) and is not ready for implementations. You can see one possible way to break down the work in our old [roadmap](https://github.com/whatwg/loader/blob/master/roadmap.md) document, but that does not reflect the latest changes.

Various browsers are implementing module syntax parsing and `` loading ([Firefox](https://bugzilla.mozilla.org/show_bug.cgi?id=568953), [Chrome](https://code.google.com/p/v8/issues/detail?id=1569), [WebKit](https://bugs.webkit.org/show_bug.cgi?id=147340), [Edge](https://blogs.windows.com/msedgedev/2016/05/17/es6-modules-and-beyond/)). However, none of them have begun work on the ideas prototyped here, since they are not ready for implementations yet.

### Feedback

Please feel free to open a new issue, or send a pull request!