Страницы

четверг, 7 декабря 2017 г.

React Native: путь новичка

"Если долго сидеть на берегу реки,
можно увидеть,
как проплывает труп фреймворка,
который вы давно хотели изучить."
Китайская народная мудрость

Краткое содержание статьи:

1. Источники информации
2. React модули
3. React Native модули
4. JavaScript библиотеки
5. "Баги"
6. Выводы

React Native - самая, пожалуй, интересная и быстроразвивающаяся платформа. Сегодня ты создаешь новый проект на базе её последней версии, и уже через несколько месяцев она успевает устареть на несколько релизов. И если ещё год назад React Native был еще достаточно сырым продуктом, то уже сейчас к нем написано множество как плагинов для работы с нативными компонентами, так и обычных react-компонент.

Итак, с чего начать?


Могу порекомендовать книгу "Learning React Native: Building Native Mobile Apps with JavaScript" Bonnie Eisenman. Несмотря на то, что примеры из книги написаны с использованием устаревшего синтаксиса, её прекрасно можно использовать как пособие по изучению базовых принципов построения приложений на react-native. Книга рассматривает весь процесс создания приложения, вплоть до деплоя в стор c разбором отдельных компонент: как и зачем их использовать. Примеры же отлично укрепят полученные знания, так как копипастить тут не получится и нужно будет, переосмысливая, переписывать их на новый лад.

Далее по важности: документация. Здесь прекрасно то, что она актуальна. Все новинки релизов описаны. Все устаревшие методы указаны.
Выбираем вкладку "Building Projects with Native Code" и понеслась!..

Ну и далеко не последняя пристань react-native разработчика: http://stackoverflow.com/

Далее определимся с набором инструментов для react.


Хотелось бы отметить наиболее значимые и используемые модули:
  1. redux
    • react-redux
    • redux-logger - незаменимый инструмент при отладке
    • redux-saga - лучшее решение для организации сайд-эффектов

  2. селекторы
    • reselect - выбор данных из состояния приложения и компоновка их в нужную структуру. Удобно вынести эту логику из редьюсеров и вьюх в специальное место.
  3. jest - тестирование, идет из коробки. Главное - не пренебрегать и писать тесты =)
  4. eslint - инструмент для унификации стиля написания кода, а также выявления глупых и/или синстаксических ошибок.

Полезности RN


Ещё не могу не упомянуть об уже существующих библиотеках для react-native, которые несомненно упростят жизнь разработчику дабы не изобретать велосипед:

По работе с камерой и библиотекой фото и видео, загрузкой и шаринге есть неплохая статья на medium. А так же следующие библиотеки:


Последние три требуют дополнительных разрешений на телефоне, таких как: доступ к библиотеке, камере, локальному хранилище данных. Нужно отметить, что эти разрешения автоматически будут запрашиваться у пользователя при установке приложения. Исключение составляют новые (выше 6-ой) версии Андроида. Поэтому их нужно запрашивать во время обращения к нужным службам приложения (и вот почему). В документации есть пример, который можно оформить в виде небольшой библиотеки:

import { PermissionsAndroid, Platform } from 'react-native'

export const requestExternalStoragePermission = async (onSuccess, onError) => {
  // only for Android 6 and greater
  if ((Platform.OS === 'android') && (Platform.Version > 22)) {
    try {
      const granted = await PermissionsAndroid.request(
        PermissionsAndroid.PERMISSIONS.READ_EXTERNAL_STORAGE,
        {
          title: 'App read external storage Permission',
          message: `App needs access to your external storage
                    so you can take keep your data.`
        }
      )
      if (granted === PermissionsAndroid.RESULTS.GRANTED) {
        onSuccess()
      } else {
        onError()
      }
    } catch (err) {
      console.warn(err)
    }
  } else {
    onSuccess()
  }
}

Здесь можно хранить запросы и на доступ к микрофону и камере.

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

Андроид (пример приложения фейсбука):

iPhone (пример приложения фейсбука):


