node.js потребують усіх файлів у папці?


330

Як мені потрібні всі файли в папці в node.js?

потрібно щось на зразок:

files.forEach(function (v,k){
  // require routes
  require('./routes/'+v);
}};

4
var routes = require('auto-load')('routes');з новим auto-loadмодулем [я допоміг його створити].
Франсіско Презенція

Відповіді:


515

Коли потрібно вказати шлях до папки, вона шукатиме файл index.js у цій папці; якщо він є, він використовує це, а якщо його немає, він виходить з ладу.

Можливо, було б найбільш сенс (якщо у вас є контроль над папкою) створити файл index.js, а потім призначити всі "модулі", а потім просто вимагати цього.

yourfile.js

var routes = require("./routes");

index.js

exports.something = require("./routes/something.js");
exports.others = require("./routes/others.js");

Якщо ви не знаєте назви файлів, вам слід написати який-небудь завантажувач.

Робочий приклад навантажувача:

var normalizedPath = require("path").join(__dirname, "routes");

require("fs").readdirSync(normalizedPath).forEach(function(file) {
  require("./routes/" + file);
});

// Continue application logic here

152
Щоб додати деяке уточнення: Коли requireбуде надано шлях до папки, вона буде шукати index.jsв цій папці; якщо він є, він використовує це, а якщо його немає, він виходить з ладу. Див. Github.com/christkv/node-mongodb-native для прикладу реального світу: index.jsу кореневому каталозі є необхідний ./lib/mongodbкаталог; ./lib/mongodb/index.js'робить все інше в цьому каталозі доступним.
Тревор Бернхем,

22
requireє синхронною функцією, тому переваги від зворотного дзвінка немає. Я б використовував fs.readdirSync замість цього.
Рафал Собота

4
Дякую, я зіткнувся з цією ж проблемою сьогодні і подумав "чому там не вимагають ('./ route / *')?".
Річард Клейтон

3
@RobertMartin корисно, коли вам не потрібна ручка з будь-яким експортованим; наприклад, якщо я просто хотів передати екземпляр програми Express набір файлів, які би прив'язували маршрути.
Річард Клейтон

2
@TrevorBurnham Щоб додати, головний файл (тобто index.js) файл каталогу можна змінити за допомогою package.jsonцього каталогу. Як ось так:{main: './lib/my-custom-main-file.js'}
антитоксичний

187

Я рекомендую використовувати глобус для виконання цього завдання.

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

glob.sync( './routes/**/*.js' ).forEach( function( file ) {
  require( path.resolve( file ) );
});

12
Усі повинні використовувати цю відповідь;)
Джеймі Хатбер

2
Найкраща відповідь! Простіше, ніж усі інші параметри, особливо для рекурсивних дочірніх папок, у яких є файли, які потрібно включити.
ngDeveloper

1
Рекомендуйте глобалізацію завдяки загальному контролю над набором критеріїв filepec, які можна вказати.
stephenwil

6
glob? ви маєте в виду glob-savior-of-the-nodejs-race. Найкраща відповідь.
заглиблення

3
Використовуйте карту () для посилань збереження: const route = glob.sync ('./ route / ** / *. Js'). Map (file => потреба (path.resolve (файл)));
lexa-b

71

На основі рішення @ tbranyen я створюю index.jsфайл, який завантажує довільну javascripts у поточну папку як частину 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);
  }
});

Тоді ви можете requireдодати цей каталог з будь-якого іншого місця.


5
Я знаю, що це вже більше року, але ви також можете вимагати файлів JSON, тож можливо щось подібне /\.js(on)?$/було б краще. Також не є !== nullзайвим?

59

Іншим варіантом є використання пакета Require-dir, який дозволить вам зробити наступне. Він також підтримує рекурсію.

var requireDir = require('require-dir');
var dir = requireDir('./path/to/dir');

3
+1 для, require-dirтому що він автоматично виключає викликовий файл (індекс) і за замовчуванням поточний каталог. Ідеально.
біофрактал

2
У npm є ще кілька подібних пакетів: Requi-all, Requield-каталог, Require-dir та інші. Найбільш завантажене , як видається, вимагають, все, по крайней мере , в липні 2015 року
Mnebuerquo

Зараз найпопулярніші файли вимагають-реж (але, зокрема, він не підтримує виключення файлів під час написання)
Шон Андерсон

Через три роки після коментаря Шона вище було require-dirдодано filterваріант.
givemesnacks

7

У мене папка / поля, повні файлів з одним класом кожен, наприклад:

fields/Text.js -> Test class
fields/Checkbox.js -> Checkbox class

