/enb-xjst

xjst support for ENB

Primary LanguageJavaScriptMIT LicenseMIT

enb-xjst

NPM version Build Status Dependency Status

Поддержка технологий на основе XJST. Базовые шаблоны для BEMHTML находятся в bem-bl.

Используется XJST-транслятор из пакета bem-bl-xjst. Для базовых шаблонов из bem-bl@1.x следует использовать bem-bl-xjst@1.x, для bem-bl@2.x — bem-bl-xjst@2.x.

Внимание: для технологий, базовые шаблоны которых находятся в библиотеке bem-core, следует использовать enb-bemxjst пакет.

Установка

npm install --save-dev enb-xjst

Для работы модуля требуется зависимость от пакета enb версии 0.13.0 или выше, а так же bem-bl-xjst версии 1.3.2 или выше.

Технологии

bemhtml

Склеивает BEMHTML-файлы по deps'ам, обрабатывает XJST-транслятором, сохраняет (по умолчанию) в виде ?.bemhtml.js.

Опции

  • String target — результирующий таргет. По умолчанию — ?.bemhtml.js.
  • String filesTarget — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология files). По умолчанию — ?.files.
  • String sourceSuffixes — суффиксы файлов, по которым строится files-таргет. По умолчанию — BEMHTML.
  • String exportName — имя переменной-обработчика BEMHTML. По умолчанию — 'BEMHTML'.
  • String applyFuncName — имя apply-функции базового шаблона BEMHTML. По умолчанию — 'apply'.
  • Boolean devMode — development-режим. По умолчанию true.
  • Boolean cache — кеширование. По умолчанию — false.

Пример

nodeConfig.addTech(require('enb-xjst/techs/bemhtml'));

bemtree

Склеивает bemtree.xjst-файлы по deps'ам, обрабатывает XJST-транслятором, сохраняет (по умолчанию) в виде ?.bemtree.xjst.js.

Опции

  • String target — результирующий таргет. По умолчанию — ?.bemtree.xjst.js.
  • String filesTarget — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология files). По умолчанию — ?.files.
  • String sourceSuffixes — суффиксы файлов, по которым строится files-таргет. По умолчанию — bemtree.xjst.
  • String exportName — имя переменной-обработчика BEMTREE. По умолчанию — 'BEMTREE'.
  • String applyFuncName — имя apply-функции базового шаблона BEMTREE. По умолчанию — 'apply'.
  • Boolean devMode — development-режим. По умолчанию true.

Пример

nodeConfig.addTech(require('enb-xjst/techs/bemtree'));

html-from-bemjson

Собирает HTML-файл с помощью BEMJSON и BEMHTML.

Опции

  • String bemhtmlFile — исходный BEMHTML-файл. По умолчанию — ?.bemhtml.js.
  • String bemjsonFile — исходный BEMJSON-файл. По умолчанию — ?.bemjson.js.
  • String target — результирующий HTML-файл. По умолчанию — ?.html.

Пример

nodeConfig.addTech(require('enb-xjst/techs/html-from-bemjson'));

html-from-bemjson-i18n

Собирает HTML-файл с помощью BEMJSON, BEMHTML, lang.all и lang.{lang}.

Опции

  • String bemhtmlFile — исходный BEMHTML-файл. По умолчанию — ?.bemhtml.js.
  • String bemjsonFile — исходный BEMJSON-файл. По умолчанию — ?.bemjson.js.
  • String langAllFile — исходный langAll-файл. По умолчанию — ?.lang.all.js.
  • String langFile — исходный lang-файл. По умолчанию — ?.lang.{lang}.js. Если параметр lang не указан, берется первый из объявленных в проекте языков.
  • String target — результирующий HTML-файл. По умолчанию — ?.{lang}.html.

Пример

nodeConfig.addTech(require('enb-xjst/techs/html-from-bemjson-i18n'));