bare-module 3.1.5 → 3.1.7

package/README.md

@@ -12,6 +12,157 @@ npm i bare-module
 const Module = require('bare-module')
 ````
 
+## Packages
+
+A package is directory with a `package.json` file.
+
+### Fields
+
+#### `"name"`
+
+```json
+{
+  "name": "my-package"
+}
+```
+
+The name of the package. This is used for [addon resolution](https://github.com/holepunchto/bare-addon-resolve#algorithm), [self-referencing](#self-referencing), and importing packages by name.
+
+#### `"version"`
+
+```json
+{
+  "version": "1.2.3"
+}
+```
+
+The current version of the package. This is used for [addon resolution](https://github.com/holepunchto/bare-addon-resolve#algorithm).
+
+#### `"type"`
+
+```json
+{
+  "type": "module"
+}
+```
+
+The module format used for `.js` files. If not defined, `.js` files are interpreted as CommonJS. If set to `"module"`, `.js` files are instead interpreted as ES modules.
+
+#### `"exports"`
+
+```json
+{
+  "exports": {
+    ".": "./index.js"
+  }
+}
+```
+
+The entry points of the package. If defined, only the modules explicitly exported by the package may be imported when importing the package by name.
+
+##### Subpath exports
+
+A package may define more than one entry point by declaring several subpaths with the main export being `"."`:
+
+```json
+{
+  "exports": {
+    ".": "./index.js",
+    "./submodule": "./lib/submodule.js"
+  }
+}
+```
+
+When importing the package by name, `require('my-package')` will resolve to `<modules>/my-package/index.js` whereas `require('my-package/submodule')` will resolve to `<modules>/my-package/lib/submodule.js`.
+
+##### Conditional exports
+
+Conditional exports allow packages to provide different exports for different conditions, such as the module format of the importing module:
+
+```json
+{
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.cjs"
+    }
+  }
+}
+```
+
+When importing the package by name, `require('my-package')` will resolve to `<modules>/my-package/index.cjs` whereas `import 'my-package'` will resolve to `<modules>/my-package/index.mjs`.
+
+Similarly, conditional exports can be used to provide different entry points for different runtimes:
+
+```json
+{
+  "exports": {
+    ".": {
+      "bare": "./bare.js",
+      "node": "./node.js"
+    }
+  }
+}
+```
+
+To provide a fallback for when no other conditions match, the `"default"` condition can be declared:
+
+```json
+{
+  "exports": {
+    ".": {
+      "bare": "./bare.js",
+      "node": "./node.js",
+      "default": "./fallback.js"
+    }
+  }
+}
+```
+
+The following conditions are supported, listed in order from most specific to least specific as conditions should be defined:
+
+Condition | Description
+:-- | :--
+`"bare"` |
+`"node"` |
+`"import"` |
+`"require"` |
+`"default"` |
+
+##### Self-referencing
+
+Within a package, exports defined in the `"exports"` field can be referenced by importing the package by name. For example, given the following `package.json`...
+
+```json
+{
+  "name": "my-package",
+  "exports": {
+    ".": "./index.js",
+    "./submodule": "./lib/submodule.js"
+  }
+}
+```
+
+...any module within `my-package` may reference these entry points using either `require('my-package')` or `require('my-package/submodule')`.
+
+##### Exports sugar
+
+If a package defines only a single export, `"."`, it may leave out the subpath entirely:
+
+```json
+{
+  "exports": "./index.js"
+}
+```
+
+#### `"imports"`
+
+##### Subpath imports
+
+##### Conditional imports
+
+##### Private imports
+
 ## API
 
 #### `Module.constants`

package/binding.c

@@ -21,6 +21,10 @@ on_static_import (js_env_t *env, js_value_t *specifier, js_value_t *assertions,
 
   int err;
 
+  js_handle_scope_t *scope;
+  err = js_open_handle_scope(env, &scope);
+  assert(err == 0);
+
   js_value_t *ctx;
   err = js_get_reference_value(env, context->ctx, &ctx);
   assert(err == 0);
@@ -36,20 +40,29 @@ on_static_import (js_env_t *env, js_value_t *specifier, js_value_t *assertions,
   js_value_t *args[4] = {specifier, assertions};
 
   err = js_create_string_utf8(env, (utf8_t *) name, -1, &args[2]);
-  if (err < 0) return NULL;
+  if (err < 0) goto err;
 
   err = js_get_boolean(env, false, &args[3]);
   assert(err == 0);
 
   js_value_t *result;
   err = js_call_function(env, ctx, on_import, 4, args, &result);
-  if (err < 0) return NULL;
+  if (err < 0) goto err;
 
   js_module_t *module;
   err = js_get_value_external(env, result, (void **) &module);
-  if (err < 0) return NULL;
+  if (err < 0) goto err;
+
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
 
   return module;
+
+err:
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
+
+  return NULL;
 }
 
 static js_module_t *
@@ -58,6 +71,10 @@ on_dynamic_import (js_env_t *env, js_value_t *specifier, js_value_t *assertions,
 
   int err;
 
+  js_handle_scope_t *scope;
+  err = js_open_handle_scope(env, &scope);
+  assert(err == 0);
+
   js_value_t *ctx;
   err = js_get_reference_value(env, context->ctx, &ctx);
   assert(err == 0);
@@ -73,13 +90,22 @@ on_dynamic_import (js_env_t *env, js_value_t *specifier, js_value_t *assertions,
 
   js_value_t *result;
   err = js_call_function(env, ctx, on_import, 4, args, &result);
-  if (err < 0) return NULL;
+  if (err < 0) goto err;
 
   js_module_t *module;
   err = js_get_value_external(env, result, (void **) &module);
-  if (err < 0) return NULL;
+  if (err < 0) goto err;
+
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
 
   return module;
+
+err:
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
+
+  return NULL;
 }
 
 static void
@@ -88,6 +114,10 @@ on_evaluate (js_env_t *env, js_module_t *module, void *data) {
 
   int err;
 
+  js_handle_scope_t *scope;
+  err = js_open_handle_scope(env, &scope);
+  assert(err == 0);
+
   js_value_t *ctx;
   err = js_get_reference_value(env, context->ctx, &ctx);
   assert(err == 0);
@@ -103,11 +133,20 @@ on_evaluate (js_env_t *env, js_module_t *module, void *data) {
   js_value_t *args[1];
 
   err = js_create_string_utf8(env, (utf8_t *) name, -1, &args[0]);
-  if (err < 0) return;
+  if (err < 0) goto err;
 
   js_value_t *result;
   err = js_call_function(env, ctx, on_evaluate, 1, args, &result);
-  if (err < 0) return;
+  if (err < 0) goto err;
+
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
+
+  return;
+
+err:
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
 }
 
 static void
@@ -116,6 +155,10 @@ on_meta (js_env_t *env, js_module_t *module, js_value_t *meta, void *data) {
 
   int err;
 
+  js_handle_scope_t *scope;
+  err = js_open_handle_scope(env, &scope);
+  assert(err == 0);
+
   js_value_t *ctx;
   err = js_get_reference_value(env, context->ctx, &ctx);
   assert(err == 0);
@@ -131,13 +174,22 @@ on_meta (js_env_t *env, js_module_t *module, js_value_t *meta, void *data) {
   js_value_t *args[2];
 
   err = js_create_string_utf8(env, (utf8_t *) name, -1, &args[0]);
-  if (err < 0) return;
+  if (err < 0) goto err;
 
   args[1] = meta;
 
   js_value_t *result;
   err = js_call_function(env, ctx, on_meta, 2, args, &result);
-  if (err < 0) return;
+  if (err < 0) goto err;
+
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
+
+  return;
+
+err:
+  err = js_close_handle_scope(env, scope);
+  assert(err == 0);
 }
 
 static js_value_t *

package/index.js

@@ -2,6 +2,7 @@
 const path = require('bare-path')
 const resolve = require('bare-module-resolve')
 const Bundle = require('bare-bundle')
+const { parse } = require('cjs-module-lexer')
 const { fileURLToPath, pathToFileURL } = require('url-file-url')
 const Protocol = require('./lib/protocol')
 const constants = require('./lib/constants')
@@ -27,6 +28,7 @@ const Module = module.exports = exports = class Module {
     this._conditions = null
     this._protocol = null
     this._bundle = null
+    this._function = null
     this._handle = null
 
     Module._modules.add(this)
@@ -112,42 +114,100 @@ const Module = module.exports = exports = class Module {
   _transform (isImport, isDynamicImport) {
     if (isDynamicImport) {
       this._synthesize()
-      this._evaluate()
+      this._evaluate(true /* eagerRun */)
     } else if (isImport) {
       this._synthesize()
-    } else if (this._type === constants.types.MODULE) {
+    } else {
       this._evaluate()
     }
 
     return this
   }
 
-  _evaluate () {
-    if ((this._state & constants.states.EVALUATED) !== 0) return
+  _synthesize () {
+    if ((this._state & constants.states.SYNTHESIZED) !== 0) return
+
+    this._state |= constants.states.SYNTHESIZED
 
-    binding.runModule(this._handle, Module._handle)
+    if (this._type === constants.types.MODULE) return
 
-    if (this._type === constants.types.MODULE) {
-      this._exports = binding.getNamespace(this._handle)
+    const names = ['default']
+    const queue = [this]
+    const seen = new Set()
+
+    while (queue.length) {
+      const module = queue.pop()
+
+      if (seen.has(module)) continue
+
+      seen.add(module)
+
+      switch (module._type) {
+        case constants.types.SCRIPT: {
+          const result = parse(module._function.toString())
+
+          names.push(...result.exports)
+
+          const referrer = module
+
+          for (const specifier of result.reexports) {
+            const resolved = Module.resolve(specifier, referrer._url, { isImport: true, referrer })
+
+            const module = Module.load(resolved, { isImport: true, referrer })
+
+            queue.push(module)
+          }
+
+          break
+        }
+
+        case constants.types.MODULE: {
+          module._evaluate()
+
+          for (const name of Object.keys(module._exports)) {
+            names.push(name)
+          }
+
+          break
+        }
+
+        case constants.types.JSON: {
+          for (const name of Object.keys(module._exports)) {
+            names.push(name)
+          }
+        }
+      }
     }
 
-    this._state |= constants.states.EVALUATED
+    this._handle = binding.createSyntheticModule(this._url.href, names, Module._handle)
   }
 
-  _synthesize () {
-    if ((this._state & constants.states.SYNTHESIZED) !== 0) return
+  _evaluate (eagerRun = false) {
+    if ((this._state & constants.states.EVALUATED) !== 0) return
 
-    if (this._type !== constants.types.MODULE) {
-      const names = ['default']
+    this._state |= constants.states.EVALUATED
 
-      for (const key of Object.keys(this._exports)) {
-        if (key !== 'default') names.push(key)
-      }
+    if (this._type === constants.types.SCRIPT) {
+      const require = createRequire(this._url, { module: this })
+
+      this._exports = {}
+
+      this._function(
+        require,
+        this,
+        this._exports,
+        urlToPath(this._url),
+        urlToDirname(this._url)
+      )
 
-      this._handle = binding.createSyntheticModule(this._url.href, names, Module._handle)
+      if (eagerRun) binding.runModule(this._handle, Module._handle)
     }
 
-    this._state |= constants.states.SYNTHESIZED
+    if (this._type === constants.types.MODULE) {
+      binding.runModule(this._handle, Module._handle)
+
+      this._exports = binding.getNamespace(this._handle)
+    }
   }
 
   [Symbol.for('bare.inspect')] () {
@@ -218,6 +278,8 @@ const Module = module.exports = exports = class Module {
       throw errors.MODULE_NOT_FOUND(`Cannot find module '${href}'`)
     }
 
+    module._evaluate()
+
     binding.setExport(module._handle, 'default', module._exports)
 
     for (const [key, value] of Object.entries(module._exports)) {
@@ -415,7 +477,7 @@ exports.isBuiltin = function isBuiltin () {
   return false
 }
 
-exports.createRequire = function createRequire (parentURL, opts = {}) {
+const createRequire = exports.createRequire = function createRequire (parentURL, opts = {}) {
   const self = Module
 
   if (typeof parentURL === 'string') {
@@ -427,6 +489,8 @@ exports.createRequire = function createRequire (parentURL, opts = {}) {
   }
 
   let {
+    module = null,
+
     referrer = null,
     type = constants.types.SCRIPT,
     defaultType = referrer ? referrer._defaultType : constants.types.SCRIPT,
@@ -439,17 +503,19 @@ exports.createRequire = function createRequire (parentURL, opts = {}) {
     conditions = referrer ? referrer._conditions : self._conditions
   } = opts
 
-  const module = new Module(parentURL)
+  if (module === null) {
+    module = new Module(parentURL)
 
-  module._type = type
-  module._defaultType = defaultType
-  module._cache = cache
-  module._main = main || module
-  module._protocol = protocol
-  module._imports = imports
-  module._resolutions = resolutions
-  module._builtins = builtins
-  module._conditions = conditions
+    module._type = type
+    module._defaultType = defaultType
+    module._cache = cache
+    module._main = main || module
+    module._protocol = protocol
+    module._imports = imports
+    module._resolutions = resolutions
+    module._builtins = builtins
+    module._conditions = conditions
+  }
 
   referrer = module
 
@@ -522,8 +588,6 @@ Module._extensions['.js'] = function (module, source, referrer) {
 }
 
 Module._extensions['.cjs'] = function (module, source, referrer) {
-  const self = Module
-
   const protocol = module._protocol
 
   module._type = constants.types.SCRIPT
@@ -535,49 +599,7 @@ Module._extensions['.cjs'] = function (module, source, referrer) {
 
     if (typeof source !== 'string') source = Buffer.coerce(source).toString()
 
-    referrer = module
-
-    addon.host = Bare.Addon.host
-
-    require.main = module._main
-    require.cache = module._cache
-    require.resolve = resolve
-    require.addon = addon
-
-    module._exports = {}
-
-    binding.createFunction(module._url.href, ['require', 'module', 'exports', '__filename', '__dirname'], source, 0)(
-      require,
-      module,
-      module._exports,
-      urlToPath(module._url),
-      urlToDirname(module._url)
-    )
-
-    function require (specifier) {
-      const resolved = self.resolve(specifier, referrer._url, { referrer })
-
-      const module = self.load(resolved, { referrer })
-
-      return module._exports
-    }
-
-    function resolve (specifier) {
-      const resolved = self.resolve(specifier, referrer._url, { referrer })
-
-      switch (resolved.protocol) {
-        case 'builtin:': return resolved.pathname
-        default: urlToPath(resolved)
-      }
-    }
-
-    function addon (specifier = '.') {
-      const resolved = Bare.Addon.resolve(specifier, referrer._url, { referrer })
-
-      const addon = Bare.Addon.load(resolved, { referrer })
-
-      return addon._exports
-    }
+    module._function = binding.createFunction(module._url.href, ['require', 'module', 'exports', '__filename', '__dirname'], source, 0)
   }
 }
 
@@ -688,7 +710,7 @@ Bare
   })
 
 function urlToPath (url) {
-  if (url.protocol) return fileURLToPath(url)
+  if (url.protocol === 'file:') return fileURLToPath(url)
 
   if (isWindows) {
     if (/%2f|%5c/i.test(url.pathname)) {
@@ -704,7 +726,7 @@ function urlToPath (url) {
 }
 
 function urlToDirname (url) {
-  if (url.protocol) return path.dirname(fileURLToPath(url))
+  if (url.protocol === 'file:') return path.dirname(fileURLToPath(url))
 
   if (isWindows) {
     if (/%2f|%5c/i.test(url.pathname)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-module",
-  "version": "3.1.5",
+  "version": "3.1.7",
   "description": "Module support for JavaScript",
   "main": "index.js",
   "files": [
@@ -29,6 +29,7 @@
     "bare-bundle": "^1.0.0",
     "bare-module-resolve": "^1.4.4",
     "bare-path": "^2.0.0",
+    "cjs-module-lexer": "^1.2.3",
     "url-file-url": "^1.0.2"
   },
   "devDependencies": {