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

@considonet/stylelint-config-bem

v1.0.1

Published

Default stylelint ruleset for BEM methodology stylesheets in ConsidoNet projects

Downloads

1,244

Readme

@considonet/stylelint-config-bem

Default stylelint ruleset for BEM methodology-based stylesheets in ConsidoNet projects.

Rules

This config is built upon stylelint-selector-bem-pattern.

After some tweaks the following rules are applied:

  • Two Dashes style naming scheme - block__element--modifier.
  • Optional (and recommended for Considonet projects) namespaced naming scheme supported - c-block__element--modifier
  • One block (component) per one file (except utilities)
  • Block names consistent with filenames (minus extension, optional namespace and optional _ filename prefix for Sass/SCSS).
  • svg and img can be styled by tag name.
  • No namespace modifiers are accepted for component state - -is- and -has prefixed classnames (for example .c-block.-is-active).

Installation

Using npm:

npm install --save-dev @considonet/stylelint-config-bem

or using yarn:

yarn add @considonet/stylelint-config-bem --dev

Usage

In your .stylelintrc.js file extend your config:

{ 
  "extends": "@considonet/stylelint-config-bem"
}

Implicit components

By default all linted stylesheets are treated as implicit components. It means that component names used for linting are based on the filenames. Although plugin config allows to narrow down implicit components, stylelint does not allow to merge nested options. It means that to disable it for some files, stylelint-disable comment is required. Example:

/* not-bem.css */
/* stylelint-disable plugin/selector-bem-pattern */
a {
    color: inherit;
}
/* stylelint-enable plugin/selector-bem-pattern */

Usage with other configs

This config contains only rules for BEM and probably you don't want to use it standalone. We recommend to use @considonet/stylelint-config-bem with at least @considonet/stylelint-config-scss or any other general ruleset.

See popular stylelint configs for more inspirations.

Example usage with other our packages:

{
  "extends": [
    "@considonet/stylelint-config-bem",
    "@considonet/stylelint-config-scss",
    "@considonet/stylelint-config-order"
  ]
}

You can also use our default preset which includes this configuration - @considonet/stylelint-config-default.