From d29de9415f7dad795b1036a2d595bb99b08c9b4b Mon Sep 17 00:00:00 2001 From: andrewblond Date: Sat, 16 May 2015 00:52:20 +0300 Subject: [PATCH] Updated docs --- README.md | 60 ++++++++++--------------------------------------------- 1 file changed, 10 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 0145d27..bd9e140 100644 --- a/README.md +++ b/README.md @@ -15,39 +15,20 @@ $ npm install --save-dev enb-bh Технологии ---------- -* [bh-client](#bh-client) -* [bh-client-module](#bh-client-module) -* [bh-server](#bh-server) -* [bh-server-include](#bh-server-include) +* [bh-bundle](#bh-bundle) +* [bh-server](#bh-commonjs) * [bemjson-to-html](#bemjson-to-html) * [bemjson-to-html-i18n](#bemjson-to-html-i18n) Для работы модуля требуется зависимость от пакета `enb` версии `0.12.0` или выше. -### bh-client +### bh-bundle -Склеивает `bh`-файлы по deps'ам в виде `?.bh.client.js`. Предназначен для сборки клиентского BH-кода. +Склеивает *bh*-файлы по deps'ам в виде `?.bh.js` бандла. -**Опции** - -* *String* **target** — Результирующий таргет. По умолчанию — `?.bh.client.js`. -* *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`. -* *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`. -* *Boolean* **sourcemap** — строить карты кода. -* *String|Array* **mimic** — имена переменных для экспорта. -* *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `data-bem`. -* *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `json`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`. -* *String|Boolean* **jsCls** — имя `i-bem` CSS-класса. По умолчанию - `i-bem`. Для того, чтобы класс не добавлялся, следует указать значение `false` или пустую строку. - -**Пример** +Предназначен для сборки как клиентского, так и серверного BH-кода. Предполагается, что в *bh*-файлах не используется `require`. -```javascript -nodeConfig.addTech(require('enb-bh/techs/bh-client')); -``` - -### bh-client-module - -Склеивает `bh`-файлы по deps'ам в виде `?.bh.client.js`. Предназначен для сборки клиентского BH-кода. Использует модульную обертку. +Поддерживает CommonJS и YModules. Если в исполняемой среде нет ни одной модульной системы, то модуль будет предоставлен в глобальную переменную `bh`. **Опции** @@ -55,26 +36,6 @@ nodeConfig.addTech(require('enb-bh/techs/bh-client')); * *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`. * *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`. * *Boolean* **sourcemap** — строить карты кода. -* *String|Array* **mimic** — имена модулей для экспорта. -* *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `data-bem`. -* *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `json`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`. -* *String|Boolean* **jsCls** — имя `i-bem` CSS-класса. По умолчанию - `i-bem`. Для того, чтобы класс не добавлялся, следует указать значение `false` или пустую строку. - -**Пример** - -```javascript -nodeConfig.addTech(require('enb-bh/techs/bh-client-module')); -``` - -### bh-server - -Склеивает *bh*-файлы по deps'ам с помощью набора `require` в виде `?.bh.js`. Предназначен для сборки серверного BH-кода. После сборки требуется наличие всех файлов, подключённых с помощью набора `require`. - -**Опции** - -* *String* **target** — Результирующий таргет. По умолчанию — `?.bh.js`. -* *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`. -* *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`. * *String|Array* **mimic** — имена переменных для экспорта. * *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `data-bem`. * *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `json`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`. @@ -83,19 +44,18 @@ nodeConfig.addTech(require('enb-bh/techs/bh-client-module')); **Пример** ```javascript -nodeConfig.addTech(require('enb-bh/techs/bh-server')); +nodeConfig.addTech(require('enb-bh/techs/bh-bundle')); ``` -### bh-server-include +### bh-commonjs -Склеивает `bh`-файлы по deps'ам в виде `?.bh.js`. Предназначен для сборки серверного BH-кода. Предполагается, что в `bh`-файлах не используется `require`. +Склеивает *bh*-файлы по deps'ам с помощью набора `require` в виде `?.bh.js`. Предназначен для сборки серверного BH-кода. После сборки требуется наличие всех файлов, подключённых с помощью набора `require`. **Опции** * *String* **target** — Результирующий таргет. По умолчанию — `?.bh.js`. * *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`. * *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`. -* *Boolean* **sourcemap** — строить карты кода. * *String|Array* **mimic** — имена переменных для экспорта. * *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `data-bem`. * *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `json`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`. @@ -104,7 +64,7 @@ nodeConfig.addTech(require('enb-bh/techs/bh-server')); **Пример** ```javascript -nodeConfig.addTech(require('enb-bh/techs/bh-server-include')); +nodeConfig.addTech(require('enb-bh/techs/bh-commonjs')); ``` ### bemjson-to-html