gorshochek
Set of plugins for BEM site data generation
Last updated 4 years ago by tadatuta .
MPL-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gorshochek 
SYNC missed versions from official npm registry.

Gorshochek

Набор плагинов сборки данных для BEM сайтов.

NPM version Coveralls branch Travis Code Climate David

Модуль сборки данных для bem сайтов.

GitHub Logo

Установка

Пакет устанавливается как обычная npm зависимость:

$ npm install --save gorshochek

Примеры использования

Простой запуск сборки путем последовательного выполнения всех необходимых задач: пример.

Запуск с помощью gulp можно посмотреть здесь.

Спецификация модели данных

Модель данных описывается в JSON-файле, который должен содержать массив объектов, каждый из которых представляет собой совокупность мета-данных для определенной страницы сайта. Пример такой структуры приведен ниже:

[
 {
    "url": "/",
    "site": "/",
    "title": "БЭМ",
    "content": "БЭМ прекрасен"
  },
  {
    "url": "/methodology/",
    "site": "/methodology/",
    "title": "Методология",
    "source": "./examples/bemjson/methodology.ru.bemjson.js",
    "type": "bemjson.js"
  },
  ...
]  

Каждый объект в массиве страниц модели может иметь следующий набор полей:

url

Url страницы в браузере.

  • Тип данных: String
  • Обязательное поле
  • Должно быть уникальным
  • Должно заканчиваться символом /

site

Url раздела сайта для страницы

  • Тип данных: String
  • Обязательное поле
  • Должно заканчиваться символом /

title

Заголовок страницы. Будет использован при построении меню, хлебных крошек, тега <title> страницы и т. д.

  • Тип данных: String
  • Обязательное поле

published

Флаг страницы, при указании которого в false страница будет исключена из сборки.

  • Тип данных: Boolean
  • Значение по умолчанию: true

content

Контент страницы. Может быть использован для страниц, у которых есть небольшой неизменяемый контент.

  • Тип данных: String
  • Значение по умолчанию: нет

source

Ccылка на источник, с которого будет загружен контент для страницы. Может быть относительной (относительно рабочей директории проекта) ссылкой на файл локальной файловой системы или http-ресурс.

  • Тип данных: String
  • Значение по умолчанию: нет

Примеры:

  • ./examples/bemjson/methodology.ru.bemjson.js
  • https://github.com/bem-site/gorshochek/README.md

type

Тип данных страницы, например: bemjson.js. Используется при шаблонизации страниц.

  • Тип данных: String
  • Значение по умолчанию: нет

bundle

Имя BEM-бандла для сборки страниц.

  • Тип данных: String
  • Значение по умолчанию: index

tags

Массив тегов для страницы, для которых могут быть построены соответствующие страницы.

  • Тип данных: String[]
  • Значение по умолчанию: []

Создание собственной задачи сборки

Задача сборки представляет собой функцию высшего порядка, т. е. возвращающую другую анонимную функцию, без аргументов реализующую логику задачи.

Любая задача сборки, работающая с моделью, должна принимать ее экземпляр в качестве первого аргумента. Кроме того, задача может включать в себя дополнительные опции, которые удобно передать в виде объекта вторым параметром. Для организации задач в виде цепочки промисов возвращаемая анонимная функция должна сама возвращать промис-объект.

Таким образом требования, описанные выше, позволяют записать код простейшей задачи, которая выводит в консоль параметр name, переданный ей в качестве опции:

module.exports = function(model, options = {}) {
    return function() {
        console.log('Hello ' + options.name);
        return Promise.resolve(model);
    }
}

Тестирование

Запуск тестов с вычислением покрытия кода тестами с помощью инструмента istanbul:

npm test

Проверка синтаксиса кода с помощью eslint и jscs

npm run lint

Особая благодарность за помощь в разработке:

Разработчик Кузнецов Андрей Серргеевич @tormozz48 Вопросы и предложения присылать по адресу: andrey.kuznetsov48@yandex.ru

Current Tags

  • 1.0.0                                ...           beta (4 years ago)
  • 2.7.0                                ...           latest (4 years ago)

18 Versions

  • 2.7.0                                ...           4 years ago
  • 2.6.0                                ...           4 years ago
  • 2.5.1                                ...           4 years ago
  • 2.5.0                                ...           4 years ago
  • 2.4.0                                ...           4 years ago
  • 2.3.1                                ...           4 years ago
  • 2.3.0                                ...           4 years ago
  • 2.2.1                                ...           4 years ago
  • 2.2.0                                ...           4 years ago
  • 2.1.2                                ...           4 years ago
  • 2.1.1                                ...           4 years ago
  • 2.1.0                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.1.3                                ...           4 years ago
  • 1.1.2                                ...           4 years ago
  • 1.1.1                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (14)
Dev Dependencies (22)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |