bare-module-traverse 1.5.1 → 1.7.0

package/README.md

@@ -78,6 +78,11 @@ dependency = {
   source: 'string' | Buffer, // Source as returned by `readModule()`
   imports: {
     // See https://github.com/holepunchto/bare-module#imports
+  },
+  lexer: {
+    imports: [
+      // See https://github.com/holepunchto/bare-module-lexer#api
+    ]
   }
 }
 ```
@@ -158,7 +163,7 @@ next.value = {
 
 ```js
 next.value = {
-  children: URL
+  children: Generator
 }
 ```
 
@@ -166,7 +171,18 @@ next.value = {
 
 ```js
 next.value = {
-  dependency: URL
+  dependency: {
+    url: URL,
+    source: 'string' | Buffer,
+    imports: {
+      // See https://github.com/holepunchto/bare-module#imports
+    },
+    lexer: {
+      imports: [
+        // See https://github.com/holepunchto/bare-module-lexer#api
+      ]
+    }
+  }
 }
 ```
 

package/index.d.ts

@@ -12,6 +12,9 @@ interface Dependency {
   url: URL
   source: string | Buffer
   imports: ImportsMap
+  lexer: {
+    imports: Import[]
+  }
 }
 
 interface TraverseOptions extends ResolveOptions {

package/index.js

@@ -123,7 +123,10 @@ exports.module = function* (
     source = yield { module: url }
 
     if (source === null) {
-      throw errors.MODULE_NOT_FOUND(`Cannot find module '${url.href}'`)
+      throw errors.MODULE_NOT_FOUND(
+        `Cannot find module '${url.href}'`,
+        url.href
+      )
     }
   }
 
@@ -177,9 +180,13 @@ exports.module = function* (
     }
   }
 
-  yield* exports.imports(url, source, imports, artifacts, visited, opts)
+  const lexer = { imports: [] }
+
+  yield* exports.imports(url, source, imports, artifacts, lexer, visited, opts)
 
-  yield { dependency: { url, source, imports: compressImportsMap(imports) } }
+  yield {
+    dependency: { url, source, imports: compressImportsMap(imports), lexer }
+  }
 
   return true
 }
@@ -192,7 +199,7 @@ exports.package = function* (url, source, artifacts, visited, opts = {}) {
   const info = JSON.parse(source)
 
   if (info) {
-    yield { dependency: { url, source, imports: {} } }
+    yield { dependency: { url, source, imports: {}, lexer: { imports: [] } } }
 
     if (info.addon) {
       yield { children: exports.prebuilds(url, artifacts, visited, opts) }
@@ -246,7 +253,14 @@ exports.preresolved = function* (
     }
   }
 
-  yield { dependency: { url, source, imports: compressImportsMap(imports) } }
+  yield {
+    dependency: {
+      url,
+      source,
+      imports: compressImportsMap(imports),
+      lexer: { imports: [] }
+    }
+  }
 
   return true
 }
@@ -256,6 +270,7 @@ exports.imports = function* (
   source,
   imports,
   artifacts,
+  lexer,
   visited,
   opts = {}
 ) {
@@ -298,6 +313,8 @@ exports.imports = function* (
       })
     }
 
+    lexer.imports.push(entry)
+
     queue.push({ entry, specifier, condition })
   }
 
@@ -307,6 +324,7 @@ exports.imports = function* (
     matchedConditions.push(condition)
 
     const resolver = resolve(entry, parentURL, { ...opts, matchedConditions })
+    const candidates = []
 
     let next = resolver.next()
     let resolutions = 0
@@ -319,6 +337,8 @@ exports.imports = function* (
       } else {
         const url = value.resolution
 
+        candidates.push(url)
+
         let resolved = false
 
         if (
@@ -392,18 +412,34 @@ exports.imports = function* (
     matchedConditions.pop()
 
     if (resolutions === 0) {
+      let message = `Cannot find ${condition === 'default' ? 'module' : condition} '${specifier}' imported from '${parentURL.href}'`
+
+      if (candidates.length > 0) {
+        message += '\nCandidates:'
+        message += '\n' + candidates.map((url) => '- ' + url.href).join('\n')
+      }
+
       switch (condition) {
         case 'addon':
           throw errors.ADDON_NOT_FOUND(
-            `Cannot find addon '${specifier}' imported from '${parentURL.href}'`
+            message,
+            specifier,
+            parentURL,
+            candidates
           )
         case 'asset':
           throw errors.ASSET_NOT_FOUND(
-            `Cannot find asset '${specifier}' imported from '${parentURL.href}'`
+            message,
+            specifier,
+            parentURL,
+            candidates
           )
         default:
           throw errors.MODULE_NOT_FOUND(
-            `Cannot find module '${specifier}' imported from '${parentURL.href}'`
+            message,
+            specifier,
+            parentURL,
+            candidates
           )
       }
     }

package/lib/errors.js

@@ -12,28 +12,46 @@ module.exports = class ModuleTraverseError extends Error {
     return 'ModuleTraverseError'
   }
 
-  static MODULE_NOT_FOUND(msg) {
-    return new ModuleTraverseError(
+  static MODULE_NOT_FOUND(msg, specifier, referrer = null, candidates = []) {
+    const err = new ModuleTraverseError(
       msg,
       'MODULE_NOT_FOUND',
       ModuleTraverseError.MODULE_NOT_FOUND
     )
+
+    err.specifier = specifier
+    err.referrer = referrer
+    err.candidates = candidates
+
+    return err
   }
 
-  static ADDON_NOT_FOUND(msg) {
-    return new ModuleTraverseError(
+  static ADDON_NOT_FOUND(msg, specifier, referrer = null, candidates = []) {
+    const err = new ModuleTraverseError(
       msg,
       'ADDON_NOT_FOUND',
       ModuleTraverseError.ADDON_NOT_FOUND
     )
+
+    err.specifier = specifier
+    err.referrer = referrer
+    err.candidates = candidates
+
+    return err
   }
 
-  static ASSET_NOT_FOUND(msg) {
-    return new ModuleTraverseError(
+  static ASSET_NOT_FOUND(msg, specifier, referrer = null, candidates = []) {
+    const err = new ModuleTraverseError(
       msg,
       'ASSET_NOT_FOUND',
       ModuleTraverseError.ASSET_NOT_FOUND
     )
+
+    err.specifier = specifier
+    err.referrer = referrer
+    err.candidates = candidates
+
+    return err
   }
 
   static INVALID_IMPORTS_MAP(msg) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-module-traverse",
-  "version": "1.5.1",
+  "version": "1.7.0",
   "description": "Low-level module graph traversal for Bare",
   "exports": {
     ".": {