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!
Don't miss the introductory blog post about this idea!
<!doctype html>
<html>
<script
id="common-js"
data-main="/js-browser/main.js"
src="common.js"
></script>
</html>
Having a single script with id="common-js" 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 imported paths from where they've been loaded, and so on.
The same goes for NodeJS, it's indeed same logic behind require.
// /js-browser/main.js loading /js-browser/test.js
module.import('./test').then(function (test) {
test('Hello CommonJS!');
// will output:
// Hello CommonJS!
// from /js-browser/test.js
});
// the /js-browser/test.js content
module.exports = function (message) {
alert(message + '\nfrom ' + module.filename);
};
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;
});
// an async example of /js-browser/test.js content
// for the /js-browser/main.js file nothing changes
module.exports = new Promise(function (resolve) {
setTimeout(
resolve,
1000,
function (message) {
alert(message + '\nfrom ' + module.filename);
}
);
});
The synchronous require and both __filename and __dirname are also exposed, but nothing else from NodeJS core is available.
You are responsible for loading all the modules you need, possibly only when you need them.
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.Copyright (C) 2017 by Andrea Giammarchi - @WebReflection
FAQs
module.exports and module.import for browsers too
The npm package common-js receives a total of 486 weekly downloads. As such, common-js popularity was classified as not popular.
We found that common-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.