@bem/sdk.naming.cell.stringify
v0.0.13
Published
BemCell stringifier (aka @bem/fs-scheme/path)
Downloads
43
Readme
naming.cell.stringify
Stringifier for a BEM cell object.
Introduction
Stringify returns the file path for a specified BEM cell object.
You can choose a preset with a naming convention for creating a stringify()
function. See the full list of supported presets in the @bem/sdk.naming.presets
package documentation.
All provided presets use the nested
file structure. To use the flat
structure that is better for small projects, see Using a custom naming convention.
Note. If you don't have any BEM projects available to try out the
@bem/sdk.naming.cell.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.cell.stringify
, you must install Node.js 8.0+.
To run the @bem/sdk.naming.cell.stringify
package:
Installing required packages
Install the following packages:
- @bem/sdk.naming.cell.stringify, which makes the
stringify()
function. - @bem/sdk.naming.presets, which contains presets with well-known naming conventions.
- @bem/sdk.cell, which allows you to create a BEM cell object to stringify.
To install these packages, run the following command:
$ npm install --save @bem/sdk.naming.cell.stringify @bem/sdk.naming.presets @bem/sdk.cell
Creating a stringify()
function
Create a JavaScript file with any name (for example, app.js) and do the following:
- Choose the naming convention and import the preset with this convention (for example, origin naming convention).
See the full list of supported presets in the
@bem/sdk.naming.presets
package documentation. - Import the
@bem/sdk.naming.cell.stringify
package and create thestringify()
function using the imported preset:
const originNaming = require('@bem/sdk.naming.presets/origin');
const stringify = require('@bem/sdk.naming.cell.stringify')(originNaming);
Creating a BEM cell object
Create a BEM cell object to stringify. You can use the create() function from the @bem/sdk.cell
package.
const BemCell = require('@bem/sdk.cell');
var myBemCell;
myBemCell = BemCell.create({block: 'my-block', tech: 'css' });
Getting a file path
Stringify the created BEM cell object:
stringify(myBemCell);
This function will return the string with the file path common.blocks/my-block/my-block.css
.
Example:
const originNaming = require('@bem/sdk.naming.presets/origin');
const stringify = require('@bem/sdk.naming.cell.stringify')(originNaming);
const BemCell = require('@bem/sdk.cell');
var myBemCell;
myBemCell = BemCell.create({block: 'my-block', tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block/my-block.css
myBemCell = BemCell.create({block: 'my-block',
tech: 'js' });
console.log(stringify(myBemCell));
// => common.blocks/my-block/my-block.js
myBemCell = BemCell.create({block: 'my-block',
layer: 'my-layer',
tech: 'css' });
console.log(stringify(myBemCell));
// => my-layer.blocks/my-block/my-block.css
myBemCell = BemCell.create({block: 'my-block',
mod: 'my-modifier',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block/_my-modifier/my-block_my-modifier.css
myBemCell = BemCell.create({block: 'my-block',
mod: 'my-modifier',
val: 'some-value',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block/_my-modifier/my-block_my-modifier_some-value.css
myBemCell = BemCell.create({block: 'my-block',
elem: 'my-element',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block/__my-element/my-block__my-element.css
myBemCell = BemCell.create({block: 'my-block',
elem: 'my-element',
mod: 'my-modifier',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block/__my-element/_my-modifier/my-block__my-element_my-modifier.css
API reference
stringify()
Forms a file according to the object representation of BEM cell.
/**
* @typedef BemCell — Representation of cell.
* @property {BemEntityName} entity — Representation of entity name.
* @property {string} tech — Tech of cell.
* @property {string} [layer] — Layer of cell.
*/
/**
* @param {Object|BemCell} cell — Object representation of BEM cell.
* @returns {string} — File path for the BEM cell. This name can be used in class attributes.
*/
stringify(cell);
Parameter tuning
Using a custom naming convention
To create a preset with a custom naming convention, use the create()
function from the @bem/sdk.naming.presets
package.
For example, create a preset that uses the flat scheme to describe the file structure organization.
Use the created preset to make your stringify()
function.
Example:
const options = {
fs: { scheme: 'flat' }
};
const originFlatNaming = require('@bem/sdk.naming.presets/create')(options);
const stringify = require('@bem/sdk.naming.cell.stringify')(originFlatNaming);
const BemCell = require('@bem/sdk.cell');
var myBemCell;
myBemCell = BemCell.create({block: 'my-block',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block.css
myBemCell = BemCell.create({block: 'my-block',
tech: 'js' });
console.log(stringify(myBemCell));
// => common.blocks/my-block.js
myBemCell = BemCell.create({block: 'my-block',
layer: 'my-layer',
tech: 'css' });
console.log(stringify(myBemCell));
// => my-layer.blocks/my-block.css
myBemCell = BemCell.create({block: 'my-block',
mod: 'my-modifier',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block_my-modifier.css
myBemCell = BemCell.create({block: 'my-block',
mod: 'my-modifier',
val: 'some-value',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block_my-modifier_some-value.css
myBemCell = BemCell.create({block: 'my-block',
elem: 'my-element',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block__my-element.css
myBemCell = BemCell.create({block: 'my-block',
elem: 'my-element',
mod: 'my-modifier',
tech: 'css' });
console.log(stringify(myBemCell));
// => common.blocks/my-block__my-element_my-modifier.css
See more examples of creating presets in the @bem/sdk.naming.presets
package documentation.