Залиште це у поля / index.js, щоб експортувати кожен клас:

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);

Це змушує модулі діяти так, як вони в Python:

var text = new Fields.Text()
var checkbox = new Fields.Checkbox()

6

Ще одним варіантом є комбінування функцій, що вимагають все-таки, від більшості популярних пакетів.

Більшість популярних require-dirне має варіантів фільтрації файлів / dirs і не має mapфункції (див. Нижче), але використовує невеликий трюк, щоб знайти поточний шлях модуля.

По-друге, за популярністю require-allє фільтрування та попередня обробка regexp, але йому не вистачає відносного шляху, тому вам потрібно використовувати __dirname(у цьому є плюси та протилежності), наприклад:

var libs = require('require-all')(__dirname + '/lib');

Згадані тут require-indexдосить мінімалістичні.

З mapвами можна виконати деяку попередню обробку, як-от створити об'єкти та передати значення конфігурації (якщо припустити модулі нижче конструкторів експорту):

// 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`.

5

Я знаю, що цьому питанню більше 5 років, і відповіді на це хороші, але я хотів чогось більш потужного для експресу, тому я створив express-map2пакет для npm. Я збирався назвати це просто express-map, проте люди в Yahoo вже мають пакет із таким ім'ям, тому мені довелося перейменувати пакунок.

1. Основне використання:

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. 
});

Використання контролера:

//single function
module.exports = function(req,res){

};

//export an object with multiple functions.
module.exports = {

    foo: function(req,res){

    },

    bar: function(req,res){

    }

};

2. розширене використання з префіксами:

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
});

Як бачите, це економить багато часу і робить маршрутизацію вашої програми мертвою простою для написання, підтримки та розуміння. він підтримує всі http-дієслова, які виражають підтримку, а також спеціальний .all()метод.


3

Один модуль, який я використовував для цього конкретного випадку використання, вимагає всіх .

Рекурсивно вимагає всіх файлів у заданій директорії та її підкаталогах, доки вони не відповідають excludeDirsвластивості.

Він також дозволяє вказати фільтр файлів та спосіб отримання ключів повернутого хешу з імен файлів.


2

Я використовую модулі з вузлом копіювання в модуль, щоб створити єдиний файл, щоб вимагати всіх файлів у нашій системі на базі NodeJS.

Код нашого утилітного файлу виглядає так:

/**
 * Module dependencies.
 */

var copy = require('copy-to');
copy(require('./module1'))
.and(require('./module2'))
.and(require('./module3'))
.to(module.exports);

У всіх файлах більшість функцій записуються як експорт, наприклад:

exports.function1 = function () { // function contents };
exports.function2 = function () { // function contents };
exports.function3 = function () { // function contents };

Отже, щоб використовувати будь-яку функцію з файлу, ви просто зателефонуєте:

var utility = require('./utility');

var response = utility.function2(); // or whatever the name of the function is

2

Розширення цього glob рішення. Зробіть це, якщо ви хочете імпортувати всі модулі з каталогу, index.jsа потім імпортувати їх index.jsв іншу частину програми. Зауважте, що літеральні шаблони не підтримуються механізмом виділення, який використовується stackoverflow, тому код може виглядати дивним.

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;

Повний приклад

Структура каталогів

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 / neoca.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';

Внутрішній проект із glob встановленим , запустітьnode example.js

$ node example.js
foo ran
bar run
keepit ran unexpected
foo ran
bar run
keepit ran unexpected

1

Можна використовувати: https://www.npmjs.com/package/require-file-directory

  • Потрібні вибрані файли з лише ім'ям або всі файли.
  • Не потрібно абсолютного шляху.
  • Легкий для розуміння та використання.

2
Ласкаво просимо до SO. Будь ласка, прочитайте цю інструкцію щодо відповіді для надання якісної відповіді.
thewaywewere

1

Потрібні всі файли з routesпапки та застосувати як проміжне програмне забезпечення. Не потрібні зовнішні модулі.

// require
const path = require("path");
const { readdirSync } = require("fs");

// apply as middleware
readdirSync("./routes").map((r) => app.use("/api", require("./routes/" + r)));

0

Використовуючи цю функцію, ви можете вимагати цілого режиму.

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);

-2

Якщо ви включите всі файли * .js у приклад каталогу ("app / lib / *. Js"):

У каталозі app / lib

example.js:

module.exports = function (example) { }

приклад-2.js:

module.exports = function (example2) { }

У програмі каталогу створюйте index.js

index.js:

module.exports = require('./app/lib');
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.