refactor migrate NodeDepper.add to Depper.add

glslify · Nov 17, 2020 · 35fb74f · 35fb74f
1 parent 49ea8ad
commit 35fb74f
Show file tree

Hide file tree

Showing 3 changed files with 141 additions and 108 deletions.
diff --git a/depper.js b/depper.js
@@ -9,6 +9,9 @@ var {
   genInlineName,
   cacheWrap,
   parseFiles,
+  getImportName,
+  extractPreprocessors,
+  asyncify,
 } = require('./utils.js')
 
 
@@ -143,10 +146,76 @@ Depper.prototype.inline = function(source, basedir, done) {
 }
 
 /**
- * Add method dummy interface
+ * Adds a shader file to the graph, including its dependencies
+ * which are resolved in this step. Transforms are also applied
+ * in the process too, as they may potentially add or remove dependent
+ * modules.
+ *
+ * @param {String} filename The absolute path of this file.
+ * @param {Object} [opts] The options will be pased to _resolveImports function.
+ * @param {(err: Error, deps?: object[]) => any} [done]
+ *
+ * If async is defined then `done` callback will be called when the entire graph has been
+ * resolved, and will include an array of dependencies discovered
+ * so far as its second argument.
+ *
+ * If sync returns an array of dependencies discovered so far as its second argument.
  */
-Depper.prototype.add = function(filename, cb) {
+Depper.prototype.add = function(filename, opts, done) {
+  if (typeof opts === 'function') {
+    done = opts
+    opts = {}
+  }
 
+  var self    = this
+  var exports = []
+  var imports = []
+  var dep = this._addDep(filename)
+  var resolveOpts = Object.assign({
+    deps: dep.deps,
+  }, opts)
+
+  var process = asyncify(
+    function(_, next) {return self.readFile(filename, next) },
+    function(_, next) {return self.getTransformsForFile(filename, next) },
+    function(result, next) {
+      // @ts-ignore
+      self.emit('file', filename)
+      return self.applyTransforms(filename, result[0], result[1], next)
+    },
+    function(result, next) {
+      extractPreprocessors(dep.source = result[2], imports, exports)
+      return self._resolveImports(imports, resolveOpts, next)
+    }, function(_, next) {
+      if(next) {
+        next(null, self._deps)
+      }
+    })
+
+
+  if (this._async) {
+    process(done || function() {
+      console.warn('glslify-deps: depper.add() has not a callback defined using async flow')
+    })
+    return dep
+  } else {
+    process()
+    return this._deps
+  }
+}
+
+/**
+ * Dummy internal function for resolve transforms for a file
+ * @param {String} filename The absolute path of the file in question.
+ * @param {(err: Error, transforms?: GlslTransform[]) => any} [done] Applies when async true
+ * @returns {GlslTransform[]} List of transform for a file
+ */
+Depper.prototype.getTransformsForFile = function(filename, done) {
+  if(done) {
+    done(null, [])
+  }
+  console.warn('glslify-deps: depper.getTransformsForFile() not yet implemented')
+  return []
 }
 
 /**
@@ -272,7 +341,7 @@ Depper.prototype.applyTransforms = function(filename, src, transforms, done) {
 
 /**
  * Internal method to add dependencies
- * @param {object} extra
+ * @param {object} [extra]
  */
 Depper.prototype._addDep = function(file, extra) {
   var dep = Object.assign({
@@ -318,6 +387,62 @@ Depper.prototype._register = function(transforms, cb) {
   return result
 }
 
+/**
+ * Internal async method to retrieve dependencies
+ * resolving imports using the internal cache
+ *
+ * @param {string[]} imports
+ * @param {object} [opts] The options will be pased to resolve function.
+ * @param {object} [opts.deps] Existing dependencies
+ * @param {number} [opts.parallel=10] Parallel threads when async
+ * @param {(err: Error) => any} [done]
+ * @return {object} Resolved dependencies
+ */
+Depper.prototype._resolveImports = function(imports, opts, done) {
+  if (typeof opts === 'function') {
+    done = opts
+    opts = {}
+  }
+  var self = this
+  var deps = opts && opts.deps || {}
+  var parallel = opts && opts.parallel || 10
+
+  var process = asyncify(
+    function(result, next) { return self.resolve(result[0], opts, next) },
+    function(result, next) {
+      var importName = result[0]
+      var resolved = result[1]
+      if (self._cache[resolved]) {
+        deps[importName] = self._cache[resolved].id
+        return next && next()
+      }
+      if (next) {
+        self._cache[resolved] = self.add(resolved, function(err) {
+          if (err) return next(err)
+          deps[importName] = self._cache[resolved].id
+          next()
+        })
+      } else {
+        var idx = self._i
+        self._cache[resolved] = self.add(resolved)[idx]
+        deps[importName] = self._cache[resolved].id
+      }
+    }
+  )
+
+  if (this._async) {
+    map(imports, parallel, function(imp, next) {
+      process([getImportName(imp)], next)
+    }, done)
+  } else {
+    imports.forEach(function (imp) {
+      process([getImportName(imp)])
+    })
+  }
+
+  return deps
+}
+
 Depper.prototype.readFile = function(filename, done) {
   if (path.basename(filename) !== this._inlineName)
     return this._readFile(filename, done)

diff --git a/node.js b/node.js
@@ -9,11 +9,8 @@ var glslResolve = require('glsl-resolve')
 var transformRequire = require('./transform-require')
 
 var {
-  getImportName,
-  extractPreprocessors,
   getTransformsFromPkg,
   mix,
-  asyncify
 } = require('./utils');
 
 function createDefaultRead() {
@@ -30,7 +27,10 @@ function createDefaultRead() {
 
 /**
  *
- * @class
+ * @constructor
+ * @param {string} cwd
+ *//**
+ * @constructor
  * @param {DepperOptions} opts
  */
 function NodeDepper(opts) {
@@ -45,109 +45,15 @@ function NodeDepper(opts) {
 }
 
 /**
- * Adds a shader file to the graph, including its dependencies
- * which are resolved in this step. Transforms are also applied
- * in the process too, as they may potentially add or remove dependent
- * modules.
- *
+ * @override
  * @param {String} filename The absolute path of this file.
  * @param {(err: Error, deps?: object[]) => any} [done]
- *
- * If async is defined then `done` callback will be called when the entire graph has been
- * resolved, and will include an array of dependencies discovered
- * so far as its second argument.
- *
- * If sync returns an array of dependencies discovered so far as its second argument.
  */
 NodeDepper.prototype.add = function(filename, done) {
-  var basedir = path.dirname(filename = path.resolve(filename))
-  var self    = this
-  var exports = []
-  var imports = []
-
-  var dep = this._addDep(filename)
-
-  var process = asyncify(
-    function(_, next) {return self.readFile(filename, next) },
-    function(_, next) {return self.getTransformsForFile(filename, next) },
-    function(result, next) {
-      self.emit('file', filename)
-      return self.applyTransforms(filename, result[0], result[1], next)
-    },
-    function(result, next) {
-      extractPreprocessors(dep.source = result[2], imports, exports)
-      return self._resolveImports(imports, {
-          deps: dep.deps,
-          basedir: basedir
-      }, next)
-    }, function(_, next) {
-      if(next) {
-        next(null, self._deps)
-      }
-    })
-
-
-  if (this._async) {
-    process(done || function() {
-      console.warn('glslify-deps: depper.add() has not a callback defined using async flow')
-    })
-    return dep
-  } else {
-    process()
-    return this._deps
-  }
-}
-
-/**
- * Internal async method to retrieve dependencies
- * resolving imports using the internal cache
- *
- * @param {string[]} imports
- * @param {object} opts extends options for https://www.npmjs.com/package/resolve
- * @param {object} opts.deps existing dependencies
- * @param {(err: Error) => any} [done]
- * @return {object} resolved dependencies
- */
-NodeDepper.prototype._resolveImports = function(imports, opts, done) {
-  opts = opts || {}
-  var self = this
-  var deps = opts.deps || {}
-  var parallel = opts.parallel || 10
-
-  var process = asyncify(
-    function(result, next) { return self.resolve(result[0], opts, next) },
-    function(result, next) {
-      var importName = result[0]
-      var resolved = result[1]
-      if (self._cache[resolved]) {
-        deps[importName] = self._cache[resolved].id
-        return next && next()
-      }
-      if (next) {
-        self._cache[resolved] = self.add(resolved, function(err) {
-          if (err) return next(err)
-          deps[importName] = self._cache[resolved].id
-          next()
-        })
-      } else {
-        var idx = self._i
-        self._cache[resolved] = self.add(resolved)[idx]
-        deps[importName] = self._cache[resolved].id
-      }
-    }
-  )
-
-  if (this._async) {
-    map(imports, parallel, function(imp, next) {
-      process([getImportName(imp)], next)
-    }, done)
-  } else {
-    imports.forEach(function (imp) {
-      process([getImportName(imp)])
-    })
-  }
-
-  return deps
+  var resolved = path.resolve(filename);
+  return Depper.prototype.add.call(this, resolved, {
+    basedir: path.dirname(resolved)
+  }, done)
 }
 
 /**
@@ -162,6 +68,7 @@ NodeDepper.prototype._resolveImports = function(imports, opts, done) {
  *
  * @param {String} filename The absolute path of the file in question.
  * @param {(err: Error, transforms?: GlslTransform[]) => any} [done] Applies when async true
+ * @returns {GlslTransform[]} List of transform for a file
  */
 NodeDepper.prototype.getTransformsForFile = function(filename, done) {
   var self  = this

diff --git a/utils.js b/utils.js
@@ -129,13 +129,14 @@ function mix(sync, async) {
   return mixed
 }
 
+
 /**
  * Allows reuse sync/async logics detecting if done is defined to select which strategy to use.
  * Arguments must be functions, if sync is detected then takes the returned value,
  * otherwise when async next will be defined and will take the result from there
  *
- * @param {...(prevState: any[], next?: (err: Error, result?: any) => null) => any} args
- * @returns {(initialState?: any[], done?: (err: Error, state?: any[]) => any) => any[]}
+ * @param {...(prevState: any[], next?: (err?: Error, result?: any) => null) => any} args
+ * @returns {((initialState?: any[], done?: (err: Error, state?: any[]) => any) => any[])&((done?: (err: Error, state?: any[]) => any) => any[])}
  * @example
  *
  * const process = asyncify(