Как подменить модуль при сборке пакета JavaScript?

Question

[Виталий Макеев]

Есть некая библиотека, в коде которой запрашивается модуль logger:

// Исходный не собранный в пакет код, может выполнятся без сбоки в node.js
var logger = require('../../tools/logger');
module.exports = { 
    // ...
};

Реализация модуля logger зависит от среды, поэтому, в случае сборки для браузера, используется другой модуль logger.

Иными словами
require('../../src/logger'); в сборке должен вернуть модуль
'../../src/logger/browser'
Не могу разобраться как подменить один модуль другим, при условии что модуль запрашивается по относительному пути (оба модуля находятся вне папки node_modules).

P.S.
Для создания сборки пробую использовать Browserify.

Comments

[Виталий Макеев]

Хотелось бы отметить, что если не использовать в require относительные пути, то модули легко подменяются

require('logger')
// можно заменить на
require('logger/browser')

Но для этого нужно менять структуру исходного приложения, а это не желательно.

Answer 1

[Виталий Макеев]

Сейчас для этих целей использую папку node_modules внутри проекта.

К примеру:

src/node_modules/_project/logger/index.js
src/node_modules/_project/logger/browser/index.js

В коде:
const logger = require('_project/logger')

При запуске проекта в node, по умолчанию используется _project/logger/index.js.
Если нужна версия для браузера, модуль легко подменяется в процессе сборки (напр. с помощью webpack).

Недостатки:

• Это хак
  
• Нужно явно включать папку src/node_modules в .gitignore
  

  node_modules
  !src/node_modules

  
  
• Нужно настраивать редактор кода или IDE, чтобы встроенные средства поиска и автодополнения учитывали вложенный node_modules не как папку с внешними модулями
  

Answer 2

[Тимур Шемсединов]

Вам нужен петтерн "интерфейс", т.е. одинаковый внешний вид логгера и разная реализация, подгружаемая в зависимости от платформы. Посмотрите вот тут интерфейс реализовывается через примеси: habrahabr.ru/post/183188 Вот сама библиотека с примерами https://github.com/tshemsedinov/global.js А живой пример использования этого метода можно найти тут https://github.com/tshemsedinov/impress В каталоге /lib/ есть impress.security.js, а impress.security.mongodb.js - это его реализация, или db.js - это интерфейс, а его реализации это db.mysql.js, db.mongodb.js, db.memcached.js. В последнем случае (с интерфейсом db) они не только реализуют интерфейс, но и расширяют его.

Comments

[Виталий Макеев]

Спасибо за ответ. Использовать global витало в голове, но учитывая не грандиозный опыт разработки в Js, пока стараюсь придерживаться общего мнения о том, что это "плохая практика". Что бы Вы могли сказать по этому поводу?
Пока сделал что-то вроде: var logger = this.getProvider('logger'); Подмешиваю getProvider, там где это необходимо.

[Тимур Шемсединов]

Для системных вещей использование глобала - нормально, а для прикладных - не допустимо. Логи - это системная вещь, которая должна быть доступна везде в системе, например через global.log с примесями.