From 26ed429d15b9c3d178a898113e7ae29993024af1 Mon Sep 17 00:00:00 2001 From: tavriaforever Date: Thu, 30 Jul 2015 19:14:43 +0300 Subject: [PATCH] Updated documentation --- LICENSE | 20 --- LICENSE.txt | 369 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 247 +++++++++++++++++++++++++++++++--- api.ru.md | 208 +++++++++++++++++++++++++++++ package.json | 3 +- 5 files changed, 809 insertions(+), 38 deletions(-) delete mode 100644 LICENSE create mode 100644 LICENSE.txt create mode 100644 api.ru.md diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 8126323..0000000 --- a/LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2013 Marat Dulin - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..780da60 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,369 @@ +© YANDEX LLC, 2014 + +The Source Code called `enb-stylus` available at https://github.com/enb-make/enb-stylus is subject to the terms of the Mozilla Public License, v. 2.0 (hereinafter - MPL). The text of MPL is the following: + +Mozilla Public License, version 2.0 + +1. Definitions + +1.1. "Contributor" + + means each individual or legal entity that creates, contributes to the + creation of, or owns Covered Software. + +1.2. "Contributor Version" + + means the combination of the Contributions of others (if any) used by a + Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + + means Source Code Form to which the initial Contributor has attached the + notice in Exhibit A, the Executable Form of such Source Code Form, and + Modifications of such Source Code Form, in each case including portions + thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + a. that the initial Contributor has attached the notice described in + Exhibit B to the Covered Software; or + + b. that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the terms of + a Secondary License. + +1.6. "Executable Form" + + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + + means a work that combines Covered Software with other material, in a + separate file or files, that is not Covered Software. + +1.8. "License" + + means this document. + +1.9. "Licensable" + + means having the right to grant, to the maximum extent possible, whether + at the time of the initial grant or subsequently, any and all of the + rights conveyed by this License. + +1.10. "Modifications" + + means any of the following: + + a. any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered Software; or + + b. any new file in Source Code Form that contains any Covered Software. + +1.11. "Patent Claims" of a Contributor + + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the License, + by the making, using, selling, offering for sale, having made, import, + or transfer of either its Contributions or its Contributor Version. + +1.12. "Secondary License" + + means either the GNU General Public License, Version 2.0, the GNU Lesser + General Public License, Version 2.1, the GNU Affero General Public + License, Version 3.0, or any later versions of those licenses. + +1.13. "Source Code Form" + + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that controls, is + controlled by, or is under common control with You. For purposes of this + definition, "control" means (a) the power, direct or indirect, to cause + the direction or management of such entity, whether by contract or + otherwise, or (b) ownership of more than fifty percent (50%) of the + outstanding shares or beneficial ownership of such entity. + + +2. License Grants and Conditions + +2.1. Grants + + Each Contributor hereby grants You a world-wide, royalty-free, + non-exclusive license: + + a. under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + + b. under Patent Claims of such Contributor to make, use, sell, offer for + sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + + The licenses granted in Section 2.1 with respect to any Contribution + become effective for each Contribution on the date the Contributor first + distributes such Contribution. + +2.3. Limitations on Grant Scope + + The licenses granted in this Section 2 are the only rights granted under + this License. No additional rights or licenses will be implied from the + distribution or licensing of Covered Software under this License. + Notwithstanding Section 2.1(b) above, no patent license is granted by a + Contributor: + + a. for any code that a Contributor has removed from Covered Software; or + + b. for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + + c. under Patent Claims infringed by Covered Software in the absence of + its Contributions. + + This License does not grant any rights in the trademarks, service marks, + or logos of any Contributor (except as may be necessary to comply with + the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + + No Contributor makes additional grants as a result of Your choice to + distribute the Covered Software under a subsequent version of this + License (see Section 10.2) or under the terms of a Secondary License (if + permitted under the terms of Section 3.3). + +2.5. Representation + + Each Contributor represents that the Contributor believes its + Contributions are its original creation(s) or it has sufficient rights to + grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + + This License is not intended to limit any rights You have under + applicable copyright doctrines of fair use, fair dealing, or other + equivalents. + +2.7. Conditions + + Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in + Section 2.1. + + +3. Responsibilities + +3.1. Distribution of Source Form + + All distribution of Covered Software in Source Code Form, including any + Modifications that You create or to which You contribute, must be under + the terms of this License. You must inform recipients that the Source + Code Form of the Covered Software is governed by the terms of this + License, and how they can obtain a copy of this License. You may not + attempt to alter or restrict the recipients' rights in the Source Code + Form. + +3.2. Distribution of Executable Form + + If You distribute Covered Software in Executable Form then: + + a. such Covered Software must also be made available in Source Code Form, + as described in Section 3.1, and You must inform recipients of the + Executable Form how they can obtain a copy of such Source Code Form by + reasonable means in a timely manner, at a charge no more than the cost + of distribution to the recipient; and + + b. You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter the + recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + + You may create and distribute a Larger Work under terms of Your choice, + provided that You also comply with the requirements of this License for + the Covered Software. If the Larger Work is a combination of Covered + Software with a work governed by one or more Secondary Licenses, and the + Covered Software is not Incompatible With Secondary Licenses, this + License permits You to additionally distribute such Covered Software + under the terms of such Secondary License(s), so that the recipient of + the Larger Work may, at their option, further distribute the Covered + Software under the terms of either this License or such Secondary + License(s). + +3.4. Notices + + You may not remove or alter the substance of any license notices + (including copyright notices, patent notices, disclaimers of warranty, or + limitations of liability) contained within the Source Code Form of the + Covered Software, except that You may alter any license notices to the + extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + + You may choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of Covered + Software. However, You may do so only on Your own behalf, and not on + behalf of any Contributor. You must make it absolutely clear that any + such warranty, support, indemnity, or liability obligation is offered by + You alone, and You hereby agree to indemnify every Contributor for any + liability incurred by such Contributor as a result of warranty, support, + indemnity or liability terms You offer. You may include additional + disclaimers of warranty and limitations of liability specific to any + jurisdiction. + +4. Inability to Comply Due to Statute or Regulation + + If it is impossible for You to comply with any of the terms of this License + with respect to some or all of the Covered Software due to statute, + judicial order, or regulation then You must: (a) comply with the terms of + this License to the maximum extent possible; and (b) describe the + limitations and the code they affect. Such description must be placed in a + text file included with all distributions of the Covered Software under + this License. Except to the extent prohibited by statute or regulation, + such description must be sufficiently detailed for a recipient of ordinary + skill to be able to understand it. + +5. Termination + +5.1. The rights granted under this License will terminate automatically if You + fail to comply with any of its terms. However, if You become compliant, + then the rights granted under this License from a particular Contributor + are reinstated (a) provisionally, unless and until such Contributor + explicitly and finally terminates Your grants, and (b) on an ongoing + basis, if such Contributor fails to notify You of the non-compliance by + some reasonable means prior to 60 days after You have come back into + compliance. Moreover, Your grants from a particular Contributor are + reinstated on an ongoing basis if such Contributor notifies You of the + non-compliance by some reasonable means, this is the first time You have + received notice of non-compliance with this License from such + Contributor, and You become compliant prior to 30 days after Your receipt + of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent + infringement claim (excluding declaratory judgment actions, + counter-claims, and cross-claims) alleging that a Contributor Version + directly or indirectly infringes any patent, then the rights granted to + You by any and all Contributors for the Covered Software under Section + 2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user + license agreements (excluding distributors and resellers) which have been + validly granted by You or Your distributors under this License prior to + termination shall survive termination. + +6. Disclaimer of Warranty + + Covered Software is provided under this License on an "as is" basis, + without warranty of any kind, either expressed, implied, or statutory, + including, without limitation, warranties that the Covered Software is free + of defects, merchantable, fit for a particular purpose or non-infringing. + The entire risk as to the quality and performance of the Covered Software + is with You. Should any Covered Software prove defective in any respect, + You (not any Contributor) assume the cost of any necessary servicing, + repair, or correction. This disclaimer of warranty constitutes an essential + part of this License. No use of any Covered Software is authorized under + this License except under this disclaimer. + +7. Limitation of Liability + + Under no circumstances and under no legal theory, whether tort (including + negligence), contract, or otherwise, shall any Contributor, or anyone who + distributes Covered Software as permitted above, be liable to You for any + direct, indirect, special, incidental, or consequential damages of any + character including, without limitation, damages for lost profits, loss of + goodwill, work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses, even if such party shall have been + informed of the possibility of such damages. This limitation of liability + shall not apply to liability for death or personal injury resulting from + such party's negligence to the extent applicable law prohibits such + limitation. Some jurisdictions do not allow the exclusion or limitation of + incidental or consequential damages, so this exclusion and limitation may + not apply to You. + +8. Litigation + + Any litigation relating to this License may be brought only in the courts + of a jurisdiction where the defendant maintains its principal place of + business and such litigation shall be governed by laws of that + jurisdiction, without reference to its conflict-of-law provisions. Nothing + in this Section shall prevent a party's ability to bring cross-claims or + counter-claims. + +9. Miscellaneous + + This License represents the complete agreement concerning the subject + matter hereof. If any provision of this License is held to be + unenforceable, such provision shall be reformed only to the extent + necessary to make it enforceable. Any law or regulation which provides that + the language of a contract shall be construed against the drafter shall not + be used to construe this License against a Contributor. + + +10. Versions of the License + +10.1. New Versions + + Mozilla Foundation is the license steward. Except as provided in Section + 10.3, no one other than the license steward has the right to modify or + publish new versions of this License. Each version will be given a + distinguishing version number. + +10.2. Effect of New Versions + + You may distribute the Covered Software under the terms of the version + of the License under which You originally received the Covered Software, + or under the terms of any subsequent version published by the license + steward. + +10.3. Modified Versions + + If you create software not governed by this License, and you want to + create a new license for such software, you may create and use a + modified version of this License if you rename the license and remove + any references to the name of the license steward (except to note that + such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary + Licenses If You choose to distribute Source Code Form that is + Incompatible With Secondary Licenses under the terms of this version of + the License, the notice described in Exhibit B of this License must be + attached. + +Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the + terms of the Mozilla Public License, v. + 2.0. If a copy of the MPL was not + distributed with this file, You can + obtain one at + http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, +then You may include the notice in a location (such as a LICENSE file in a +relevant directory) where a recipient would be likely to look for such a +notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice + + This Source Code Form is "Incompatible + With Secondary Licenses", as defined by + the Mozilla Public License, v. 2.0. + + +A copy of the MPL is also available at http://mozilla.org/MPL/2.0/. diff --git a/README.md b/README.md index dc98fdd..4f453d1 100644 --- a/README.md +++ b/README.md @@ -3,32 +3,245 @@ enb-stylus [![NPM version](http://img.shields.io/npm/v/enb-stylus.svg?style=flat)](http://www.npmjs.org/package/enb-stylus) [![Build Status](http://img.shields.io/travis/enb-make/enb-stylus/master.svg?style=flat&label=tests)](https://travis-ci.org/enb-make/enb-stylus) [![Build status](https://img.shields.io/appveyor/ci/blond/enb-stylus.svg?style=flat&label=windows)](https://ci.appveyor.com/project/blond/enb-stylus) [![Coverage Status](https://img.shields.io/coveralls/enb-make/enb-stylus.svg?style=flat)](https://coveralls.io/r/enb-make/enb-stylus?branch=master) [![Dependency Status](http://img.shields.io/david/enb-make/enb-stylus.svg?style=flat)](https://david-dm.org/enb-make/enb-stylus) -Поддержка Stylus для ENB. Пакет содержит технологии: - * `enb-stylus/techs/stylus` +Пакет предоставляет [ENB](https://ru.bem.info/tools/bem/enb-bem/)-технологию для сборки CSS- и Stylus-файлов в проектах, построенных по [методологии БЭМ](https://ru.bem.info/method/). -Установка: ----------- +Принципы работы технологии и ее API описаны в документе [API технологии](api.ru.md). +**Совместимость:** технология пакета `enb-stylus` поддерживает версию [CSS-препроцессора Stylus](https://github.com/stylus/stylus) `0.52.0`. + +## Работа технологии + +В [БЭМ-методологии](https://ru.bem.info/method/filesystem/) стили к каждому блоку хранятся в отдельных файлах в директориях блоков. + +ENB-технология `stylus` позволяет писать код как в синтаксисе Stylus, так и на чистом CSS. Для компиляции Stylus-кода в CSS используется CSS-препроцессор [Stylus](https://github.com/stylus/stylus). + +В результате сборки вы получите CSS-файл. Для обработки итогового CSS используется CSS-построцессор [postcss](https://github.com/postcss/postcss). + +## Особенности работы пакета + +### Совместное использование Stylus и CSS + +В проекте допускается совместное использование `.css`- и `.styl`-файлов. Однако в рамках одного блока обе технологии не могут использоваться одновременно. Если стили блока реализованы и в CSS, и в Stylus, будет использоваться файл с расширением `.styl`. + +**Пример 1.** Если файл одного блока реализован в CSS-технологии, а файл другого — в Stylus: + +``` +blocks/ +└── block1/ + └── block1.styl +└── block2/ + └── block2.css +bundle +└── bundle.css +``` + +В сборку попадут оба файла: + +```css +@import "../blocks/block1/block1.styl"; +@import "../blocks/block1/block2.css"; +``` + +**Пример 2.** Если у одного блока есть несколько реалиализаций: файл c расширением `.styl` и файл c расширением `.css`: + +``` +blocks/ +└── block/ + ├── block.styl + └── block.css +bundle +└── bundle.css +``` + +В сборку попадет только Stylus-файл: + +```css +@import "../blocks/block/block.styl"; +``` + +**Пример 3.** Если у одного блока есть несколько реалиализаций, но на разных уровнях переопределения: + +``` +common.blocks/ +└── block/ + └── block.styl +desktop.blocks/ + └── block/ + └── block.css +bundle +└── bundle.css +``` + +В сборку попадут оба файла: + +```css +@import "../common.blocks/block/block.styl"; +@import "../desktop.blocks/block/block.css"; +``` + +## Как начать использовать? + +**1.** Установите пакет `enb-stylus`: + +```sh +$ npm install --save-dev enb-stylus ``` -npm install enb-stylus + +**Требования:** зависимость от пакета `enb` версии `0.8.43` или выше. + +**2.** Опишите код стилей в файле с расширением `.styl`: +``` + blocks/ + └── block/ + └── block.styl +``` + +**3.** Добавьте в конфигурационный файл `.enb/make.js` следующий код: + +```js +var stylusTech = require('enb-stylus/techs/stylus'), + FileProvideTech = require('enb/techs/file-provider'), + bem = require('enb-bem-techs'); + +module.exports = function(config) { + config.node('bundle', function(node) { + // Получаем список файлов (FileList) + node.addTechs([ + [FileProvideTech, { target: '?.bemdecl.js' }], + [bem.levels, levels: ['blocks']], + bem.deps, + bem.files + ]); + + // Строим CSS-файл + node.addTech([stylusTech, { + // target: '?.css', + // filesTarget: '?.files', + // sourceSuffixes: ['.styl', '.css'], + // url: 'rebase' + // imports: 'include', + // comments: true + }]); + node.addTarget('?.css'); + }); +}; ``` -stylus ----------- +## Сборка отдельного бандла для IE -Собирает *css*-файлы вместе со *styl*-файлами по deps'ам, обрабатывает инклуды и ссылки, сохраняет в виде `?.css`. +Если в проекте есть стили, которые должны примениться только для IE, то их помещают в отдельный файл со специальным расширением `.ie*.styl`: -**Опции** +* `.ie.styl` — стили для любого IE, ниже 9й версии. +* `.ie6.styl` — стили для IE 6. +* `.ie7.styl` — стили для IE 7. +* `.ie8.styl` — стили для IE 8. +* `.ie9.styl` — стили для IE 9. + +Чтобы собрать отдельный бандл для IE нужно: + +**1.** В папке блока создать один или несколько файлов c расширением `.ie*.styl`: + +``` +blocks/ +└── block/ + ├── block.styl + ├── block.ie.styl + └── block.ie6.styl +``` + +**2.** Добавить еще технологию `StylusTech`: + +```js +node.addTechs([ + [stylusTech], // для основного CSS + [stylusTech] // для IE +]); +``` -* *String* **target** — Результирующий таргет. По умолчанию `?.css`. -* *Boolean* **compress** - Минифицировать результирующий CSS. По умолчанию `false`. -* *String* **prefix** - Префикс, добавляемый классам в результирующем CSS. По умолчанию `''`. -* *Object* **variables** — Дополнительные переменные окружения для `stylus`. -* *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов - (его предоставляет технология `files`). По умолчанию — `?.files`. +**3.** Добавить новую цель сборки для IE файла — `?.ie6.css`: + +```js +node.addTechs([ + [stylusTech], + [stylusTech, { target: '?.ie6.css' }] // IE 6 +]); + +node.addTargets(['?.css', '?.ie6.css']); +``` + +**4.** В БЭМ проектах принято подключать стили через [Conditional Comments](https://msdn.microsoft.com/en-us/library/ms537512(v=vs.85).aspx). **Пример** -```javascript -nodeConfig.addTech(require('enb-stylus/techs/stylus')); +```html + + + + + + + + + + +``` + +Важно, чтобы файл, подключаемый для IE, содержал стили не только специфичные для него, но и общие для всей страницы. + +Чтобы собрать такой файл, нужно расширить список суффиксов с помощью опции [sourceSuffixed](api.ru.md#sourcesuffixes). + +```js +node.addTechs([ + [stylusTech], + [stylusTech, { + target: '?.ie6.css', + sourceSuffixes: [ + 'styl', 'css', // Общие стили + 'ie.styl', 'ie.css', // Стили для IE < 9 + 'ie6.styl', 'ie6.css' // Стили для IE 6 + ] + }] +]); +node.addTargets(['?.css', '?.ie.css']); ``` + +В итоге получаем следующий конфигурационный файл `.enb/make.js`: + +```js +var stylusTech = require('enb-stylus/techs/stylus'), + FileProvideTech = require('enb/techs/file-provider'), + bem = require('enb-bem-techs'); + +module.exports = function(config) { + config.node('bundle', function(node) { + // получаем список файлов (FileList) + node.addTechs([ + [FileProvideTech, { target: '?.bemdecl.js' }], + [bem.levels, levels: ['blocks']], + bem.deps, + bem.files + ]); + + // Собираем CSS-файлы + node.addTechs([ + [stylusTech], + [stylusTech, { + target: '?.ie6.css', + sourceSuffixes: [ + 'styl', 'css', // Общие стили + 'ie.styl', 'ie.css', // Стили для IE < 9 + 'ie6.styl', 'ie6.css' // Стили для IE 6 + ] + }] + ]); + node.addTargets(['?.css', '?.ie6.css']); + }); +}; +``` + +Лицензия +-------- + +© 2014 YANDEX LLC. Код лицензирован [Mozilla Public License 2.0](LICENSE.txt). diff --git a/api.ru.md b/api.ru.md new file mode 100644 index 0000000..35146ea --- /dev/null +++ b/api.ru.md @@ -0,0 +1,208 @@ +# API технологии stylus + +Собирает исходные файлы блоков со стилями, написанными в синтаксисе Stylus (файлы с расширением `.styl`), или на чистом CSS (файлы с расширением `.css`). + +Использует CSS-препроцессор [Stylus](https://github.com/stylus/stylus) для компиляции Stylus-файлов в CSS-код. + +Результатом сборки является CSS-файл. Для обработки итогового CSS используется CSS-построцессор [postcss](https://github.com/postcss/postcss). + +### Опции + +* [target](#target) +* [filesTarget](#filestarget) +* [sourceSuffixes](#sourcesuffixes) +* [url](#url) +* [comments](#comments) +* [imports](#imports) +* [sourcemap](#sourcemap) +* [autoprefixer](#autoprefixer) +* [compress](#compress) +* [prefix](#prefix) +* [includes](#includes) +* [useNib](#usenib) + +#### target + +Тип: `String`. По умолчанию: `?.css`. + +Имя таргета, куда будет записан результат сборки необходимых `.styl`- и `.css`-файлов проекта. + +#### filesTarget + +Тип: `String`. По умолчанию: `?.files`. + +Имя таргета, откуда будет доступен список исходных файлов для сборки. Список файлов предоставляет технология [files](https://ru.bem.info/tools/bem/enb-bem-techs/readme/#files) пакета [enb-bem-techs](https://ru.bem.info/tools/bem/enb-bem-techs/readme/). + +#### sourceSuffixes + +Тип: `String | String[]`. По умолчанию: `['styl', 'css']`. + +Суффиксы, по которым отбираются файлы с стилей для дальнейшей сборки. + +#### url + +Тип: `String`. По умолчанию: `rebase`. + +Oбработка `url()` внутри файлов `.styl` и `.css`. + +*Допустимые значения:* + +- **inline:** содержимое файла будет закодировано в `base64`. + + **Важно:** + + - Размер не должен превышать `14kb`. + - Не поддерживается кодирование `.svg`-файлов с хешем. Например: `url(image.svg#hash)`. Такие `url()` не будут обработаны. + + -------------------------------------- + +- **rebase:** изменение пути к содержимому относительно таргета. + + Пример: + + ``` + blocks/ + └── block/ + ├── block.styl + └── block.png + bundle/ + └── bundle.css # таргет + ``` + + Исходный файл `block.styl`: + + ```css + .block + background-image: url(block.png) + ``` + + Файл для подключения на страницу `bundle.css`: + + ```css + .block + { + background-image: url(../../blocks/block/block.png); + } + ``` + +#### comments + +Тип: `Boolean`. По умолчанию: `true`. + +Обрамление комментариями CSS-кода в собранном файле. Комментарии cодержат относительный путь до исходного файла. Может быть использовано при разработке проекта. + +**Пример** + +```css +/* ../../blocks/block/block.styl:begin */ +.block +{ + background-image: url(../../blocks/block/block.png); +} +/* ../../blocks/block/block.styl:end */ +``` + +#### imports + +Тип: `String`. По умолчанию: `include`. + +Раскрытие CSS `@import`-ов. + +*Допустимые значения:* + +- **include:** `@import` будет удален, вместо него в собираемый файл будет добавлено его содержимое. + +#### sourcemap + +Тип: `String | Boolean`. По умолчанию: `false`. + +Построение карт кода (sourcemap) с информацией об исходных файлах. + +*Допустимые значения:* + +- **true:** карта хранится в отдельном файле с расширение `.map`. +- **inline:** карта встраивается в скомпилированный файл в виде закодированной строки в формате `base64`. + +#### autoprefixer + +Тип: `Object | Boolean`. По умолчанию: `false`. + +Добавление вендорных префиксов с помощью [autoprefixer](https://github.com/postcss/autoprefixer). + +*Допустимые значения:* + +- **false:** отключает `autoprefixer`. +- **true:** префиксы добавляются для самых актуальных версий браузеров на основании данных сервиса [caniuse.com](http://caniuse.com). +- **browsers: String[]:** задание конфигурации в случае, если требуется передать точный список поддерживаемых браузеров. + + Пример: + + ```js + { + autoprefixer: { browsers: ['Explorer 10', 'Opera 12'] } + } + ``` + + Подробнее в документации [autoprefixer](https://github.com/postcss/autoprefixer#browsers). + +#### compress + +Тип: `Boolean`. По умолчанию: `false`. + +Минификация CSS-кода. Поддерживает карты кода (sourcemap). + +#### prefix + +Тип: `String`. По умолчанию: `''`. + +Добавление префикса для CSS-классов. + +**Важно!** Опция работает только для файлов с расширением `.styl`. + +#### includes + +Тип: `String | String[]`. По умолчанию: `[]`. + +Задает пути, которые будут использованы при обработке `@import` и `url()`. +Может быть использовано при подключении сторонних библиотек, например, `nib`. + +**Важно!** Опция работает только для файлов с расширением `.styl`. + +### useNib + +Тип: `Boolean`. По умолчанию: `false`. + +Подключение библиотеки CSS3-миксинов для Stylus – [nib](https://github.com/tj/nib). + +**Важно!** Опция работает только для файлов с расширением `.styl`. + +-------------------------------------- + +## Пример использования технологии + +```javascript +var stylusTech = require('enb-stylus/techs/stylus'), + FileProvideTech = require('enb/techs/file-provider'), + bem = require('enb-bem-techs'); + +module.exports = function(config) { + config.node('bundle', function(node) { + // Получаем имена файлов (FileList) + node.addTechs([ + [FileProvideTech, { target: '?.bemdecl.js' }], + [bem.levels, levels: ['blocks']], + bem.deps, + bem.files + ]); + + // Создаем CSS-файлы + node.addTech([stylusTech, { /* опции */ }]); + node.addTarget('?.css'); + }); +}; +``` + +Лицензия +-------- + +© 2014 YANDEX LLC. Код лицензирован [Mozilla Public License 2.0](LICENSE.txt). diff --git a/package.json b/package.json index f9210bc..c01be6e 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ ], "contributors": [ "Andrew Abramov ", - "Marat Dulin " + "Marat Dulin ", + "Nickolay Ilchenko " ], "peerDependencies": { "enb": ">=0.8.43 <1.0.0"