bare-module-traverse 1.0.0 → 1.1.0

package/README.md

@@ -50,6 +50,16 @@ for await (const dependency of traverse(new URL('file:///directory/file.js'), re
 
 Traverse the module graph rooted at `url`, which must be a WHATWG `URL` instance. `readModule` is called with a `URL` instance for every module to be read and must either return the module source, if it exists, or `null`. `listPrefix` is called with a `URL` instance of every prefix to be listed and must return a list of `URL` instances that have the specified `URL` as a prefix. If not provided, prefixes won't be traversed. If one or both of `readModule` or `listPrefix` returns a promise, synchronous iteration is not supported.
 
+Options include:
+
+```js
+{
+  resolve: resolve.default
+}
+```
+
+Options supported by <https://github.com/holepunchto/bare-module-resolve> and <https://github.com/holepunchto/bare-addon-resolve> may also be specified.
+
 #### `for (const dependency of dependencies)`
 
 Synchronously iterate the module graph. Each yielded dependency has the following shape:
@@ -68,6 +78,28 @@ Synchronously iterate the module graph. Each yielded dependency has the followin
 
 Asynchronously iterate the module graph. If one or both of `readModule` or `listPrefix` returns promises, these will be awaited. The same comments as `for (const dependency of dependencies)` apply.
 
+### Resolution
+
+#### `resolve.module`
+
+Convenience export from <https://github.com/holepunchto/bare-module-resolve>.
+
+#### `resolve.addon`
+
+Convenience export from <https://github.com/holepunchto/bare-addon-resolve>.
+
+#### `resolve.default`
+
+The default resolver, which simply forwards to <https://github.com/holepunchto/bare-module-resolve> and <https://github.com/holepunchto/bare-addon-resolve> with the literal options passed by the caller.
+
+#### `resolve.bare`
+
+The Bare resolver, which matches the options used by the Bare module system.
+
+#### `resolve.node`
+
+The Node.js resolver, which matches the options used by the Node.js module system.
+
 ### Algorithm
 
 The following generator functions implement the traversal algorithm. To drive the generator functions, a loop like the following can be used:
@@ -106,13 +138,18 @@ while (queue.length > 0) {
 
 Options are the same as `traverse()` for all functions.
 
+> [!WARNING]
+> These functions are currently subject to change between minor releases. If using them directly, make sure to specify a tilde range (`~1.2.3`) when declaring the module dependency.
+
 #### `const generator = traverse.module(url, source, artifacts, visited[, options])`
 
 #### `const generator = traverse.package(url, source, artifacts, visited[, options])`
 
 #### `const generator = traverse.preresolved(url, source, resolutions, artifacts, visited[, options])`
 
-#### `const generator = traverse.imports(url, source, imports, artifacts, visited[, options])`
+#### `const generator = traverse.imports(parentURL, source, imports, artifacts, visited[, options])`
+
+#### `const generator = traverse.prebuilds(packageURL, artifacts, visited[, options])`
 
 #### `const generator = traverse.assets(patterns, parentURL, artifacts, visited[, options])`
 

package/index.js

@@ -1,6 +1,8 @@
 const { lookupPackageScope } = require('bare-module-resolve')
+const { lookupPrebuildsScope } = require('bare-addon-resolve')
 const lex = require('bare-module-lexer')
 const resolve = require('./lib/resolve')
+const errors = require('./lib/errors')
 
 module.exports = exports = function traverse (entry, opts, readModule, listPrefix) {
   if (typeof opts === 'function') {
@@ -15,9 +17,9 @@ module.exports = exports = function traverse (entry, opts, readModule, listPrefi
 
   return {
     * [Symbol.iterator] () {
-      const artifacts = createArtifacts()
+      const artifacts = { addons: [], assets: [] }
 
-      const queue = [exports.module(entry, readModule(entry), artifacts, new Set(), opts)]
+      const queue = [exports.module(entry, null, artifacts, new Set(), opts)]
 
       while (queue.length > 0) {
         const generator = queue.pop()
@@ -44,9 +46,9 @@ module.exports = exports = function traverse (entry, opts, readModule, listPrefi
     },
 
     async * [Symbol.asyncIterator] () {
-      const artifacts = createArtifacts()
+      const artifacts = { addons: [], assets: [] }
 
-      const queue = [exports.module(entry, await readModule(entry), artifacts, new Set(), opts)]
+      const queue = [exports.module(entry, null, artifacts, new Set(), opts)]
 
       while (queue.length > 0) {
         const generator = queue.pop()
@@ -78,19 +80,27 @@ function defaultListPrefix () {
   return []
 }
 
-function defaultResolve (entry, parentURL, opts) {
-  if (entry.type & lex.constants.ADDON) {
-    return resolve.addon(entry.specifier, parentURL, opts)
-  } else {
-    return resolve.module(entry.specifier, parentURL, opts)
+function addURL (array, url) {
+  let lo = 0
+  let hi = array.length - 1
+
+  while (lo <= hi) {
+    const mid = lo + ((hi - lo) >> 1)
+    const found = array[mid]
+
+    if (found.href === url.href) return
+
+    if (found.href < url.href) {
+      lo = mid + 1
+    } else {
+      hi = mid - 1
+    }
   }
-}
 
-function createArtifacts () {
-  return { addons: [], assets: [] }
+  array.splice(lo, 0, url)
 }
 
-function addURL (array, url) {
+function removeURL (array, url) {
   let lo = 0
   let hi = array.length - 1
 
@@ -98,7 +108,7 @@ function addURL (array, url) {
     const mid = lo + ((hi - lo) >> 1)
     const found = array[mid]
 
-    if (found.href === url.href) return
+    if (found.href === url.href) break
 
     if (found.href < url.href) {
       lo = mid + 1
@@ -107,7 +117,7 @@ function addURL (array, url) {
     }
   }
 
-  array.splice(lo, 0, url)
+  if (array[lo].href === url.href) array.splice(lo, 1)
 }
 
 exports.resolve = resolve
@@ -117,6 +127,14 @@ exports.module = function * (url, source, artifacts, visited, opts = {}) {
 
   if (visited.has(url.href)) return false
 
+  if (source === null) {
+    source = yield { module: url }
+
+    if (source === null) {
+      throw errors.MODULE_NOT_FOUND(`Cannot find module '${url.href}'`)
+    }
+  }
+
   visited.add(url.href)
 
   if (resolutions) {
@@ -154,6 +172,10 @@ exports.package = function * (url, source, artifacts, visited, opts = {}) {
   if (info) {
     yield { dependency: { url, source, imports: {} } }
 
+    if (info.addon) {
+      yield { children: exports.prebuilds(url, artifacts, visited, opts) }
+    }
+
     if (info.assets) {
       yield { children: exports.assets(info.assets, url, artifacts, visited, opts) }
     }
@@ -177,14 +199,11 @@ exports.preresolved = function * (url, source, resolutions, artifacts, visited,
 
       if (typeof entry === 'string') {
         const url = new URL(entry)
-        const source = yield { module: url }
-
-        if (source === null) continue
 
         if (specifier === '#package') {
-          yield { children: exports.package(url, source, artifacts, visited, opts) }
+          yield { children: exports.package(url, null, artifacts, visited, opts) }
         } else {
-          yield { children: exports.module(url, source, artifacts, visited, opts) }
+          yield { children: exports.module(url, null, artifacts, visited, opts) }
         }
       } else {
         stack.unshift(...Object.values(entry))
@@ -197,13 +216,16 @@ exports.preresolved = function * (url, source, resolutions, artifacts, visited,
   return true
 }
 
-exports.imports = function * (url, source, imports, artifacts, visited, opts = {}) {
-  const { resolve = defaultResolve } = opts
+exports.imports = function * (parentURL, source, imports, artifacts, visited, opts = {}) {
+  const { resolve = exports.resolve.default } = opts
+
+  let yielded = false
 
   for (const entry of lex(source).imports) {
-    const resolver = resolve(entry, url, opts)
+    const resolver = resolve(entry, parentURL, opts)
 
     let next = resolver.next()
+    let resolved = false
 
     while (next.done !== true) {
       const value = next.value
@@ -232,22 +254,51 @@ exports.imports = function * (url, source, imports, artifacts, visited, opts = {
 
           yield { children: exports.module(url, source, artifacts, visited, opts) }
 
+          resolved = yielded = true
+
           break
         }
 
         next = resolver.next()
       }
     }
+
+    if (!resolved) {
+      throw errors.MODULE_NOT_FOUND(`Cannot find module '${entry.specifier}' imported from '${parentURL.href}'`)
+    }
   }
+
+  return yielded
+}
+
+exports.prebuilds = function * (packageURL, artifacts, visited, opts = {}) {
+  const [prefix = null] = lookupPrebuildsScope(packageURL, opts)
+
+  if (prefix === null) return false
+
+  let yielded = false
+
+  for (const url of yield { prefix }) {
+    const source = yield { module: url }
+
+    if (source !== null) {
+      addURL(artifacts.addons, url)
+
+      yield { children: exports.module(url, source, artifacts, visited, opts) }
+
+      yielded = true
+    }
+  }
+
+  return yielded
 }
 
 exports.assets = function * (patterns, parentURL, artifacts, visited, opts = {}) {
-  const matches = yield * exports.matches(patterns, parentURL, opts)
+  const matches = yield * exports.patternMatches(patterns, parentURL, [], opts)
 
   let yielded = false
 
-  for (const href of matches) {
-    const url = new URL(href)
+  for (const url of matches) {
     const source = yield { module: url }
 
     if (source !== null) {
@@ -262,10 +313,10 @@ exports.assets = function * (patterns, parentURL, artifacts, visited, opts = {})
   return yielded
 }
 
-exports.matches = function * (patterns, parentURL) {
-  const matches = new Set()
+exports.patternMatches = function * (pattern, parentURL, matches, opts = {}) {
+  const { conditions = [] } = opts
 
-  for (let pattern of patterns) {
+  if (typeof pattern === 'string') {
     let patternNegate = false
     let patternBase
     let patternTrailer
@@ -289,12 +340,26 @@ exports.matches = function * (patterns, parentURL) {
 
     for (const url of yield { prefix }) {
       if (patternIndex === -1) {
-        if (patternNegate) matches.delete(url.href)
-        else matches.add(url.href)
+        if (patternNegate) removeURL(matches, url)
+        else addURL(matches, url)
       } else if (patternTrailer === '' || url.href.endsWith(patternTrailer)) {
-        matches.add(url.href)
+        addURL(matches, url)
       } else if (patternNegate) {
-        matches.delete(url.href)
+        removeURL(matches, url)
+      }
+    }
+  } else if (Array.isArray(pattern)) {
+    for (const patternValue of pattern) {
+      yield * exports.patternMatches(patternValue, parentURL, matches, opts)
+    }
+  } else if (typeof pattern === 'object' && pattern !== null) {
+    const keys = Object.keys(pattern)
+
+    for (const p of keys) {
+      if (p === 'default' || conditions.includes(p)) {
+        const patternValue = pattern[p]
+
+        return yield * exports.patternMatches(patternValue, parentURL, matches, opts)
       }
     }
   }

package/lib/errors.js

@@ -0,0 +1,18 @@
+module.exports = class ModuleTraverseError extends Error {
+  constructor (msg, code, fn = ModuleTraverseError) {
+    super(`${code}: ${msg}`)
+    this.code = code
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, fn)
+    }
+  }
+
+  get name () {
+    return 'ModuleTraverseError'
+  }
+
+  static MODULE_NOT_FOUND (msg) {
+    return new ModuleTraverseError(msg, 'MODULE_NOT_FOUND', ModuleTraverseError.MODULE_NOT_FOUND)
+  }
+}

package/lib/resolve.js

@@ -1,2 +1,68 @@
+const lex = require('bare-module-lexer')
+
 exports.module = require('bare-module-resolve').module
 exports.addon = require('bare-addon-resolve').addon
+
+exports.default = function resolve (entry, parentURL, opts) {
+  if (entry.type & lex.constants.ADDON) {
+    return exports.addon(entry.specifier, parentURL, opts)
+  }
+
+  return exports.module(entry.specifier, parentURL, opts)
+}
+
+exports.bare = function resolve (entry, parentURL, opts = {}) {
+  const runtime = require('#runtime')
+
+  const {
+    platform = runtime.platform,
+    arch = runtime.arch,
+    simulator = false
+  } = opts
+
+  let extensions
+  let conditions = ['bare', 'node', platform, arch]
+
+  if (simulator) conditions = [...conditions, 'simulator']
+
+  if (entry.type & lex.constants.ADDON) {
+    extensions = ['.bare', '.node']
+    conditions = ['addon', ...conditions]
+
+    return exports.addon(entry.specifier, parentURL, { extensions, conditions, ...opts })
+  }
+
+  if (entry.type & lex.constants.ASSET) {
+    conditions = ['asset', ...conditions]
+  } else {
+    extensions = ['.js', '.cjs', '.mjs', '.json', '.bare', '.node']
+
+    if (entry.type & lex.constants.REQUIRE) {
+      conditions = ['require', ...conditions]
+    } else if (entry.type & lex.constants.IMPORT) {
+      conditions = ['import', ...conditions]
+    }
+  }
+
+  return exports.module(entry.specifier, parentURL, { extensions, conditions, ...opts })
+}
+
+exports.node = function resolve (entry, parentURL, opts) {
+  let extensions
+  let conditions
+
+  if (entry.type & lex.constants.ADDON) {
+    extensions = ['.node']
+
+    return exports.addon(entry.specifier, parentURL, { extensions, conditions, ...opts })
+  }
+
+  if (entry.type & lex.constants.REQUIRE) {
+    extensions = ['.js', '.json', '.node']
+    conditions = ['node', 'require']
+  } else if (entry.type & lex.constants.IMPORT) {
+    conditions = ['node', 'import']
+  }
+
+  return exports.module(entry.specifier, parentURL, { extensions, conditions, ...opts })
+}

package/lib/runtime/bare.js

@@ -0,0 +1,3 @@
+/* global Bare */
+exports.platform = Bare.platform
+exports.arch = Bare.arch

package/lib/runtime/node.js

@@ -0,0 +1,2 @@
+exports.platform = process.platform
+exports.arch = process.arch

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-module-traverse",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Low-level module graph traversal for Bare",
   "exports": {
     ".": "./index.js",
@@ -11,6 +11,12 @@
     "index.js",
     "lib"
   ],
+  "imports": {
+    "#runtime": {
+      "bare": "./lib/runtime/bare.js",
+      "node": "./lib/runtime/node.js"
+    }
+  },
   "scripts": {
     "test": "standard && bare test.js"
   },