Expand method in import-notation #288
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| /** | ||
| * Helpers to test import-notation first part | ||
| */ | ||
| const tests = { | ||
|
Member
There was a problem hiding this comment. Not sure about this object. Prob it's enough to make 2 simple functions
Collaborator
Author
There was a problem hiding this comment. I did it a group of functions like |
||
| /** | ||
| * Returns true if notation starts with block-part | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * b('b:button e:icon') // true | ||
| * b('e:icon') // false | ||
| * ``` | ||
| * | ||
| * @param {String} n - notation | ||
| * | ||
| * @returns {Boolean} | ||
| */ | ||
| b : n => /^b:/.test(n), | ||
|
|
||
| /** | ||
| * Returns true if notation starts with element-part | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * b('b:button e:icon') // false | ||
| * b('e:icon') // true | ||
| * ``` | ||
| * | ||
| * @param {String} n - notation | ||
| * | ||
| * @returns {Boolean} | ||
| */ | ||
| e : n => /^e:/.test(n) | ||
| }; | ||
|
|
||
| /** | ||
| * @type {ImportNotationTemplates} | ||
| */ | ||
| const templates = { | ||
| /** | ||
| * Returns block-part of notation | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * b('button') // 'b:button' | ||
| * ``` | ||
| * | ||
| * @param {String} b - name of block | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| b : b => `b:${b}`, | ||
|
|
||
| /** | ||
| * Returns element-part of notation | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * e('icon') // ' e:icon' | ||
| * ``` | ||
| * | ||
| * @param {String} e - name of element | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| e : e => e ? ` e:${e}` : '', | ||
|
|
||
| /** | ||
| * Returns modifiers-part of notation | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * m({ color: ['red', 'yellow'], theme: ['default'] }) | ||
| * // ' m:color=red|yellow m:theme=default' | ||
| * ``` | ||
| * | ||
| * @param {Object<String[]>} m - modifiers with values in arrays | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| m : m => Object.keys(m).map(name => `${templates._mn(name)}${templates._mv(m[name])}`).join(''), | ||
|
|
||
| /** | ||
| * Returns modifier-name-part of notation | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * _mn('color') // ' m:color' | ||
| * ``` | ||
| * | ||
| * @param {String} mn - name of modifier | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| _mn : mn => ` m:${mn}`, | ||
|
|
||
| /** | ||
| * Returns modifier-values-part of notation | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * _mv(['red', 'yellow']) // '=red|yellow' | ||
| * ``` | ||
| * | ||
| * @param {String[]} mv - modifier values in array | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| _mv : mv => mv.length ? `=${mv.join('|')}` : '', | ||
|
|
||
| /** | ||
| * Returns technology-part of notation | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * t('js') // ' t:js' | ||
| * ``` | ||
| * | ||
| * @param {String[]} t - name of technology | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| t : t => t ? ` t:${t}` : '' | ||
| }; | ||
|
|
||
| /** | ||
| * Helpers for BemCell | ||
| * | ||
| * @type {ImportNotationTemplates} | ||
| */ | ||
| const cellTemplates = Object.assign({}, templates, { | ||
| /** | ||
| * Returns modifiers-part of notation | ||
| * | ||
| * Example: | ||
| * ```js | ||
| * m({ name: 'theme', val: 'default' }) // ' m:theme=default' | ||
| * ``` | ||
| * | ||
| * @param {{ name: String, val: String }} m - modifier with single value | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| m : m => m ? `${templates._mn(m['name'])}${templates._mv([m['val']])}` : '' | ||
| }); | ||
|
|
||
| /** | ||
| * Returns import-notation stringify for set of templates | ||
| * | ||
| * @param {ImportNotationTemplates} ts - set of templates to build parts of import-notation | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| const stringifyBuilder = ts => x => ['block', 'elem', 'mod', 'tech'].map(k => ts[k[0]](x[k])).join(''); | ||
|
|
||
| /** | ||
| * Returns import-notation expanded by context entity | ||
| * | ||
| * @param {String} n - notation | ||
| * @param {BemEntity} ctx - context entity | ||
| * | ||
| * @returns {String} | ||
| */ | ||
| const expand = (n, ctx) => { | ||
| if(tests.b(n)) { | ||
| return n; | ||
| } | ||
|
|
||
| return templates.b(ctx.block) + (tests.e(n) ? '' : templates.e(ctx.elem)) + ' ' + n; | ||
| }; | ||
|
|
||
| module.exports = { | ||
| expand, | ||
| stringifyMergedCells : stringifyBuilder(templates), | ||
| stringifyCell : stringifyBuilder(cellTemplates) | ||
| }; | ||
|
|
||
| /** | ||
| * Helpers to build parts of import-notation. All parts concatenated by '' gives import-notation string | ||
| * | ||
| * @typedef {Object} ImportNotationTemplates | ||
| * | ||
| * @property {Function} b - returns block-part of notation | ||
| * @property {Function} e - returns element-part of notation | ||
| * @property {Function} m - returns modifiers-part of notation | ||
| * @property {Function} t - returns technology-part of notation | ||
| */ | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
expand?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, I didn't understand the difference from parse method.
Actually, I understood but it was not so obvious
add examples of the distinction between them, please
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure we need 2 methods? ;-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure!
expandgives us string and it is fast/lightweightThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure
expandis the most viable name for this functionality?I'd suggest:
fullfillfillupsate