Skip to content

Latest commit

 

History

History
191 lines (138 loc) · 9.05 KB

README.ru.md

File metadata and controls

191 lines (138 loc) · 9.05 KB

bem-core library Build Status GitHub Release

This README is also available in English.

Что это?

Базовая библиотека блоков для разработки веб-интерфейсов. Содержит только необходимый минимум для разработки клиентского JS и HTML-шаблонов.

Использование

Наиболее простым способом начать проект с использованием bem-core является project-stub.

Вы также можете добавить библиотеку к себе в проект любым известным вам способом.

Состав

Уровни

  • common.blocks — предназначен для любых устройств и браузеров
  • desktop.blocks — следует использовать для всех десктопных браузеров
  • touch.blocks — реализует некоторую специфику для тач-платформ

Блоки

  • i-bem — базовый блок с хелперами для JS и HTML
  • strings — хелперы для JS-строк
  • objects — хелперы для JS-объектов
  • functions — хелперы для JS-функций
  • events — JS-события
  • querystring — работа со строкой запроса
  • tick — глобальный таймер
  • idle — IDLE-событие
  • next-tick — полифил для nextTick/setTimeout(0, ...)
  • inherit — ООП-хелперы
  • jquery — jQuery
  • clearfix — CSS-трюк clearfix
  • identify — идентификация JS-объектов
  • cookie — хелперы для работы с браузерными куками
  • vow — реализация Promises/A+
  • dom — хелперы для работы с DOM
  • loader — загрузчик для JS-файлов
  • ua — определение возможностей браузера
  • keyboard — хелперы для работы с клавиатурой
  • page — скелет для html/head/body

Технологии

  • vanilla.js + browser.js
  • bemhtml
  • bemtree

API

Автосгенерированная документация на JavaScript API блоков (JSDoc) можно посмотреть в отдельной ветке v2-jsdoc.

Обратите внимание, содержимое ветки «v2-jsdoc» обновляется автоматически. Любые изменения необходимо отправлять в код соответствующих блоков в ветке «v2», как описано в разделе «Внесение изменений» ниже.

История изменений

История изменений доступна на отдельной странице.

Миграция

Миграция описана на отдельной странице.

Разработка

Рабочая копия

  1. Получаем исходники нужной версии (например, v1):

    $ git clone -b v1 git://github.com/bem/bem-core.git
$ cd bem-core

  2. Устанавливаем зависимости:

    $ npm install

    Для последующего запуска локально установленных npm-зависимостей нам потребуется export PATH=./node_modules/.bin:$PATH или любой альтернативный способ.

  3. Устанавливаем зависимые библиотеки:

    $ npm run deps

  4. Собираем примеры и тесты:

    $ npm test

  5. Запускаем разработческий сервер:

    $ npm start

Внесение изменений

  1. Создать issue с описанием сути изменений.
  2. Определить в какую версию необходимо внести изменения.
  3. Сделать feature-branch с указанием номера issue и версии (issues/<номер_issue>@v<номер_версии>) на основе ветки версии. Например, для issue с номером 42 и версией 1: git checkout -b issues/42@v1 v1. Если изменения нужно внести в несколько версий, то для каждой из версий создаётся отдельная ветка.
  4. Сделать изменения, закоммитить и сделать push. Если это необходимо, то нужно сделать rebase от базовой ветки версии.
  5. Создать pull-request на основе созданной ветки (или несколько pull-request-ов для случая изменений в нескольких версиях).
  6. Любым способом связать pull-request и issue (например, c помощью комментария).
  7. Ждать закрытия pull-request и issue ;-)

Модульное тестирование

Сборка дефолтного тестового бандла для functions__debounce:

$ magic make desktop.specs/functions__debounce

После сборки тестового бандла вы увидите результаты выполнения тестов в консоли. Их также можно посмотреть в браузере, открыв desktop.specs/functions__debounce/spec-js+browser-js+bemhtml/spec-js+browser-js+bemhtml.html.

По аналогии можно запустить тесты для других БЭМ-сущностей, имеющих реализацию в технологии spec.js.

Покрытие кода тестами

Чтобы собрать статистику покрытия кода тестами, необходимо добавить переменную окружения ISTANBUL_COVERAGE=yes в сборке тестового бандла:

$ ISTANBUL_COVERAGE=yes magic make desktop.specs && istanbul report html

Сбор статистики покрытия тестами так же работает для запуска тестов конкретной БЭМ-сущности. Пример для functions__debounce

$ ISTANBUL_COVERAGE=yes magic make desktop.specs/functions__debounce && istanbul report html

После завершения выполнения тестов, можно посмотреть отчет о покрытии кода тестами, открыв в браузере страницу coverage/index.html.

Полный отчет и статистику покрытия кода библиотеки тестами можно посмотреть на странице профиля bem-core в проекте Coveralls.

Для сборки и запуска тестов используется библиотека enb-bem-specs. См. подробную информацию про инфраструктуру тестирования.

Поддерживаемые браузеры

Мы поддерживаем браузеры на основе статистики, получаемой на сервисах Яндекса.

Браузеры с долей более 2% пользователей попадают в полную совместимость, с более 0.5% — в частичную, что означает, что данные будут доступны, но возможна деградация. В браузерах с долей менее 0.5% мы прекращаем тестирование.

Десктопы

Полная совместимость

  • Google Chrome 29+
  • Firefox 24+
  • Yandex 1.7+
  • Opera 12.16
  • MSIE 10.0
  • MSIE 9.0
  • MSIE 8.0
  • Opera 12.15

Частичная совместимость

  • Opera 17.0
  • Opera 16.0
  • Opera 12.14
  • Opera 12.2
  • Firefox 23

Тач-браузеры

Полная совместимость

  • iOS 6+
  • Android 2.3+
  • Opera Mobile 12+
  • Windows Phone 7+

Частичная совместимость

  • iOS 5
  • Android 2.2

Лицензия

© 2012 YANDEX LLC. Код лицензирован Mozilla Public License 2.0.