bare-module 3.1.5 → 3.1.6

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 depending 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/index.js

@@ -688,7 +688,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 +704,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.6",
   "description": "Module support for JavaScript",
   "main": "index.js",
   "files": [