Add documentation about notation #10

Yeti-or · 2017-03-02T19:10:01Z

resolves: #4

coveralls · 2017-03-02T19:11:39Z

Coverage remained the same at 100.0% when pulling cfe53ee on yeti-or.docs into 51116e0 on master.

coveralls · 2017-03-02T19:13:06Z

Coverage remained the same at 100.0% when pulling ac82dd9 on yeti-or.docs into 51116e0 on master.

resolves: #4

coveralls · 2017-03-02T19:13:59Z

Coverage remained the same at 100.0% when pulling 9c833a5 on yeti-or.docs into 51116e0 on master.

coveralls · 2017-03-02T19:15:10Z

Coverage remained the same at 100.0% when pulling d45829b on yeti-or.docs into 51116e0 on master.

coveralls · 2017-03-02T19:16:36Z

Coverage remained the same at 100.0% when pulling d45829b on yeti-or.docs into 51116e0 on master.

qfox · 2017-03-03T17:20:11Z

README.md

-Parse your `import 'b:button2'`, yo!
+Extract [bem-entities](https://en.bem.info/methodology/key-concepts/#bem-entity) from bem-import strings.
+
+Install


Installation

qfox · 2017-03-03T17:20:52Z

README.md

+                                          // { block : 'button', mod : { name: 'theme', val : 'action' } } ]
+```
+
+ToC:


Может быть лучше унести это в начало?

И как отдельный раздел

qfox · 2017-03-03T17:21:40Z

README.md

+
+parse('b:button e:text') // [ { block : 'button', elem : 'text' } ]
+
+parse('b:button m:theme=normal|action') // [ { block : 'button' },


Я бы скинул на следующую строку и добавил → после //

qfox · 2017-03-03T17:22:19Z

README.md

+This section describes all possible syntax of bem-import strings. 
+Examples are provided in es6 syntax. Note that [parse](#api) function only works with strings.
+
+Order of fields is important:


but why? Need to explain that

Because of implementation ¯_(ツ)_/¯

qfox · 2017-03-03T17:23:42Z

README.md

+
+```js
+import 'b:button';
+```


I'd add a list of paths. Something like:

// → .../button/button.*

оно не раскрывается в пути, не думаю что нужно здесь это писать

qfox · 2017-03-03T17:24:07Z

README.md

+```
+
+#### block with several modifiers
+```js


То есть пробел после заголовка, то нет

qfox · 2017-03-03T17:25:37Z

README.md

+
+#### block with several modifiers
+```js
+import 'b:button e:text m:theme=active m:size=m';


Это раскрывается в:

// → .../button/button.* // → .../button/__text/button__text.* // → .../button/__text/_theme/button__text_theme.* // → .../button/__text/_theme/button__text_theme_active.* // → .../button/__text/_size/button__text_size.* // → .../button/__text/_size/button__text_size_m.*

?

Если нет, то

почему важен порядок?

как подключить элемент другого блока с модификаторами?

Порядок важен из-за реализации
b:button e:text вернет тебе только элемент

не понял насчет элемента другого блока

Например, в select2__item мы зовем 'b:menu e:item' (или около того).
Я забыл, что b:button e:text это не про блок. Вопрос снимается, невалидный.

Про реализацию всё еще не понятно как это может зависеть. Можно в первых проход найти все b:, потом e:, потом остальное.

но мы делаем не так =) можешь посмотреть в код, там есть зависимость от того что пришло первое и если напишешь
t:css m:val b:button всё взорвётся, думаешь есть смысл это поддерживать?

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

Пофиксим вот здесь: #12
ты предлагаешь сейчас не писать про важность последовательности?

Да, потому что оно ничем не обусловлено (кроме странной реализации)

qfox · 2017-03-03T17:27:22Z

README.md

+
+Technology is abstraction for extension on file system.
+
+To extract bem-entities with special technology specify field `t:`.


Specify field... to extract...

qfox · 2017-03-03T17:28:15Z

README.md

+
+### technology
+
+Technology is abstraction for extension on file system.


is an abstraction

Здесь лучше дать ссылку на key-concepts, там всё уже расписано.

qfox · 2017-03-03T17:28:45Z

