Skip to content

Commit

Permalink
docs(tech): add exports option description
Browse files Browse the repository at this point in the history
  • Loading branch information
qfox committed May 18, 2016
1 parent fbf5980 commit 262c8cd
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@ module.exports = function(config) {
* [в браузере](#Исполнение-шаблонов-в-браузере)
* [для сборки HTML](#Использование-шаблонов-для-сборки-html)

### Способы экспортирования бандла шаблонов

Существуют разные способы сборки:

* в виде CommonJS-модуля для [исполнения шаблонов в Node.js](#Исполнение-шаблонов-в-nodejs) или сборки с Browserify
* в виде YM-модуля для [исполнения шаблонов в браузере](#Исполнение-шаблонов-в-браузере)

По умолчанию сборщик пытается собрать шаблоны как CommonJS- и YM-модуль одновременно (будет возможно подключать как в среде браузера с модульной системой, так и в среде Node.js) и, если файл подключается иным способом, то при его исполнении объект с шаблонизатором экспортируется в глобальную область видимости.

Это поведение описывается объектом опции `exports` `{ globals: true, commonJS: true, ym: true }` и является значением по умолчанию. В свойстве `globals` допустимо передать строку `'force'` для явного экспорта объекта с шаблонизатором в глобальную область видимости.

### Исполнение шаблонов в Node.js

Скомпилированный файл подключается как модуль в формате [CommonJS](http://www.commonjs.org/).
Expand Down Expand Up @@ -148,14 +159,19 @@ var bemjson = BEMTREE.apply({ block: 'page', data: { /* ... */ } }),

Шаблоны доступны из глобальной переменной `BEMTREE` или `BEMHTML`.

Значение опции `exports`: `{ globals: true }`.

```js
var bemjson = BEMTREE.apply({ block: 'page', data: { /* ... */ } }),
html = BEMHTML.apply(bemjson); // <html>...</html>
```

* **С модульной системой YModules**

Шаблоны доступны из модульной системы ([YModules](https://ru.bem.info/tools/bem/modules/)):

Значение опции `exports`: `{ ym: true }`.

```js
modules.require(['BEMTREE', 'BEMHTML'], function(BEMTREE, BEMHTML) {
var bemjson = BEMTREE.apply({ block: 'page', data: { /* ... */ } }),
Expand Down

0 comments on commit 262c8cd

Please sign in to comment.