Дело в том, что при вычислении высоты экрана берется фактическая высота устройства, но реальная область, доступная для приложения для Андроида, будет меньше на высоту этой самой шапки в 20px (смотри на картинке на самую верхнуюю полосу). Тогда как в iOS "шапка" накладывается поверх приложения и не занимает дополнительного места.

Кстати, особенность верстки в React Native - это возможность легко брать высоту и ширину экрана с помощью модуля Dimensions:

const height = Dimensions.get('window').height
const width = Dimensions.get('window').width


Ну а к верстке флексами привыкаешь быстро. Важно помнить, что если у блока не заданы ширина, высота или флекс > 0, то все внутренние элементы не будут показаны (!).

Не могу не упомянуть еще одну вещь, которую вы непременно будете использовать в своем приложении, - это генерация иконок приложения для Android и iOS. Их нужно иметь тысячу и одну, чтобы приложение красиво выглядело на любом устройстве. К счастью, имея всего node 6 и ImageMagick, а также исходное изображение не менее 200х200 пикселей, через командную строку можно получить все мыслимые и немыслимые иконки. В двух словах трех командах:

npm install -g yo generator-rn-toolbox
brew install imagemagick
yo rn-toolbox:assets --icon <path to your icon>


Дополнительные javascript библиотеки:

  • ramda - из полезного: работа с различными структурами данных, линзы.
  • moment - работа с датами.

Так как код выполняется с помощью javascript, то здесь может быть любой набор библиотек на усмотрение разработчика.

На этом можно было бы и закончить, добавив пару пафосных фраз, что "всё работает из коробки", "большое комьюнити", "огромное количество плагинов". Но реальность такова, что первое впечатление может быть обманчивым и нужно пройти долгий путь в iOS- и Андроид-разработке, прежде чем получить что-то, соответствующее настоящему приложению, которое бы решало какие-то пользовательские задачи.

  Подводные грабли:


Возможные ошибки в iOS:

- при создании билда в XCode сборка попадает в Other Items, из-за чего нельзя залить в AppStore.
Ошибка возникает из-за дополнительных библиотек, которые вы используете в проекте; при сборке они собираются не как используемые библиотеки, а самостоятельные проекты. Решение: во все проектах, которые находятся в Library нужно выставить
"Build Setting": Skip install = yes

- отсутствие обновления проекта при его изменении, "зависания" и прочие непредсказуемости
Одна из возможных причин кроется в том, что "clean project" в XCode не полностью удаляет создаваемые им временные файлы. Решение: удалить временные файлы вручную. Находятся они в директории:
cd /Users/[local machine]/Library/Developer/Xcode/DerivedData/

- при создании Архива для AppStore XCode ругается на дублирование файлов
Такое может произойти если вы используете pod и в нем реакт со своими компонентами, а так же часть из них напрямую из node_modules. Решение: исключить файлы при сборке проекта, добавив в ios/Podfile:

post_install do |installer|

  installer.pods_project.targets.each do |target|
    if target.name == "React"
      target.remove_from_project
    end
  end
end


Для Андроида желательно привести все используемые библиотеки к одной версии.

Заключение


Дорогу осилит идущий.

Разработка приложений на React Native - это удивительный процесс открытия новых вершин и радости от того, как по-другому могут строится вещи для других платформ. Это новый, еще только зарождающийся мир, в котором ты - первооткрыватель, пусть даже порой - первооткрыватель документации.

