Skip to content

Commit

Permalink
Fixed some misprints
Browse files Browse the repository at this point in the history
В примере структуры модели данных в `"url": "/methodology"`, по всей видимости, пропущен конечный слеш, о котором упоминается ниже.
  • Loading branch information
Realetive authored and tadatuta committed Apr 3, 2016
1 parent 650feae commit 58f7e8c
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@

## Установка

Пакет устанавливается как обычная npm зависимость
Пакет устанавливается как обычная npm зависимость:
```
$ npm install --save gorshochek
```

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

Простой запуск сборки путем последовательного выполнения всех необходимых задач: [пример](./examples/native-full.js)
Простой запуск сборки путем последовательного выполнения всех необходимых задач: [пример](./examples/native-full.js).

Запуск с помощью [gulp](https://npmjs.org/package/gulp) можно посмотреть [здесь](./examples/gulp-full.js)
Запуск с помощью [gulp](https://npmjs.org/package/gulp) можно посмотреть [здесь](./examples/gulp-full.js).

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

Модель данных описывается в JSON-файле, который должен содержать массив объектов каждый из которых представляет
Модель данных описывается в JSON-файле, который должен содержать массив объектов, каждый из которых представляет
собой совокупность мета-данных для определенной страницы сайта. Пример такой структуры приведен ниже:
```json
[
Expand All @@ -41,7 +41,7 @@ $ npm install --save gorshochek
"content": "БЭМ прекрасен"
},
{
"url": "/methodology",
"url": "/methodology/",
"site": "/methodology/",
"title": "Методология",
"source": "./examples/bemjson/methodology.ru.bemjson.js",
Expand All @@ -54,21 +54,23 @@ $ npm install --save gorshochek
Каждый объект в массиве страниц модели может иметь следующий набор полей:

#### url

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

#### site

Url раздела сайта для страницы
* Тип данных: `String`
* Обязательное поле
* Должно заканчиваться символом `/`

#### title

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

Expand All @@ -80,12 +82,13 @@ Url раздела сайта для страницы

#### content

Контент страницы. Может быть использован для страниц у которых есть небольшой неизменяемый контент.
Контент страницы. Может быть использован для страниц, у которых есть небольшой неизменяемый контент.
* Тип данных: `String`
* Значение по умолчанию: нет

#### source
Ccылка на источник с которого будет загружен контент для страницы.

Ccылка на источник, с которого будет загружен контент для страницы.
Может быть относительной (относительно рабочей директории проекта) ссылкой
на файл локальной файловой системы или http-ресурс.
* Тип данных: `String`
Expand All @@ -103,7 +106,7 @@ Ccылка на источник с которого будет загружен

#### bundle

Имя BEM - бандла для сборки страниц.
Имя BEM-бандла для сборки страниц.
* Тип данных: `String`
* Значение по умолчанию: `index`

Expand All @@ -115,15 +118,15 @@ Ccылка на источник с которого будет загружен

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

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

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

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

```js
module.exports = function(model, options = {}) {
Expand Down

0 comments on commit 58f7e8c

Please sign in to comment.