npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bem/sdk.naming.cell.stringify

v0.0.13

Published

BemCell stringifier (aka @bem/fs-scheme/path)

Downloads

56

Readme

naming.cell.stringify

Stringifier for a BEM cell object.

NPM Status

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:

  1. Install required packages.
  2. Create a stringify() function.
  3. Create a BEM cell object.
  4. Get a file path.

Installing required packages

Install the following packages:

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:

  1. 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.
  2. Import the @bem/sdk.naming.cell.stringify package and create the stringify() 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

RunKit live example.

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

RunKit live example.

See more examples of creating presets in the @bem/sdk.naming.presets package documentation.