stringify

Stringifier for a BEM entity representation.

[![NPM Status][npm-img]][npm]

[npm]: https://www.npmjs.org/package/@bem/sdk.naming.entity.stringify
[npm-img]: https://img.shields.io/npm/v/@bem/sdk.naming.entity.stringify.svg

* Introduction
* Try stringify
* Quick start
* API reference
* Parameter tuning

Introduction

Stringify returns a string with the name of the specified BEM entity representation. This name can be used in class attributes.

You can choose which naming convention to use for creating a stingify() function.

> Note. If you don't have any BEM projects available to try out the @bem/sdk.naming.entity.stringify package, the quickest way to create one is to use bem-express.

Try stringify

An example is available in the RunKit editor.

Quick start

> Attention. To use @bem/sdk.naming.entity.stringify, you must install Node.js 8.0+.

To run the @bem/sdk.naming.entity.stringify package:

1. Install required packages.
3. Create a stringify() function.
4. Make a string from a BEM entity.

$3

Install the following packages:

* @bem/sdk.naming.entity.stringify, which contains the stringify() function.
* @bem/sdk.naming.presets, which contains presets with well-known naming conventions.

To install the packages, run the following command:

``
$ npm install --save @bem/sdk.naming.entity.stringify @bem/sdk.naming.presets
`

$3

Create a JavaScript file with any name (for example, app.js) and do the following:

1. Choose the naming convention and import the preset with this convention (for example, origin naming convention).
1. Import the @bem/sdk.naming.entity.stringify package and create the stringify() function using the imported preset:

`js
const originNaming = require('@bem/sdk.naming.presets/origin');
const stringify = require('@bem/sdk.naming.entity.stringify')(originNaming);
`

$3

Stringify an object representation of a BEM entity:

`js
stringify({ block: 'my-block', mod: 'my-modifier' });
`

This function will return the string my-block_my-modifier.

Example:

`js
const originNaming = require('@bem/sdk.naming.presets/origin');
const stringify = require('@bem/sdk.naming.entity.stringify')(originNaming);

console.log(stringify({ block: 'my-block', mod: 'my-modifier' }));
// => my-block_my-modifier

console.log(stringify({ block: 'my-block', mod: { name: 'my-modifier'}}));
// => my-block_my-modifier

console.log(stringify({ block: 'my-block',
mod: { name: 'my-modifier', val: 'some-value'}}));
// => my-block__my-modifier_some-value

console.log(stringify({ block: 'my-block', elem: 'my-element' }));
// => my-block__my-element

console.log(stringify({ block: 'my-block',
elem: 'my-element',
mod: 'my-modifier'}));
// => my-block__my-element_my-modifier

console.log(stringify({ block: 'my-block',
elem: 'my-element',
mod: { name: 'my-modifier', val: 'some-value'}}));
// => my-block__my-element_my-modifier_some-value
`

RunKit live example.

API reference

$3

Forms a string based on the object representation of a BEM entity.

`js
/**
* @typedef BemEntityName
* @property {string} block — Block name.
* @property {string} [elem] — Element name.
* @property {string|Object} [mod] — Modifier name or object with name and value.
* @property {string} mod.name — Modifier name.
* @property {string|boolean} [mod.val] — Modifier value.
*/

/**
* @param {object|BemEntityName} entity — Object representation of the BEM entity.
* @returns {string} — Name of the BEM entity. This name can be used in class attributes.
*/
stringify(entity);
`

Parameter tuning

$3

Specify an INamingConvention object with the delims field, which defines the delimiters that are used to separate names in the naming convention.

Use this object to make your stringify() function.

Example:

`js
const convention = {
delims: {
elem: '_EL-',
mod: {
name: '_MOD-',
val: '-'
}}};
const stringify = require('@bem/sdk.naming.entity.stringify')(convention);

console.log(stringify({ block: 'myBlock',
elem: 'myElement',
mod: 'myModifier'}));
// => myBlock_EL-myElement_MOD-myModifier
``

RunKit live example.