Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
bs-builder-core
Advanced tools
Readme
Core data builder for bem-site
Основной модуль сборки данных для bem сайтов.
Пакет устанавливается как обычная npm зависимость
$ npm install --save bs-builder-core
При подключении данного модуля с помощью common modules становятся доступными 2 переменые:
require
.var bsBuilderCore = require('bs-builder-core');
var tasks = bsBuilderCore.tasks,
Builder = bsBuilderCore.Builder;
Статический метод для инициализации нового экземпляра класса Builder
.
Аргументы:
Пример использования:
var bsBuilderCore = require('bs-builder-core');
var tasks = bsBuilderCore.tasks,
Builder = bsBuilderCore.Builder;
var builder = Builder.init('debug');
Примечание: эквивалентен вызову var builder = new Builder(logLevel)
;
Возвращает экземпляр конфигурационного класса инструмента
Аргументы: - нет
Возвращает массив задач для сборки которые будут выполнены в том же порядке в котором они перечислены в массиве.
Аргументы: - нет
Позволяет переопределять набор языков для которых будет произведена сборка. По умолчанию набор языков состоит из одного элемента которым является английский.
Аргументы:
Пример использования:
var builder = Builder
.init('debug')
.setLanguages(['en', 'ru']);
Примечание: Все методы экземпляра класса Builder
кроме метода run
и get*
методов
возвращают ссылку на экземпляр, что позволяет вызывать их по цепочке.
Позволяет переопределить путь для директории куда будут помещены временные файлы и папки,
создаваемые в результате сборки. Путь должен быть относительным по отношению к рабочей директории приложения.
По умолчанию ./builder/cache
.
Аргументы:
Пример использования:
var builder = Builder
.init('debug')
.setCacheFolder('./my-cache-folder');
Позволяет переопределить путь для директории куда будут помещены финальные результаты сборки.
Путь должен быть относительным по отношению к рабочей директории приложения.
По умолчанию ./data
.
Аргументы:
Пример использования:
var builder = Builder
.init('debug')
.setDataFolder('./my-data-folder');
Позволяет переопределить путь для json - файла исходной модели.
Путь должен быть относительным по отношению к рабочей директории приложения.
По умолчанию ./model/model.json
.
Аргументы:
Пример использования:
var builder = Builder
.init('debug')
.setModelFilePath('./foo/bar/my-custom-model.json');
Добавляет задачу в очередь сборки.
Аргументы:
Пример использования:
var tasks = require('bs-builder-core').tasks,
Builder = require('bs-builder-core').Builder,
builder;
builder = Builder.init('debug')
.addTask(tasks.LoadModelFiles)
.addTask(tasks.MergeModels);
Запускает сборку всех сконфигураированных задач последовательно. Возвращает Promise - объект.
В случае успешной сборки возвращаемый promise содержит модель изменений данных относительно предыдущего запуска.
В случае ошибки возвращает promise с объектом ошибки вызвавшим завершение сборки.
var tasks = require('bs-builder-core').tasks,
Builder = require('bs-builder-core').Builder,
builder;
builder = Builder.init('debug')
.addTask(tasks.LoadModelFiles)
.run();
Данный пакет содержит набор готовых задач сборки, выполнение части которых является обязательным.
data.json
в целевой директории сборки.exclude
- массив с паттернами файлов которые должны быть исключены
из процесса синхронизации.include
- массив с паттернами файлов которые должны быть включены в процесс
синхронизации даже если они находятся в exclude
.data.json
в целевой директории сборки.// TODO написать документацию
Запуск тестов с вычислением покрытия кода тестами с помощью инструмента istanbul:
npm test
Проверка синтаксиса кода с помощью jshint и jscs
npm run codestyle
Особая благодарность за помощь в разработке:
Разработчик Кузнецов Андрей Серргеевич @tormozz48 Вопросы и предложения присылать по адресу: tormozz48@gmail.com
FAQs
Core data builder for bem-site
The npm package bs-builder-core receives a total of 5 weekly downloads. As such, bs-builder-core popularity was classified as not popular.
We found that bs-builder-core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.