Merge pull request #84 from bem/refact

Refactoring

Author: blond

.jscs.js

@@ -24,7 +24,6 @@ module.exports = {
     disallowQuotedKeysInObjects: 'allButReserved',
     disallowSpaceAfterObjectKeys: true,
     requireCommaBeforeLineBreak: true,
-    requireOperatorBeforeLineBreak: true,
     disallowSpaceAfterPrefixUnaryOperators: true,
     disallowSpaceBeforePostfixUnaryOperators: true,
     requireSpaceBeforeBinaryOperators: true,

README.md

@@ -17,7 +17,7 @@ bem-naming
 About
 -----
 
-This tool allows getting information about BEM entity using [string](#string-representation) as well as forming string representation based on [BEM-naming](#bem-naming).
+This tool allows getting information about BEM entity using [string](#string-representation) as well as forming string representation based on [naming object](#object-representation-of-bem-entity).
 
 Install
 -------
@@ -41,9 +41,9 @@ Table of Contents
 -----------------
 
 * [String representation](#string-representation)
-* [Common misconceptions](#common-misconceptions)
-* [BEM-naming](#bem-naming-1)
+* [Object representation of BEM entity](#object-representation-of-bem-entity)
 * [API](#api)
+* [Common misconceptions](#common-misconceptions)
 * [Custom naming convention](#custom-naming-convention)
 * [Convention by Harry Roberts](#convention-by-harry-roberts)
 
@@ -66,25 +66,10 @@ According to original BEM-naming convention it looks like the following:
 * Element's modifier in key-value format — `block-name__elem-name_mod-name_mod-val`.
 * Element's boolean modifier — `block-name__elem_mod`.
 
-Common misconceptions
----------------------
-
-BEM methodology involves the use of flat structure inside a block. It means that BEM entity can not be represented as an element of the other element and the following string representation will be invalid:
-
-```js
-'block__some-elem__sub-elem'
-```
-
-Also there is no such BEM entity as a modifier and an element modifier simultaneously so the following string representation will be invalid:
-
-```js
-'block_block-mod-name_block-mod-val__elem-name_elem-mod-name_elem-mod-val'
-```
-
-BEM-naming
-----------
+Object representation of BEM entity
+-----------------------------------
 
-BEM entities can be defined with a help of js-object with the following fields:
+BEM entities can be defined with a help of JS object with the following fields:
 
 * `block` — a block name. The field is required because only a block exists as an independent BEM entity
 * `elem` — an element name.
@@ -169,7 +154,7 @@ bemNaming.validate('^*^');         // false
 
 ### parse(str)
 
-It parses string `str` into BEM-naming.
+It parses string into naming object.
 
 Example:
 
@@ -180,7 +165,7 @@ bemNaming.parse('block__elem_mod_val');  // { block: 'block', elem: 'elem',
 
 ### stringify(obj)
 
-It forms a string according to BEM-naming `obj`.
+It forms a string according to naming object.
 
 Example:
 
@@ -219,7 +204,7 @@ bemNaming.typeOf({ block: 'block', elem: 'elem', modName: 'mod' }); // elemMod
 
 ### isBlock(str)
 
-Checks whether string `str` is a block.
+Checks whether string is a block.
 
 Example:
 
@@ -230,7 +215,7 @@ bemNaming.isBlock('block__elem');  // false
 
 ### isBlock(obj)
 
-Checks whether BEM-naming `obj` is a block.
+Checks whether naming object is a block.
 
 Example:
 
@@ -241,7 +226,7 @@ bemNaming.isBlock({ block: 'block', elem: 'elem' });  // false
 
 ### isBlockMod(str)
 
-Checks whether string `str` is modifier of a block.
+Checks whether string is modifier of a block.
 
 Example:
 
@@ -252,7 +237,7 @@ bemNaming.isBlockMod('block__elem_mod');  // false
 
 ### isBlockMod(obj)
 
-Checks whether BEM-naming `obj` is modifier of a block.
+Checks whether naming object is modifier of a block.
 
 Example:
 
@@ -266,7 +251,7 @@ bemNaming.isBlockMod({ block: 'block', elem: 'elem',
 
 ### isElem(str)
 
-Checks whether string `str` is element of a block.
+Checks whether string is element of a block.
 
 Example:
 
@@ -277,7 +262,7 @@ bemNaming.isElem('block-name');   // false
 
 ### isElem(obj)
 
-Checks whether BEM-naming `obj` is element of a block.
+Checks whether naming object is element of a block.
 
 Example:
 
@@ -288,7 +273,7 @@ bemNaming.isElem({ block: 'block-name' });           // false
 
 ### isElemMod(str)
 
-Checks whether string `str` is modifier of an element.
+Checks whether string is modifier of an element.
 
 Example:
 
@@ -299,7 +284,7 @@ bemNaming.isElemMod('block__elem');      // false
 
 ### isElemMod(obj)
 
-Checks whether BEM-naming `obj` is modifier of an element.
+Checks whether naming object is modifier of an element.
 
 Example:
 
@@ -323,6 +308,21 @@ String to separate modifiers from blocks and elements.
 
 String to separate value of modifier from name of modifier.
 
+Common misconceptions
+---------------------
+
+BEM methodology involves the use of flat structure inside a block. It means that BEM entity can not be represented as an element of the other element and the following string representation will be invalid:
+
+```js
+'block__some-elem__sub-elem'
+```
+
+Also there is no such BEM entity as a modifier and an element modifier simultaneously so the following string representation will be invalid:
+
+```js
+'block_block-mod-name_block-mod-val__elem-name_elem-mod-name_elem-mod-val'
+```
+
 Custom naming convention
 ------------------------
 

README.ru.md

@@ -41,9 +41,9 @@ bemNaming.stringify({ block: 'button', modName: 'checked' }); // button_checked
 ----------
 
 * [Строковое представление](#Строковое-представление)
-* [Частые заблуждения](#Частые-заблуждения)
 * [БЭМ-нотация](#БЭМ-нотация)
 * [API](#api)
+* [Частые заблуждения](#Частые-заблуждения)
 * [Собственный стиль](#Собственный-стиль)
 * [В стиле Гарри Робертса](#В-стиле-Гарри-Робертса)
 
@@ -66,21 +66,6 @@ bemNaming.stringify({ block: 'button', modName: 'checked' }); // button_checked
 * Модификатор элемента в формате ключ-значение — `block-name__elem-name_mod-name_mod-val`.
 * Булевый модификатор элемента — `block-name__elem_mod`.
 
-Частые заблуждения
-------------------
-
-БЭМ-методология предполагает использование плоской структуры внутри блока, это означает, что БЭМ-сущность не может быть представлена как элемент элемента, и следующее строковое представление будет невалидным:
-
-```js
-'block__some-elem__sub-elem'
-```
-
-Также не бывает такой БЭМ-сущности, как модификатор блока и модификатор элемента одновременно, поэтому следующее строковое представление будет невалидным:
-
-```js
-'block_block-mod-name_block-mod-val__elem-name_elem-mod-name_elem-mod-val'
-```
-
 БЭМ-нотация
 -----------
 
@@ -323,6 +308,21 @@ bemNaming.isElemMod({ block: 'block',
 
 Строка для разделения значения модификатора от названия модификатора.
 
+Частые заблуждения
+------------------
+
+БЭМ-методология предполагает использование плоской структуры внутри блока, это означает, что БЭМ-сущность не может быть представлена как элемент элемента, и следующее строковое представление будет невалидным:
+
+```js
+'block__some-elem__sub-elem'
+```
+
+Также не бывает такой БЭМ-сущности, как модификатор блока и модификатор элемента одновременно, поэтому следующее строковое представление будет невалидным:
+
+```js
+'block_block-mod-name_block-mod-val__elem-name_elem-mod-name_elem-mod-val'
+```
+
 Собственный стиль
 -----------------