stylelint-bem-newbie

Stylelint BEM rules for newbie

A set of additional Stylelint rules that helps you keep your code in accordance with BEM rules.

This set of rules is designed to be a part of the BEM Project template project, which is based on different technologies and provides much more rules to help you keep your HTML and CSS sources in accordance with BEM rules.

Install

$ npm install --save-dev stylelint-bem-newbie

Usage

Setup plugin in stylelint config:

{
  "plugins": [
    "stylelint-bem-newbie"
  ],
  "rules": {
    "bem-newbie/absolute-has-two-dimensions": [true, { severity: 'warning' }],
    "bem-newbie/animation-explicit-timing-function": true,
    "bem-newbie/class-name-equal-to-file-name": true,
    "bem-newbie/display-deny-inline": true,    
    "bem-newbie/duplicated-property-value-in-media": true,
    "bem-newbie/duplicated-property-value-in-modifier": true,
    "bem-newbie/font-face-declaration-in-fonts-file-only": true,
    "bem-newbie/font-face-duplicate-src": true,
    "bem-newbie/font-weight-file-name": true,
    "bem-newbie/import-bem-path": true,
    "bem-newbie/import-fonts": true,
    "bem-newbie/import-normalize": true,
    ...
  }
}

List of rules

• bem-newbie/absolute-has-two-dimensions: Require position: absolute to be used with at least two explicit dimensions to declare position.
• bem-newbie/animation-explicit-timing-function: Require animation or animation-name to be used with 'animation-timing-function'.
• bem-newbie/class-name-equal-to-file-name: Require CSS class names in a file to be equal to the file name.
• bem-newbie/display-deny-inline: Deny 'inline-...' values for the 'display' CSS property.
• bem-newbie/duplicated-property-value-in-media: Require property values in @media sections to not duplicate values for the same properties in previous @media sections.
• bem-newbie/duplicated-property-value-in-modifier: Require property values in BEM modifier to not duplicate values for the same properties in its BEM block/element.
• bem-newbie/font-face-declaration-in-fonts-file-only: Disallow @font-face statements in CSS files in the 'blocks' folder.
• bem-newbie/font-face-duplicate-src: Require @font-face { src } attribute value to be specified once in each @font-face statement.
• bem-newbie/font-weight-file-name: Require a file name from the @font-face { src } to be synchronized with the font-weight value.
• bem-newbie/import-bem-path: Require BEM folders/files to be in accordance with the Nested BEM structure.
• bem-newbie/import-fonts: Require 'fonts' CSS file to be located in the 'vendor' or 'fonts' or 'font' folders (and not in the 'blocks' folder).
• bem-newbie/import-normalize: Require 'normalize' CSS file to be located in the 'vendor' folder and to be before other @import statements.

Used technologies:

• ESLint
• StyleLint
• PostCSS
• BEM

Todo

1. Add more rules if it is necessary for the BEM Project template project