require all folders as modules inside folder?

Question

I've got a lot of folders as modules that contains my rest api, the structure is the following:

app
|— server
|  |— rest-api
|  |  |— v1
|  |  |  |— module-one
|  |  |  |— module-two
|  |  |  |— module-three
|  |  |  |— module-x
|  |  |  └── index.js
|  |  └──...
|  └──...
|— ...
└── server.js

What I want to avoid at v1/index.js is the following:

module.exports = (function () {

    var express      = require( 'express' ),
        router       = express.Router(),
        module_one   = require( './module-one' ),
        module_two   = require( './module-two' ),
        module_three = require( './module-three' );
    //...

    router.use( module_one );
    router.use( module_two );
    router.use( module_three );
    //...

    return router;

})();

Is there a way to read all them at once?

score 2 · Accepted Answer · edited May 23 '17 at 12:15

2

You could modify the answer from this SO post

var fs = require('fs'),
    path = require('path');

function loadAllModules(srcpath, router) {
  return fs.readdirSync(srcpath).filter(function(file) {
    if(fs.statSync(path.join(srcpath, file)).isDirectory()) {
      var module = require('./' + file);
      router.use(module)
    }
  });
}

And then use it like:

loadAllModules(__dirname, router)

module.exports = (function () {

    var express      = require( 'express' ),
        router       = express.Router();
    //...

    loadAllModules(__dirname, router);
    return router;

})();

edited May 23 '17 at 12:15

Community

1
1

answered Nov 24 '15 at 02:11

nbermudezs

2,814
1
20
20

Can I declare `loadAllModules` at `server.js` and use it at `/server/rest-api/v1/index.js`? – Jonathan Solorzano Nov 24 '15 at 02:39
You could declare it under `GLOBAL` inside `server.js` to have it accessible everywhere. `GLOBAL.loadAllModules = function(directory, router) {...}` – nbermudezs Nov 24 '15 at 02:42
What do you mean by `__dirname`? – Jonathan Solorzano Nov 24 '15 at 02:42
http://stackoverflow.com/questions/8131344/what-is-the-difference-between-dirname-and-in-node-js – nbermudezs Nov 24 '15 at 02:43
I mean the current directory – nbermudezs Nov 24 '15 at 02:44
It worked, but what would be the difference between sync vs async in this case? – Jonathan Solorzano Nov 24 '15 at 02:48
Yes, sync guarantees you that all the `require` will be done when the function ends and the control is handed over to `server.js` again and eventually hit the `server.listen` line – nbermudezs Nov 24 '15 at 02:50

Hiren S. · Answer 2 · 2015-11-24T06:36:04.257

2

https://www.npmjs.com/package/require-all

Check this module, if it fulfills your node.

We have used this module for requiring all Mongoose Schema And Controllers.

Update:

var controllers = require('require-all')({
    dirname     :  __dirname + '/server/rest-api/',
    filter      :  'index.js',
    recursive   : true
});

edited Nov 24 '15 at 06:36

answered Nov 24 '15 at 05:40

Hiren S.

2,793
15
25

Would you like to make an example according to the situation?, require only folders, or index.js under each folder of a folder... – Jonathan Solorzano Nov 24 '15 at 05:47
I have Updated example for your situation. – Hiren S. Nov 24 '15 at 05:58
But what about the index.js from where that is called, will it be recalled? – Jonathan Solorzano Nov 24 '15 at 06:33
Assign dirname property from which you want to require, from that it will check all folders recursively and require it's index.js – Hiren S. Nov 24 '15 at 06:36

require all folders as modules inside folder?

2 Answers2