README.md

+License
+-------
+
+Code and documentation copyright 2014 YANDEX LLC. Code released under the [Mozilla Public License 2.0](LICENSE.txt).


2014?
наверное, 2016–2017

Скопируй из bem-react-core

coveralls · 2017-03-09T18:33:45Z

Coverage remained the same at 100.0% when pulling 9d35b88 on yeti-or.docs into 51116e0 on master.

coveralls · 2017-03-09T19:55:48Z

Coverage remained the same at 100.0% when pulling 410343c on yeti-or.docs into 51116e0 on master.

coveralls · 2017-03-09T20:01:49Z

Coverage remained the same at 100.0% when pulling 9dd5649 on yeti-or.docs into 51116e0 on master.

coveralls · 2017-03-09T20:13:31Z

Coverage remained the same at 100.0% when pulling e3a231c on yeti-or.docs into 51116e0 on master.

coveralls · 2017-03-09T20:30:59Z

Coverage remained the same at 100.0% when pulling 36d0054 on yeti-or.docs into 51116e0 on master.

Yeti-or requested a review from veged March 2, 2017 19:10

Yeti-or force-pushed the yeti-or.docs branch from cba4064 to cfe53ee Compare March 2, 2017 19:11

Yeti-or force-pushed the yeti-or.docs branch from cfe53ee to ac82dd9 Compare March 2, 2017 19:12

Yeti-or force-pushed the yeti-or.docs branch from ac82dd9 to 9c833a5 Compare March 2, 2017 19:13

Add documentation about notation

d45829b

resolves: #4

Yeti-or force-pushed the yeti-or.docs branch from 9c833a5 to d45829b Compare March 2, 2017 19:13

qfox reviewed Mar 3, 2017

View reviewed changes

README.md Outdated

```

#### block with several modifiers

```js

Copy link

qfox Mar 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

То есть пробел после заголовка, то нет

qfox reviewed Mar 3, 2017

View reviewed changes

Yeti-or force-pushed the yeti-or.docs branch from 9d35b88 to 410343c Compare March 9, 2017 19:54

Yeti-or force-pushed the yeti-or.docs branch from 410343c to 9dd5649 Compare March 9, 2017 20:00

Yeti-or force-pushed the yeti-or.docs branch from 9dd5649 to e3a231c Compare March 9, 2017 20:11

Update after review @zxqfox

36d0054

Yeti-or force-pushed the yeti-or.docs branch from e3a231c to 36d0054 Compare March 9, 2017 20:28

qfox approved these changes Mar 9, 2017

View reviewed changes

Yeti-or merged commit a4b338e into master Mar 9, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation about notation #10

Add documentation about notation #10

Yeti-or commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

qfox Mar 3, 2017

qfox Mar 3, 2017

qfox Mar 3, 2017

qfox Mar 3, 2017 •

edited

Loading

qfox Mar 3, 2017

Yeti-or Mar 7, 2017

qfox Mar 3, 2017

Yeti-or Mar 9, 2017

qfox Mar 3, 2017

qfox Mar 3, 2017 •

edited

Loading

Yeti-or Mar 7, 2017

qfox Mar 7, 2017 •

edited

Loading

Yeti-or Mar 8, 2017

qfox Mar 9, 2017

Yeti-or Mar 9, 2017

qfox Mar 9, 2017

qfox Mar 3, 2017

qfox Mar 3, 2017

qfox Mar 3, 2017

awinogradov Mar 5, 2017

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017


		parse('b:button e:text') // [ { block : 'button', elem : 'text' } ]

		parse('b:button m:theme=normal\|action') // [ { block : 'button' },


		Technology is abstraction for extension on file system.

		To extract bem-entities with special technology specify field `t:`.


		### technology

		Technology is abstraction for extension on file system.

Add documentation about notation #10

Add documentation about notation #10

Conversation

Yeti-or commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

coveralls commented Mar 2, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qfox Mar 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qfox Mar 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qfox Mar 7, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017

coveralls commented Mar 9, 2017

qfox Mar 3, 2017 •

edited

Loading

qfox Mar 3, 2017 •

edited

Loading

qfox Mar 7, 2017 •

edited

Loading