Support 'paths' option

[Danetag]

I probably do something wrong, but I'm building a webpack application (classic CommonJS app), and documentationjs seems to stop at the main.js without resolving the required modules.

'use strict';

var App      = require('app/app');

/**
 * Main module - App entry point
 * @module Main
 */

var Main = function(){};



/**
 * Callback fired once the document is ready
 * @public
 */
Main.prototype.onReady = function() {
  var app = new App();
  app.init();
}


var main = module.exports = new Main();

What do I do wrong? Thanks!

[tmcw]

var App = require('app/app');

So app is an external module? I would expect this to be require('./app/app') if it was a local dependency.

[Danetag]

Wow it totally worked...Thanks! There's no work around except "./"? Seems overkill as the require system works perfectly without :(

[tmcw]

That part of the system is derived from browserify, and browserify rejects this input: if a require statement doesn't begin with ./, then it does not consider it internal. Oddly enough node accepts this input but there aren't any issues in browserify about this.

[Danetag]

Hmm, I just switched the app from a browserify app to a webpack one, and browserify compiled it well before.. Hmm. Anyway, thanks for the tips!

[Danetag]

I actually give to webpack/browserify an array of entry paths for the module definitions, array that documentjs doesn't have :( There's no way to specify such a thing?

[tmcw]

Could you be a little clearer? What option do you use in particular with browserify/webpack? Documentation.js supports multiple entry points as multiple args to the binary or as an array to the API level.

[Danetag]

Sorry! Here's the webpack config I'm using

module.exports = {
    entry: "./app/scripts/project/main.js",
    output: {
        path: __dirname,
        filename: "../app/js/bundle.js"
    },
    module: {
        loaders: [
            { test: /\.css$/, loader: "style!css" },
            { test: /\.html$/, loader: "handlebars-loader" }
        ]
    },
    resolve: {
        extensions: ['', '.js', '.json', '.css'],
        modulesDirectories: ["app/scripts/project", "app/scripts/project/app", "node_modules", "tpl"]
    },
    resolveLoader: {
        fallback: path.join(__dirname, 'node_modules'),
        alias: {
          'hbs': 'handlebars-loader'
        }
    },
    node: {
        fs: "empty" // avoids error messages 
    }
};

I'm using gulp on top of it (so gulp-documentation as well)

[tmcw]

Is there an equivalent option in browserify? I'm a little hesitant to pursue webpack-isms, since they deviate pretty far from what CommonJS & node do.

[Danetag]

Sure!

  var b = browserify({ 
      cache: {},
      packageCache: {},
      fullPaths: true,
      extensions: ['.html'], 
      paths: ["app/scripts/project", "app/scripts/project/app", "node_modules", "tpl"],
      debug: true
  });

[tmcw]

👍 thanks, looks like we can pass a paths option into resolve.

[Danetag]

Would be awesome!

[fgarcia]

just one small wish since it has not being mentioned, resolving paths from NODE_PATH would be great

[richard-uk1]

+1 for resolving from NODE_PATH, this would allow me to bypass my multiple roots in webpack by just including those folders in my NODE_PATH. I believe module-deps already does this (from https://github.com/substack/module-deps)

opts.paths - array of global paths to search. Defaults to splitting on ':' in process.env.NODE_PATH