bare-module-traverse 1.6.0 → 1.7.1

package/README.md

@@ -21,11 +21,7 @@ function* listPrefix(url) {
   // Yield URLs that have `url` as a prefix. The list may be empty.
 }
 
-for (const dependency of traverse(
-  new URL('file:///directory/file.js'),
-  readModule,
-  listPrefix
-)) {
+for (const dependency of traverse(new URL('file:///directory/file.js'), readModule, listPrefix)) {
   console.log(dependency)
 }
 ```
@@ -62,6 +58,7 @@ Options include:
 
 ```js
 options = {
+  defaultType: constants.SCRIPT,
   resolve: resolve.default
 }
 ```
@@ -78,6 +75,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 +160,7 @@ next.value = {
 
 ```js
 next.value = {
-  children: URL
+  children: Generator
 }
 ```
 
@@ -166,7 +168,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,9 +12,13 @@ interface Dependency {
   url: URL
   source: string | Buffer
   imports: ImportsMap
+  lexer: {
+    imports: Import[]
+  }
 }
 
 interface TraverseOptions extends ResolveOptions {
+  defaultType?: number
   resolve?: (entry: Import, parentURL: URL, opts?: ResolveOptions) => Resolver
 }
 
@@ -58,6 +62,17 @@ declare namespace traverse {
     assets: URL[]
   }
 
+  export const constants: {
+    SCRIPT: number
+    MODULE: number
+    JSON: number
+    BUNDLE: number
+    ADDON: number
+    BINARY: number
+    TEXT: number
+    ASSET: number
+  }
+
   export function module(
     url: URL,
     source: string | Buffer,

package/index.js

@@ -4,12 +4,18 @@ 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
-) {
+const constants = {
+  SCRIPT: 1,
+  MODULE: 2,
+  JSON: 3,
+  BUNDLE: 4,
+  ADDON: 5,
+  BINARY: 6,
+  TEXT: 7,
+  ASSET: 8
+}
+
+module.exports = exports = function traverse(entry, opts, readModule, listPrefix) {
   if (typeof opts === 'function') {
     listPrefix = readModule
     readModule = opts
@@ -20,9 +26,7 @@ module.exports = exports = function traverse(
     *[Symbol.iterator]() {
       const artifacts = { addons: [], assets: [] }
 
-      const queue = [
-        exports.module(entry, null, {}, artifacts, new Set(), opts)
-      ]
+      const queue = [exports.module(entry, null, {}, artifacts, new Set(), opts)]
 
       while (queue.length > 0) {
         const generator = queue.pop()
@@ -63,9 +67,7 @@ module.exports = exports = function traverse(
     async *[Symbol.asyncIterator]() {
       const artifacts = { addons: [], assets: [] }
 
-      const queue = [
-        exports.module(entry, null, {}, artifacts, new Set(), opts)
-      ]
+      const queue = [exports.module(entry, null, {}, artifacts, new Set(), opts)]
 
       while (queue.length > 0) {
         const generator = queue.pop()
@@ -105,17 +107,11 @@ module.exports = exports = function traverse(
   }
 }
 
+exports.constants = constants
 exports.resolve = resolve
 
-exports.module = function* (
-  url,
-  source,
-  attributes,
-  artifacts,
-  visited,
-  opts = {}
-) {
-  const { resolutions = null } = opts
+exports.module = function* (url, source, attributes, artifacts, visited, opts = {}) {
+  const { resolutions = null, defaultType = constants.SCRIPT } = opts
 
   if (visited.has(url.href)) return false
 
@@ -123,36 +119,30 @@ exports.module = function* (
     source = yield { module: url }
 
     if (source === null) {
-      throw errors.MODULE_NOT_FOUND(
-        `Cannot find module '${url.href}'`,
-        url.href
-      )
+      throw errors.MODULE_NOT_FOUND(`Cannot find module '${url.href}'`, url.href)
     }
   }
 
   visited.add(url.href)
 
   if (resolutions) {
-    if (
-      yield* exports.preresolved(
-        url,
-        source,
-        resolutions,
-        artifacts,
-        visited,
-        opts
-      )
-    ) {
+    if (yield* exports.preresolved(url, source, resolutions, artifacts, visited, opts)) {
       return true
     }
   }
 
+  attributes = attributes || {}
+
   const imports = {}
 
+  let info = null
+
   for (const packageURL of lookupPackageScope(url, opts)) {
     const source = yield { module: packageURL }
 
     if (source !== null) {
+      info = JSON.parse(source)
+
       imports['#package'] = packageURL.href
 
       yield {
@@ -163,11 +153,7 @@ exports.module = function* (
     }
   }
 
-  if (
-    typeof attributes === 'object' &&
-    attributes !== null &&
-    typeof attributes.imports === 'string'
-  ) {
+  if (typeof attributes.imports === 'string') {
     const url = new URL(attributes.imports)
 
     const source = yield { module: url }
@@ -180,9 +166,80 @@ exports.module = function* (
     }
   }
 
-  yield* exports.imports(url, source, imports, artifacts, visited, opts)
+  let type = 0
+
+  if (typeof attributes.type === 'string') {
+    switch (attributes.type) {
+      case 'script':
+        type = constants.SCRIPT
+        break
+      case 'module':
+        type = constants.MODULE
+        break
+      case 'json':
+        type = constants.JSON
+        break
+      case 'bundle':
+        type = constants.BUNDLE
+        break
+      case 'addon':
+        type = constants.ADDON
+        break
+      case 'binary':
+        type = constants.BINARY
+        break
+      case 'text':
+        type = constants.TEXT
+        break
+    }
+  } else {
+    const match = url.pathname.match(/\.[a-z]+$/)
+
+    if (match !== null) {
+      const [extension] = match
+
+      switch (extension) {
+        case '.js':
+          const isESM =
+            defaultType === constants.MODULE || (info !== null && info.type === 'module')
+
+          type = isESM ? constants.MODULE : constants.SCRIPT
+          break
+        case '.cjs':
+          type = constants.SCRIPT
+          break
+        case '.mjs':
+          type = constants.MODULE
+          break
+        case '.json':
+          type = constants.JSON
+          break
+        case '.bundle':
+          type = constants.BUNDLE
+          break
+        case '.bare':
+        case '.node':
+          type = constants.ADDON
+          break
+        case '.bin':
+          type = constants.BINARY
+          break
+        case '.txt':
+          type = constants.TEXT
+          break
+      }
+    }
+  }
+
+  const lexer = { imports: [] }
 
-  yield { dependency: { url, source, imports: compressImportsMap(imports) } }
+  if (type === constants.SCRIPT || constants.MODULE) {
+    yield* exports.imports(url, source, imports, artifacts, lexer, visited, opts)
+  }
+
+  yield {
+    dependency: { url, source, imports: compressImportsMap(imports), lexer }
+  }
 
   return true
 }
@@ -195,7 +252,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) }
@@ -213,14 +270,7 @@ exports.package = function* (url, source, artifacts, visited, opts = {}) {
   return false
 }
 
-exports.preresolved = function* (
-  url,
-  source,
-  resolutions,
-  artifacts,
-  visited,
-  opts = {}
-) {
+exports.preresolved = function* (url, source, resolutions, artifacts, visited, opts = {}) {
   const imports = resolutions[url.href]
 
   if (typeof imports !== 'object' || imports === null) return false
@@ -249,19 +299,19 @@ exports.preresolved = function* (
     }
   }
 
-  yield { dependency: { url, source, imports: compressImportsMap(imports) } }
+  yield {
+    dependency: {
+      url,
+      source,
+      imports: compressImportsMap(imports),
+      lexer: { imports: [] }
+    }
+  }
 
   return true
 }
 
-exports.imports = function* (
-  parentURL,
-  source,
-  imports,
-  artifacts,
-  visited,
-  opts = {}
-) {
+exports.imports = function* (parentURL, source, imports, artifacts, lexer, visited, opts = {}) {
   const {
     resolve = exports.resolve.default,
     builtinProtocol = 'builtin:',
@@ -301,6 +351,8 @@ exports.imports = function* (
       })
     }
 
+    lexer.imports.push(entry)
+
     queue.push({ entry, specifier, condition })
   }
 
@@ -343,14 +395,7 @@ exports.imports = function* (
 
             for (const url of prefix) {
               yield {
-                children: exports.module(
-                  url,
-                  null,
-                  {},
-                  artifacts,
-                  visited,
-                  opts
-                )
+                children: exports.module(url, null, {}, artifacts, visited, opts)
               }
 
               addURL(artifacts.assets, url)
@@ -371,14 +416,7 @@ exports.imports = function* (
             }
 
             yield {
-              children: exports.module(
-                url,
-                source,
-                attributes,
-                artifacts,
-                visited,
-                opts
-              )
+              children: exports.module(url, source, attributes, artifacts, visited, opts)
             }
 
             resolved = yielded = true
@@ -397,36 +435,21 @@ exports.imports = function* (
 
     matchedConditions.pop()
 
-    let message = `Cannot find ${condition === 'default' ? 'module' : condition} '${specifier}' imported from '${parentURL.href}'`
+    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')
-    }
+      if (candidates.length > 0) {
+        message += '\nCandidates:'
+        message += '\n' + candidates.map((url) => '- ' + url.href).join('\n')
+      }
 
-    if (resolutions === 0) {
       switch (condition) {
         case 'addon':
-          throw errors.ADDON_NOT_FOUND(
-            message,
-            specifier,
-            parentURL,
-            candidates
-          )
+          throw errors.ADDON_NOT_FOUND(message, specifier, parentURL, candidates)
         case 'asset':
-          throw errors.ASSET_NOT_FOUND(
-            message,
-            specifier,
-            parentURL,
-            candidates
-          )
+          throw errors.ASSET_NOT_FOUND(message, specifier, parentURL, candidates)
         default:
-          throw errors.MODULE_NOT_FOUND(
-            message,
-            specifier,
-            parentURL,
-            candidates
-          )
+          throw errors.MODULE_NOT_FOUND(message, specifier, parentURL, candidates)
       }
     }
   }
@@ -474,13 +497,7 @@ exports.prebuilds = function* (packageURL, artifacts, visited, opts = {}) {
   return yielded
 }
 
-exports.assets = function* (
-  patterns,
-  parentURL,
-  artifacts,
-  visited,
-  opts = {}
-) {
+exports.assets = function* (patterns, parentURL, artifacts, visited, opts = {}) {
   const matches = yield* exports.patternMatches(patterns, parentURL, [], opts)
 
   let yielded = false
@@ -502,12 +519,7 @@ exports.assets = function* (
   return yielded
 }
 
-exports.patternMatches = function* patternMatches(
-  pattern,
-  parentURL,
-  matches,
-  opts = {}
-) {
+exports.patternMatches = function* patternMatches(pattern, parentURL, matches, opts = {}) {
   const { conditions = [], matchedConditions = [] } = opts
 
   if (typeof pattern === 'string') {
@@ -549,11 +561,7 @@ exports.patternMatches = function* patternMatches(
   } else if (typeof pattern === 'object' && pattern !== null) {
     let yielded = false
 
-    for (const [condition, patternValue, subset] of conditionMatches(
-      pattern,
-      conditions,
-      opts
-    )) {
+    for (const [condition, patternValue, subset] of conditionMatches(pattern, conditions, opts)) {
       matchedConditions.push(condition)
 
       if (
@@ -685,9 +693,7 @@ function mixinImports(target, imports, url) {
   }
 
   if (typeof imports !== 'object' || imports === null) {
-    throw errors.INVALID_IMPORTS_MAP(
-      `Imports map at '${url.href}' is not valid`
-    )
+    throw errors.INVALID_IMPORTS_MAP(`Imports map at '${url.href}' is not valid`)
   }
 
   return { ...target, ...imports }

package/lib/errors.js

@@ -1,5 +1,5 @@
 module.exports = class ModuleTraverseError extends Error {
-  constructor(msg, code, fn = ModuleTraverseError) {
+  constructor(msg, fn = ModuleTraverseError, code = fn.name) {
     super(`${code}: ${msg}`)
     this.code = code
 
@@ -13,11 +13,7 @@ module.exports = class ModuleTraverseError extends Error {
   }
 
   static MODULE_NOT_FOUND(msg, specifier, referrer = null, candidates = []) {
-    const err = new ModuleTraverseError(
-      msg,
-      'MODULE_NOT_FOUND',
-      ModuleTraverseError.MODULE_NOT_FOUND
-    )
+    const err = new ModuleTraverseError(msg, ModuleTraverseError.MODULE_NOT_FOUND)
 
     err.specifier = specifier
     err.referrer = referrer
@@ -27,11 +23,7 @@ module.exports = class ModuleTraverseError extends Error {
   }
 
   static ADDON_NOT_FOUND(msg, specifier, referrer = null, candidates = []) {
-    const err = new ModuleTraverseError(
-      msg,
-      'ADDON_NOT_FOUND',
-      ModuleTraverseError.ADDON_NOT_FOUND
-    )
+    const err = new ModuleTraverseError(msg, ModuleTraverseError.ADDON_NOT_FOUND)
 
     err.specifier = specifier
     err.referrer = referrer
@@ -41,11 +33,7 @@ module.exports = class ModuleTraverseError extends Error {
   }
 
   static ASSET_NOT_FOUND(msg, specifier, referrer = null, candidates = []) {
-    const err = new ModuleTraverseError(
-      msg,
-      'ASSET_NOT_FOUND',
-      ModuleTraverseError.ASSET_NOT_FOUND
-    )
+    const err = new ModuleTraverseError(msg, ModuleTraverseError.ASSET_NOT_FOUND)
 
     err.specifier = specifier
     err.referrer = referrer
@@ -55,10 +43,6 @@ module.exports = class ModuleTraverseError extends Error {
   }
 
   static INVALID_IMPORTS_MAP(msg) {
-    return new ModuleTraverseError(
-      msg,
-      'INVALID_IMPORTS_MAP',
-      ModuleTraverseError.INVALID_IMPORTS_MAP
-    )
+    return new ModuleTraverseError(msg, ModuleTraverseError.INVALID_IMPORTS_MAP)
   }
 }

package/lib/resolve/bare.d.ts

@@ -8,11 +8,7 @@ interface BareResolveOptions extends ResolveOptions {
   target?: string[]
 }
 
-declare function resolve(
-  entry: Import,
-  parentURL: URL,
-  opts?: BareResolveOptions
-): Resolver
+declare function resolve(entry: Import, parentURL: URL, opts?: BareResolveOptions): Resolver
 
 declare namespace resolve {
   export { type BareResolveOptions }

package/lib/resolve/default.d.ts

@@ -1,10 +1,6 @@
 import { type Import } from 'bare-module-lexer'
 import { type ResolveOptions, type Resolver } from 'bare-addon-resolve'
 
-declare function resolve(
-  entry: Import,
-  parentURL: URL,
-  opts?: ResolveOptions
-): Resolver
+declare function resolve(entry: Import, parentURL: URL, opts?: ResolveOptions): Resolver
 
 export = resolve

package/lib/resolve/node.d.ts

@@ -8,11 +8,7 @@ interface NodeResolveOptions extends ResolveOptions {
   target?: string[]
 }
 
-declare function resolve(
-  entry: Import,
-  parentURL: URL,
-  opts?: NodeResolveOptions
-): Resolver
+declare function resolve(entry: Import, parentURL: URL, opts?: NodeResolveOptions): Resolver
 
 declare namespace resolve {
   export { type NodeResolveOptions }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-module-traverse",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "description": "Low-level module graph traversal for Bare",
   "exports": {
     ".": {
@@ -62,7 +62,7 @@
     "bare-url": "^2.1.3",
     "brittle": "^3.2.1",
     "prettier": "^3.4.2",
-    "prettier-config-standard": "^7.0.0"
+    "prettier-config-holepunch": "^2.0.0"
   },
   "peerDependencies": {
     "bare-buffer": "*",