И осилив азы, можно приступать к проектированию своего первого приложения, задавая себе все новые и новые вопросы:

  • какие данные мы должны хранить в локальном сторе?
  • если приложение доступно онлайн, то как оно должно вести себя при отсутствии доступа к интернету?
  • в какой момент получать/отправлять данные?
  • что должен видеть пользователь в этот момент?
  • как и какие сообщения об ошибке показывать?
  • ...

    воскресенье, 1 января 2017 г.

    Лучшее из 2016

    Очень насыщенный и, возможно, в чем-то продуктивный был год. Из запланированных хотелок осуществились следующие:
    1. прошла достойный курс на coursera
    2. прошла хороший курс по рисованию персонажей и работе с цветом
    3. вышли на большой конкурс по бальным танцам. Пусть и не заняли мест, но был опыт.
    4. прочитала еще несколько хороших книг, если Дозоры считать неплохим чтивом =)
    Ну и конечно лучшее в 2016 году:
    Online курсы
    4 курса из специализации "Create Imaginative Games" (CalArts)
    Курсы
    Харьковский летний интенсив: Academic Painting, Photoshop, Character Design, ZBrush Tools
    Книга
    "Дозоры" Лукьяненко
    Игра
    WoW
    Блюдо
    Макаруны
    Activity
    Сноуборд, катание на яхте
    Мультфильм
    Зоотрополис
    Конференция
    ОдессаJS, ХарьковJS
    Город
    Стамбул, Минск, Санкт-Петербург, Гродно
    Страна
    Республика Белорусь, Греция (Крит), Италия
    Курорт
    Буковель, Драгобрат, Валь ди Фасса
    Достижение
    Участие в кубке мэра г. Днепропетровска
    Очень насыщенные рисованием и творчеством выдались весна и лето. Теперь главное, не растерять это и не забросить =)

    В целом год получился невероятно богат на впечатления и путешествия. Из более серьезных планов на этот год:
    - начать изучать какую-нибудь новую технологию. ReactNative, why not?
    - завершить домашний проект на реакте, двигаться дальше
    - прочитать еще несколько достойных книг
    - и попробовать что-нибудь еще в первый раз =)

    четверг, 10 марта 2016 г.

    CSS Bliss: основные особенности методологии

    Среди множества методологий организации стилей (BEM, SMACSS, OOCSS, SUITECSS) хочется отдельно выделить одну: CSS Bliss. Это квинтэссенция удобства использования и читабельности.

    Для начала определимся в основных понятиях: модуль, элемент и модификатор. Эти определения наиболее близки БЭМу, за исключением того, что Модулем в CSS Bliss именуется Блок. Далее будет понятно, почему Модуль - более подходящее значение. В целом сама методология очень близка к БЭМу, но имеет свои особенности, о которых стоит поговорить отдельно, потому что именно они позволяют стать CSS Bliss на ступеньку выше остальных.



    Основные отличия CSS Bliss:

    1. Именование модуля, элементов и модификаторов:

    Если в БЭМе основными разделительными частицами выступают "-" и "_":

    .my-module__my-element_modifier

    то CSS Bliss улучшает читабельность путем использования заглавных букв:

    .MyModule-myElement--modifier

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

    Возможно, на абстрактном примере это плохо видно, возьмем пример более приближенный к реальному проекту. Сравните:

    <li class="custom-user-menu__list-item_size-normal"></li>

    <li class="CustomUserMenu-listItem--sizeNormal"></li>

    Первый БЭМовский вариант длиннее и сложнее в прочтении. Особенно сливается модификатор с названием элемента. Второй (CSS Bliss) более компактен и визуально разделен на понятные компоненты: модуль, элемент и модификатор. При чем отличие в первой букве моментально дает понимание что перед нами: модуль или элемент (модуль начинается с заглавной, а элемент - со строчной).

    Если я вас еще не убедила, вот еще один пример из документации БЭМа для модификаторов "ключ - значение":

    .block-name__elem-name_mod-name_mod-val

    Сложно представить ситуацию, где бы пригодились подобные нечитабельные конструкции. На мой взгляд правильнее было бы использовать либо другое наименование, либо продумать другой способ разбирения на элементы и модификаторы.

    2. Позиционирование компонентов.

    Модуль независим и самодостаточен сам по себе. Он должен выглядеть одинаково в любом месте и при любом разрешении, именно поэтому он имеет одно важное ограничение: модуль не должен содержать в себе свойства, которые бы жестко задавали его позиционирование, а именно: размеры (width), внешние отступы (margin) и позиционирование по отношение к другим элементам (position). Эти свойства должны задаваться либо в модификаторе модуля либо этот модуль так же является элементом внешнего блока, который (элемент) и определяет его положение.

    Это очень важное отличие делает модули действительно независимыми ни от месторазмещения модуля на странице, ни от размеров экрана. Их легко переиспользовать.

    3. Организация структуры

    Несмотря на удобство организации файловой структуры в БЭМе, он предполагает излишне дробное деление: каждый модификатор и элемент выносится в отдельный файл. Пример:

    blocks
    ├─── popup
    |    ├──── _target
    |    |    ├──── popup_target.css
    |    |    ├──── popup_target_anchor.css
    |    |    └──── popup_target_position.css
    |    └──── _visible
    |         ├──── popup_visible.css
    |         ├──── popup.css
    |         └──── popup.js


    Тогда как в CSS Bliss предполагает создавать файлы только для модулей, а его внутренние элементы и модификаторы описывать внутри этого же файла, так как вне его они не имеют смысла:

    css
    ├─── modules
    |    ├──── _PopupDialog.scss
    |    ├──── _Btn.scss
    |    └──── _ElmInfo.scss
    ├─── _base.scss
    ├─── _colors.scss
    ├─── _mixins.scss
    ├─── _zindex.scss
    └─── application.scss


    При этом можно создавать общие файлы для всего проекта, что тоже очень удобно.

    4. Состояние элемента: state

    Очень часто нам нужно определять состояние элемента или модуля: активный, скрытый, доступный, использованный и проч. Использование для этого модификатора не только загромождает читаемость html, но и загрязняет javascript.

    Пример на БЭМе:

    <div class="my-module__my-mlement my-module__my-mlement_my-modifier-with-state"></div>

    Пример на Bliss CSS:

    <div class="MyModule-myElement isState"></div>

    В последнем примере мы используем для изменения состояния в js не длиное название модификатора: "my-module__my-mlement_my-modifier-with-state", а привычное и универсальное "isState". Из-за того, что состояние определяется только для конкретного модуля или элемента, оно обладает локальным воздействием на него. А универсальное наименование состояния позволяет при необходимости переиспользовать js-код для различных элементов страницы.

    5. Использование @extend

    Лично я - противник использования такой возможности sass как расширение классов с помощью @extend. Главные требования к CSS должны быть:
    • простота
    • читабельность
    • легкоизменяемость

    С помощью @extend вы расширяете исходные классы дополнительным кодом, при чем из любого другого места. Несмотря на кажущуюся простоту концепции, @extend в корне противоречит отновному принципу каскадности стилей; им сложно управлять и читать. Неудивительно, что Bliss CSS запрещает использование @extend для классов и элементов.

    6. Документация

    Помимо обычной документации на сайте описании CSS Bliss, для разработчиков существует интерактивная документация в примерах, где можно не только проверить свои знания в правильном понимании методологии, но и на конкретных примерах разобраться как с помощью CSS Bliss лучше решать те или иные задачи.

    Это лучшая прикладная документация, которую я встречала.

    Выводы

    Несмотря на большую популярность БЭМа в последнее время, CSS Bliss по всем вышеуказанным причинам гораздо практичнее. И как и прочие методологии она вырабатывает привычку думать не в разрезе страницы, а в терминах компонентов: модули, элементы, модификаторы; что делает процесс написания css'a более осознанным, так как от привильного разбиения на компоненты зависит не только красота кода, но и жизнеспособность стилей в будущем.

    четверг, 18 февраля 2016 г.

    Прогноз погоды в консоли

    Замечательный погодный сервис в твоей консоли:
    
    curl http://wttr.in
    



    Можно прописать алиас:
    
    alias weather='function _weather(){ curl http://wttr.in/$1 };_weather'
    

    и после этого набирать в консоли (для текущей локации, города или помощи):
    
    weather
    weather London
    weather :help
    

    среда, 6 января 2016 г.

    Лучшее из 2015


    Online курсы
    "Astronomy: Exploring Time and Space" by Chris Impey (University of Arizona)
    Курсы
    Академрисунок к а р а н д а ш е м
    Книга
    "Гарри Поттер" Джоан Роулинг, "Убить пересмешника" Харпер Ли и "Книжный вор" Маркус Зузак
    Игра
    Diablo III & World of Draenor
    Музыка
    Magic! "Rude"
    Танцевальный исполнитель:
    Koharu Sugawara & Yuki Shibuya
    Увлечение
    Квест комнаты
    Блюдо
    Паски, печеночные тортики и яблочные розочки
    Activity
    Сноуборд, водные лыжи и серфинг.
    Город
    Санкт-Петербург
    Страна
    Шри-Ланка и Словения
    Курорт
    Буковель
    Библиотека
    React.js
    Достижение
    Сказка в инстаграмме


    Подводя итоги года, каждый раз удивляюсь каким же долгим и разнообразным он был. Мы побывали в трех странах, были на мастер-классах по гончарству и рисованию маслом
    Множество вещей попробовали в первый раз: серфинг в Шри-Ланке и жареные каштаны в Словении. Начали свой проект на react.js.
    Кто-то впервые летал самолетом и катался верхом на лошади =)

    Несмотря на это хочется гораздо большего:
    - пройти еще достойный курс на coursera
    - пройти хороший курс по рисованию персонажей и работе с цветом
    - завершить домашний проект на реакте
    - выйти на большой конкурс по бальным танцам
    - прочитать еще несколько хороших книг
    - и попробовать что-нибудь еще в первый раз, например, полетать на воздушном шаре ^_^

    пятница, 27 ноября 2015 г.

    Стайлгайд и компонентная разработка

    "Мы не разрабатываем страницы, мы разрабатываем системы компонентов"
    Стивен Хэй (дизайнер)
    ("We are not designing pages, we are designing systems of components" Stephen Hay)


    Стайлгайд (от англ. styleguide) - это паспорт корпоративных стандартов. Руководство по использованию фирменного стиля, регламентирующее корпоративные цвета, шрифты, формы и блоки, размеры и расположение элементов. Это подробное описание дизайнерских решений для каждого элемента в отдельности и в случае необходимости вместе с другими компонентами.

    Введение


    Существует огромное количество разнообразных стайлгайдов: начиная от дизайнерских и заканчивая стайлгайдами по написанию кода на различных языках программирования. У них разные названия, хотя несут в себе один и тот же посыл: создание общих корпоративных правил. Одними из самых первых появились так называемые бренд-буки.

    Брендбук (англ. brand book) — официальный документ компании, в котором описывается концепция бренда, атрибуты бренда, целевая аудитория, позиционирование компании и другие данные, которыми руководствуется отдел маркетинга и руководители бизнеса для построения коммуникации с потребителями и развития компании в целом. Кроме этого, бренд-бук содержит полное руководство по фирменному стилю, которое включает в себя подробное описание использования каждого фирменного элемента на различных носителях, как рекламных, так и корпоративных. (с) википедия

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

    Наряду с бренд-буком существует сейлс-бук (или Корпоративная книга продаж). Это документ, отражающий все этапы работы с клиентами, принятые в компании стандарты этой работы и специфику продаж с учетом особенностей товара и компании. Несмотря на то, что этот документ ориентирован больше на продающее звено, он играет большую роль для компании: ознакомление с корпоративной этикой. Как следствие - экономия времени всем сотрудникам, которые быстрее включаются в работу, быстрее проходит обучение, так же появляется возможность сохранять опыт в рамках компании и передавать его из одних отделов в другие.

    Стайлгайды для разработчиков


    Как было сказано ранее, у каждого языка программирования также существует свой стайлгайд, набор правил написания и оформления кода:

    Но это очень узкоспециализированные стайлгайды. Что же они из себя представляют в более широком смысле? Какие функции они должны выполнять?

    На примере KSS в прошлой статье я рассказывала о документирования CSS, но покрывает ли этот способ задания стайгайдов весь диапазон компонентов приложения?

    В общем случае это набор правил, которым должны следовать все разработчики: от проектировщиков, через дизайнеров до фронт- и бэкенда. Так же он будет очень полезен и менеджерам, и владельцам приложения, когда нужно обсудить обновление или добавление нового функционала.

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

    В зависимости от вашего приложения они могут выглядеть совершенно по-разному:

    Пример 1:


    Пример 2:


    Пример 3:


    Пример 4:


    Пример 5:



    Преимущества стайлгайдов


    1. Легко тестировать

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

    2. Налаженный рабочий процесс

    Стайлгайд подталкивает нас думать не в рамках страниц, а в рамках функционала проекта, разбитого на небольшие кусочки. И следование этому процессу начинается уже на этапе проектирования приложения, т.о. все в команде следуют этому процессу. Он позволяет легко подключать к разработке новых разработчиков за счет следующего свойства:

    3. Общий словарь

    Это не только общий словарь наименований компонент, но и внутренних элементов. Понятный. Однозначный.

    4. Удобная ссылка

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

    Поэтому стайлгайд - это очень живая документация кода с подробной детализацией элементов и модулей и удобной визуализацией. Это средство коммуникации в проекте между отделами проектировщиков, дизайнеров, разработчиков и менеджеров.


    Разработка приложения через стайлгайд


    Как выглядит процесс разработки приложений:



    1. Выделение особенностей приложения

    Обычно дизайн начинается с создания цветовой палитры, типографики, постраничном рисовании приложения. Такой подход создает кучу проблем для разработчиков в будущем, он не предусматривает расширяемость проекта, а только нагромождение новых и новых страниц. Это плохой вариант. Наличие стайлгайда предполагает, что на первом этапе помимо дизайнерских решений будут выделены основные элементы, которые могли бы быть использованы несколько раз или расширены.

    2. Разбиение на компоненты

    Выделение в компоненты элементов, добавление новых или расширение существующих. Это невозможно без тесного сотрудничества дизайнера и программиста. На данном этапе происходит обновление стайлгайда, так как он должен отражать всегда актуальную стадию развития проекта.

    3. Реализация и документирование

    На данном этапе происходит реализация компонентов с учетом его внещнего вида и поведения. Новый компонент должен согласовываться с уже существующими и обладать качеством, присущим всем компонентам: достаточной гибкостью и целостностью, чтобы его можно было использовать при различных условиях и в различных сценариях. Это также подходящее время и для создания юнит-тестов и документации.

    4. Сборка приложения

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

    Заключение

    Изначально эта статья планировалась только о styleguides, но разбираясь с ним все больше и глубже, понимаешь, что этот подход (разбитие на компоненты) очень хорош не только для стилей. Компоненты - это маленькие кирпичики, их которых строится все вокруг:

    1. В функциональном программировании - это чистые функции. В ООП - это просто правильно написанные функции, небольшие, реализующие какой-то кусочек логики, но без сайд-эффекта, не влияющие на работу других функций и методов.
    2. HTML: разбиение на преиспользуемые блоки: паршалы.
    3. CSS: методология веб-разработки БЭМ (Блок-Элемент-Модификатор) или ее улучшенный аналог CSS Bliss. Оба подхода идеально вписываются в структуру компонентов. В Блиссе для каждого компонента создается отдельный файл с описанием стилей для этого компонента и вложенных элементов и модификаторов.
    4. В дизайне компоненты - это элементы дизайна, из которых строится будущий макет. Так, например, как частный случай можно рассмотреть Bootstrap: набор предустановленных компонетов, таких как заголовки, кнопки, тексты, колонки, меню и проч. В более общем случае - это проектирование больших приложений из меньших составляющих, которые в свою очередь тоже состоят из более мелких. Это основная идея Атомарного дизайна, которую можно так же описать эпиграфом к этой статье известного дизайнера Стивена Хэя ("Мы не разрабатываем страницы, мы разрабатываем системы компонентов") и проиллюстрировать картинкой процесса создания дизайна:


    Ссылки


    понедельник, 9 ноября 2015 г.

    KSS styleguide

    Что такое KSS?

    KSS (Knyle Style Sheets) - это документация к CSS, достаточно понятная для разработчиков и хорошо структурированная для программной обаботки. Для лучшего понимания рекомендую почитать ну очень хорошую статью о концепции KSS.

    Как это выглядит в коде? Пример файла buttons.css:

    /*
    A button suitable for giving stars to someone.

    :hover             - Subtle hover highlight.
    .stars-given       - A highlight indicating you've already given a star.
    .stars-given:hover - Subtle hover highlight on top of stars-given styling.
    .disabled          - Dims the button to indicate it cannot be used.

    Styleguide 2.1.3.
    */
    a.button.star{
      ...
    }
    a.button.star.stars-given{
      ...
    }
    a.button.star.disabled{
      ...
    }

    Как видно из примера, документация css осуществляется через комментарии следующим образом: первая строка - это описание данной секции. Затем идет список классов, модификаторов и псевдоклассов, которые будут документированы и их порядок.  При этом не обязательно создавать документацию на каждый элемент css. Достаточно указать поведение основных и самых используемых.

    Последней строкой комментария задается расположение описания: 2.1.3 - в данном случае 2 глава с указанием пунктов и подпунктов. Вложенность можно делать любую в зависимости от нужд разработчика. Например:

    1. Text styling
    2. Buttons
       2.1 Form Buttons
           2.1.1
       2.2 Other buttons
           2.2.1
    3. Forms
       3.1 Text fields
       3.2 Radio and checkboxes


    По этой документации создается специальная страница styleguide, где можно увидеть задокументированный css c описанием. Пример:



    Работая с препроцессорами (sass, less) достаточно удобно описывать миксцины и их параметры:

    // Creates a linear gradient background, from top to bottom.
    //
    // $start - The color hex at the top.
    // $end - The color hex at the bottom.
    //
    // Compatible in IE6+, Firefox 2+, Safari 4+.
    @mixin gradient($start, $end){
      ...
    }

    Зачем это вообще надо?

    Стоит ли так заморачиваться если проект маленький и я сижу в нем один? Как показывает практика, даже маленький проект нуждается в минимальной поддержке и доработке: там банер добавить, а тут текст увеличить. Иногда таких мелких правок бывает очень много, что легко испортить самый кристально чистый css.

    Преимущества документированного css:

    • Такой css легко поддерживать, он остается чистым и понятным, а это сокращает время на написание нового
    • Структурирование css по файлам, что позволяет быстро находить существующие стили и использовать их, избегая дублирования
    • Написание такого css позволяет выработать хорошую привычку
    • Легко поддерживать консистентность в проекте

    На каком этапе стоит использовать в своем проекте?

    Я бы рекомендовала на самом раннем этапе, пока проект еще не испорчен простынями стилей, в которых нужно очень долго копаться в поисках нужного.

    В идеале практическая сторона верстки должна строиться так:

    1. Построение html-структуры
    2. Описание основных css-стилей, кнопок, блоков и проч. элементов в соответствии с kss-документацией
    3. Создание прочих, уникальных css-стилей

    То есть это должно быть первым этапом верстки: описание и документирование основных элементов страниц (формы, кнопки, заголовки, текст, ui элементы и проч.), а уже после "доработать напильником". Таким образом идя от общего к частному.

    Какой "фреймворк" выбрать?


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

    Создание описаний-документации - это своего рода тесты для css. Их можно и нужно определять до написания самих стилей, чтобы знать что именно должно содержаться в данном блоке.

    Хороший пример стайлгайда представлен у гитхаба. Естественно, хорошо бы иметь документацию и на html и на js.

    Альтернативы


    Наряду с KSS существуют и другие инструменты с очень похожим приниципом: