Provide more helpful errors when trying to require non-existent modules

Author: walterhiggins

src/main/js/lib/find.js

@@ -0,0 +1,29 @@
+'use strict';
+var File = java.io.File;
+module.exports = function find(dir, filter) {
+  var result = [];
+  function recurse( dir, store ) {
+    var files, 
+	len,
+	i,
+	file,
+	dirfile = new File( dir );
+    
+    if ( typeof filter == 'undefined' ) {
+      files = dirfile.list();
+    } else {
+      files = dirfile.list(filter);
+    }
+    len = files.length; i = 0;
+    for (; i < len; i++){
+      file = new File( dir + '/' + files[i] );
+      if ( file.isDirectory() ) {
+        recurse( file.canonicalPath, store );
+      } else {
+        store.push( ('' + file.canonicalPath).replace(/\\\\/g,'/') );
+      }
+    }
+  }
+  recurse( dir, result );
+  return result;
+};

src/main/js/lib/plugin.js

@@ -1,14 +1,15 @@
 'use strict';
 /*global persist,exports,config,__plugin,require*/
 var File = java.io.File,
-  FileWriter = java.io.FileWriter,
-  PrintWriter = java.io.PrintWriter;
+    FileWriter = java.io.FileWriter,
+    PrintWriter = java.io.PrintWriter,
+    find = require('./find');
 /*
   plugin management
 */
 var _plugins = {};
 
-var _plugin = function(/* String */ moduleName, /* Object */ moduleObject, isPersistent ) {
+function _plugin(/* String */ moduleName, /* Object */ moduleObject, isPersistent ) {
   //
   // don't load plugin more than once
   //
@@ -26,67 +27,46 @@ var _plugin = function(/* String */ moduleName, /* Object */ moduleObject, isPer
     moduleObject.store = persist( moduleName, moduleObject.store );
   }
   return moduleObject;
-};
+}
 
-exports.plugin = _plugin;
-
-exports.autoload = function( context, pluginDir, options ) {
-  var _canonize = function( file ) { 
-    return '' + file.canonicalPath.replaceAll('\\\\','/'); 
-  };
-  /*
-   recursively walk the given directory and return a list of all .js files 
-   */
-  var _listSourceFiles = function( store, dir ) {
-    var files = dir.listFiles(),
-      file;
-    if ( !files ) {
-      return;
-    }
-    for ( var i = 0; i < files.length; i++ ) {
-      file = files[i];
-      if ( file.isDirectory( ) ) {
-        _listSourceFiles( store, file );
-      }else{
-        if ( file.canonicalPath.endsWith( '.js' ) ) {
-          store.push( file );
-        }
-      }
-    }
-  };
+function _autoload( context, pluginDir, options ) {
   /*
    Reload all of the .js files in the given directory 
    */
-  (function( pluginDir ) {
-    var sourceFiles = [],
+  var sourceFiles = [],
       property,
       module,
       pluginPath;
-    _listSourceFiles( sourceFiles, pluginDir );
+  sourceFiles = find(pluginDir);
 
-    var len = sourceFiles.length;
-    if ( config && config.verbose ) {
-      console.info( len + ' scriptcraft plugins found in ' + pluginDir );
-    }
+  var len = sourceFiles.length;
+  if ( config && config.verbose ) {
+    console.info( len + ' scriptcraft plugins found in ' + pluginDir );
+  }
 
-    for ( var i = 0; i < len; i++ ) {
+  for ( var i = 0; i < len; i++ ) {
 
-      pluginPath = _canonize( sourceFiles[i] );
-      module = {};
+    pluginPath = sourceFiles[i];
+    if (!pluginPath.match(/\.js$/)){
+      continue;
+    }
+    module = {};
 
-      try {
-        module = require( pluginPath , options);
-        for ( property in module ) {
-          /*
-           all exports in plugins become members of context object
-           */
-          context[property] = module[property];
-        }
-      } catch ( e ) {
-	var msg = 'Plugin ' + pluginPath + ' ' + e ;
-	console.error( msg );
+    try {
+      module = require( pluginPath , options);
+      for ( property in module ) {
+        /*
+         all exports in plugins become members of context object
+         */
+        context[property] = module[property];
       }
+    } catch ( e ) {
+      var msg = 'Plugin ' + pluginPath + ' ' + e ;
+      console.error( msg );
     }
-  }(pluginDir));
-};
+  }
+
+}
+exports.plugin = _plugin;
+exports.autoload = _autoload; 
 

src/main/js/lib/require.js

@@ -65,8 +65,20 @@ module specification, the '.js' suffix is optional.
   var File = java.io.File,
     FileReader = java.io.FileReader,
     BufferedReader = java.io.BufferedReader;
+
+  function fileExists( file ) {
+    if ( file.isDirectory() ) {
+      return readModuleFromDirectory( file );
+    } else {
+      return file;
+    }
+  }
+
+  function _canonize(file){ 
+    return "" + file.canonicalPath.replaceAll("\\\\","/"); 
+  }
 
-  var readModuleFromDirectory = function( dir ) {
+  function readModuleFromDirectory( dir ) {
 
     // look for a package.json file
     var pkgJsonFile = new File( dir, './package.json' );
@@ -87,19 +99,8 @@ module specification, the '.js' suffix is optional.
         return null;
       }
     }
-  };
-
-  var fileExists = function( file ) {
-    if ( file.isDirectory() ) {
-      return readModuleFromDirectory( file );
-    } else {
-      return file;
-    }
-  };
+  }
 
-  var _canonize = function(file){ 
-    return "" + file.canonicalPath.replaceAll("\\\\","/"); 
-  };
 
 /**********************************************************************
 ### module name resolution
@@ -135,7 +136,7 @@ When resolving module names to file paths, ScriptCraft uses the following rules.
     3.2 if no package.json file exists then look for an index.js file in the directory
 
 ***/
-  var resolveModuleToFile = function ( moduleName, parentDir ) {
+  function resolveModuleToFile( moduleName, parentDir ) {
     var file = new File(moduleName),
       i = 0,
       pathWithJSExt,
@@ -179,13 +180,11 @@ When resolving module names to file paths, ScriptCraft uses the following rules.
       }
     }
     return null;
-  };
-  var _loadedModules = {};
-  var _format = java.lang.String.format;
+  }
   /*
    require() function implementation
    */
-  var _require = function( parentFile, path, options ) {
+  function _require( parentFile, path, options ) {
     var file,
         canonizedFilename,
         moduleInfo,
@@ -209,6 +208,29 @@ When resolving module names to file paths, ScriptCraft uses the following rules.
       if (! ( (''+path).match( /^\./ ) ) ) {
         errMsg = errMsg + ' and not found in paths ' + JSON.stringify(modulePaths);
       }
+      var find = _require(parentFile, 'find').exports;
+      var allJS = [];
+      for (var i = 0;i < modulePaths.length; i++){
+	var js = find( modulePaths[i] );
+	for (var j = 0;j < js.length; j++){
+	  if (js[j].match(/\.js$/)){
+	    allJS.push( js[j].replace(modulePaths[i],'') );
+	  }
+	}
+      }
+      var pathL = path.toLowerCase();
+      var candidates = [];
+      for (i = 0;i < allJS.length;i++){
+	var filenameparts = allJS[i];
+	var candidate = filenameparts.replace(/\.js/,'') ;
+	var lastpart = candidate.toLowerCase();
+	if (pathL.indexOf(lastpart) > -1 || lastpart.indexOf(pathL) > -1){
+	  candidates.push(candidate);
+	}
+      }
+      if (candidates.length > 0){
+	errMsg += '\nBut found module/s named: ' + candidates.join(',') + ' - is this what you meant?';
+      }
       throw new Error(errMsg);
     }
     canonizedFilename = _canonize(file);
@@ -285,14 +307,16 @@ When resolving module names to file paths, ScriptCraft uses the following rules.
     }
     moduleInfo.loaded = true;
     return moduleInfo;
-  };
+  }
 
-  var _requireClosure = function( parent ) {
-    return function( path, options ) {
+  function _requireClosure( parent ) {
+    return function requireBoundToParent( path, options ) {
       var module = _require( parent, path , options);
       return module.exports;
     };
-  };
+  }
+  var _loadedModules = {};
+  var _format = java.lang.String.format;
   return _requireClosure( new java.io.File(rootDir) );
   // last line deliberately has no semicolon!
 })