Como exijo todos os arquivos em uma pasta no node.js?
precisa de algo como:
files.forEach(function (v,k){
// require routes
require('./routes/'+v);
}};
Como exijo todos os arquivos em uma pasta no node.js?
precisa de algo como:
files.forEach(function (v,k){
// require routes
require('./routes/'+v);
}};
Respostas:
Quando require é fornecido com o caminho de uma pasta, ele procura um arquivo index.js nessa pasta; se houver, ele usa isso e, se não houver, falha.
Provavelmente faria mais sentido (se você tiver controle sobre a pasta) criar um arquivo index.js, atribuir todos os "módulos" e simplesmente exigir isso.
yourfile.js
var routes = require("./routes");
index.js
exports.something = require("./routes/something.js");
exports.others = require("./routes/others.js");
Se você não souber os nomes dos arquivos, escreva algum tipo de carregador.
Exemplo de trabalho de um carregador:
var normalizedPath = require("path").join(__dirname, "routes");
require("fs").readdirSync(normalizedPath).forEach(function(file) {
require("./routes/" + file);
});
// Continue application logic here
require
receber o caminho de uma pasta, ele procurará por uma index.js
nessa pasta; se houver, ele usa isso e, se não houver, falha. Veja github.com/christkv/node-mongodb-native para obter um exemplo do mundo real disso:index.js
diretório raiz que requer ./lib/mongodb
um diretório; ./lib/mongodb/index.js'
disponibiliza todo o resto desse diretório.
require
é uma função síncrona, portanto não há benefícios no retorno de chamada. Eu usaria o fs.readdirSync.
package.json
nesse diretório. Assim:{main: './lib/my-custom-main-file.js'}
Eu recomendo usar glob para realizar essa tarefa.
var glob = require( 'glob' )
, path = require( 'path' );
glob.sync( './routes/**/*.js' ).forEach( function( file ) {
require( path.resolve( file ) );
});
glob
? você quer dizer glob-savior-of-the-nodejs-race
. Melhor resposta.
Com base na solução do @ tbranyen, crio um index.js
arquivo que carrega javascripts arbitrários na pasta atual como parte do exports
.
// Load `*.js` under current directory as properties
// i.e., `User.js` will become `exports['User']` or `exports.User`
require('fs').readdirSync(__dirname + '/').forEach(function(file) {
if (file.match(/\.js$/) !== null && file !== 'index.js') {
var name = file.replace('.js', '');
exports[name] = require('./' + file);
}
});
Então você pode require
este diretório de qualquer outro lugar.
Outra opção é usar o pacote require-dir, que é o seguinte. Ele também suporta recursão.
var requireDir = require('require-dir');
var dir = requireDir('./path/to/dir');
require-dir
porque exclui automaticamente o arquivo de chamada (índice) e o padrão é o diretório atual. Perfeito.
require-dir
adicionou uma filter
opção.
Eu tenho uma pasta / campos cheios de arquivos com uma única classe cada, ex:
fields/Text.js -> Test class
fields/Checkbox.js -> Checkbox class
Solte isso em fields / index.js para exportar cada classe:
var collectExports, fs, path,
__hasProp = {}.hasOwnProperty;
fs = require('fs');
path = require('path');
collectExports = function(file) {
var func, include, _results;
if (path.extname(file) === '.js' && file !== 'index.js') {
include = require('./' + file);
_results = [];
for (func in include) {
if (!__hasProp.call(include, func)) continue;
_results.push(exports[func] = include[func]);
}
return _results;
}
};
fs.readdirSync('./fields/').forEach(collectExports);
Isso faz com que os módulos funcionem mais como em Python:
var text = new Fields.Text()
var checkbox = new Fields.Checkbox()
Mais uma opção são os recursos de combinação require-dir-all dos pacotes mais populares.
O mais popular require-dir
não possui opções para filtrar os arquivos / diretórios e não possui map
função (veja abaixo), mas usa um pequeno truque para encontrar o caminho atual do módulo.
Em segundo lugar, a popularidade require-all
tem filtragem e pré-processamento regexp, mas não possui caminho relativo, então você precisa usar __dirname
(isso tem prós e contras) como:
var libs = require('require-all')(__dirname + '/lib');
Mencionado aqui require-index
é bastante minimalista.
Com map
você, você pode fazer um pré-processamento, como criar objetos e passar valores de configuração (assumindo módulos abaixo dos construtores de exportações):
// Store config for each module in config object properties
// with property names corresponding to module names
var config = {
module1: { value: 'config1' },
module2: { value: 'config2' }
};
// Require all files in modules subdirectory
var modules = require('require-dir-all')(
'modules', // Directory to require
{ // Options
// function to be post-processed over exported object for each require'd module
map: function(reqModule) {
// create new object with corresponding config passed to constructor
reqModule.exports = new reqModule.exports( config[reqModule.name] );
}
}
);
// Now `modules` object holds not exported constructors,
// but objects constructed using values provided in `config`.
Eu sei que esta pergunta tem mais de 5 anos e as respostas dadas são boas, mas eu queria algo um pouco mais poderoso para o express, então criei o express-map2
pacote para o npm. Eu ia dar o nome simplesmente express-map
, no entanto, as pessoas no yahoo já têm um pacote com esse nome, então tive que renomear meu pacote.
1. uso básico:
app.js (or whatever you call it)
var app = require('express'); // 1. include express
app.set('controllers',__dirname+'/controllers/');// 2. set path to your controllers.
require('express-map2')(app); // 3. patch map() into express
app.map({
'GET /':'test',
'GET /foo':'middleware.foo,test',
'GET /bar':'middleware.bar,test'// seperate your handlers with a comma.
});
uso do controlador:
//single function
module.exports = function(req,res){
};
//export an object with multiple functions.
module.exports = {
foo: function(req,res){
},
bar: function(req,res){
}
};
2. uso avançado, com prefixos:
app.map('/api/v1/books',{
'GET /': 'books.list', // GET /api/v1/books
'GET /:id': 'books.loadOne', // GET /api/v1/books/5
'DELETE /:id': 'books.delete', // DELETE /api/v1/books/5
'PUT /:id': 'books.update', // PUT /api/v1/books/5
'POST /': 'books.create' // POST /api/v1/books
});
Como você pode ver, isso economiza uma tonelada de tempo e simplifica muito o roteamento de seu aplicativo, para escrever, manter e entender. Ele suporta todos os verbos http que expressam suporte, bem como o .all()
método especial .
Um módulo que eu tenho usado para esse caso de uso exato é exigir tudo .
Requer recursivamente todos os arquivos em um determinado diretório e seus subdiretórios, desde que não correspondam à excludeDirs
propriedade.
Ele também permite especificar um filtro de arquivo e como derivar as chaves do hash retornado dos nomes dos arquivos.
Estou usando os módulos de nó copy-to module para criar um único arquivo para exigir todos os arquivos em nosso sistema baseado em NodeJS.
O código para o nosso arquivo utilitário se parece com o seguinte:
/**
* Module dependencies.
*/
var copy = require('copy-to');
copy(require('./module1'))
.and(require('./module2'))
.and(require('./module3'))
.to(module.exports);
Em todos os arquivos, a maioria das funções é gravada como exportação, assim:
exports.function1 = function () { // function contents };
exports.function2 = function () { // function contents };
exports.function3 = function () { // function contents };
Então, para usar qualquer função de um arquivo, basta chamar:
var utility = require('./utility');
var response = utility.function2(); // or whatever the name of the function is
Expandindo nesta glob
solução. Faça isso se desejar importar todos os módulos de um diretório index.js
e, em seguida, importe-o index.js
em outra parte do aplicativo. Observe que os literais de modelo não são suportados pelo mecanismo de destaque usado pelo stackoverflow, portanto, o código pode parecer estranho aqui.
const glob = require("glob");
let allOfThem = {};
glob.sync(`${__dirname}/*.js`).forEach((file) => {
/* see note about this in example below */
allOfThem = { ...allOfThem, ...require(file) };
});
module.exports = allOfThem;
Exemplo completo
Estrutura de diretórios
globExample/example.js
globExample/foobars/index.js
globExample/foobars/unexpected.js
globExample/foobars/barit.js
globExample/foobars/fooit.js
globExample / example.js
const { foo, bar, keepit } = require('./foobars/index');
const longStyle = require('./foobars/index');
console.log(foo()); // foo ran
console.log(bar()); // bar ran
console.log(keepit()); // keepit ran unexpected
console.log(longStyle.foo()); // foo ran
console.log(longStyle.bar()); // bar ran
console.log(longStyle.keepit()); // keepit ran unexpected
globExample / foobars / index.js
const glob = require("glob");
/*
Note the following style also works with multiple exports per file (barit.js example)
but will overwrite if you have 2 exports with the same
name (unexpected.js and barit.js have a keepit function) in the files being imported. As a result, this method is best used when
your exporting one module per file and use the filename to easily identify what is in it.
Also Note: This ignores itself (index.js) by default to prevent infinite loop.
*/
let allOfThem = {};
glob.sync(`${__dirname}/*.js`).forEach((file) => {
allOfThem = { ...allOfThem, ...require(file) };
});
module.exports = allOfThem;
globExample / foobars / inesperado.js
exports.keepit = () => 'keepit ran unexpected';
globExample / foobars / barit.js
exports.bar = () => 'bar run';
exports.keepit = () => 'keepit ran';
globExample / foobars / fooit.js
exports.foo = () => 'foo ran';
No projeto interno com o glob
instalado , executenode example.js
$ node example.js
foo ran
bar run
keepit ran unexpected
foo ran
bar run
keepit ran unexpected
Pode usar: https://www.npmjs.com/package/require-file-directory
Exija todos os arquivos da routes
pasta e aplique como middleware. Não são necessários módulos externos.
// require
const path = require("path");
const { readdirSync } = require("fs");
// apply as middleware
readdirSync("./routes").map((r) => app.use("/api", require("./routes/" + r)));
Usando esta função, você pode exigir um diretório inteiro.
const GetAllModules = ( dirname ) => {
if ( dirname ) {
let dirItems = require( "fs" ).readdirSync( dirname );
return dirItems.reduce( ( acc, value, index ) => {
if ( PATH.extname( value ) == ".js" && value.toLowerCase() != "index.js" ) {
let moduleName = value.replace( /.js/g, '' );
acc[ moduleName ] = require( `${dirname}/${moduleName}` );
}
return acc;
}, {} );
}
}
// calling this function.
let dirModules = GetAllModules(__dirname);
Se você incluir todos os arquivos de * .js no exemplo de diretório ("app / lib / *. Js"):
example.js:
module.exports = function (example) { }
example-2.js:
module.exports = function (example2) { }
index.js:
module.exports = require('./app/lib');
var routes = require('auto-load')('routes');
com o novoauto-load
módulo [eu ajudei a criá-lo].