CommonJS + module.import()
This module aim is to bring both CommonJS like module behavior on Web browsers,
and a promise based module.import(path)
to both browsers and NodeJS.
Yes, it resolves paths relatively to the current one!
Yes, it is secure too, check the CSP enabled page!
Browser Example
<!doctype html>
<html>
<script
id="common-js"
data-main="/js-browser/main.js"
src="common.js"
></script>
</html>
Having a single top level script is all it takes to be able to load asynchronously any other file or module.
The main entry point /js-browser/main.js
will resolve relative paths from /js-browser/
folder.
Its loaded modules will resolve their own paths from where they've been loaded, and so on.
The same goes for NodeJS.
module.import('./test').then(function (test) {
test('Hello CommonJS!');
});
module.exports = function (message) {
alert(message + '\nfrom ' + module.filename);
};
Load multiple modules at once
Promise.all([
module.import('./a'),
module.import('//cdn.something.com/cool.js'),
module.import('../sw.js'),
module.import('/root/too.js')
]).then(function (modules) {
const [a, cool, sw, too] = modules;
});
Exporting modules asynchronously
module.exports = new Promise(function (resolve) {
setTimeout(
resolve,
1000,
function (message) {
alert(message + '\nfrom ' + module.filename);
}
);
});
F.A.Q
- Does it load every time?
It uses a cache, like NodeJS does. If you load same module twice, even from different relative paths, it'll use the cached one.
- Why on the module?
There are scripts, script type module,
importScripts
, a dynamic import proposal, you name it ... this one actually works and it's backward compatible with modules that don't care about this solution existing. - Why not ES2015 modules?
Because those, so far, never truly solved anything. Actually, ES6 modules created more problems due inability to require modules at runtime and/or on the browser.
- Is there a CDN I can use to test?
There is always one for npm modules. https://unpkg.com/common-js@latest should be already OK.
- Is this using eval?
No. It's using a technique that is even compatible with highest security standards such Content Security Policy
License
Copyright (C) 2017 by Andrea Giammarchi - @WebReflection