Validate CSS with 8-point grid guideline
Switch branches/tags
Nothing to show
Clone or download
dcrtantuco Merge pull request #9 from dcrtantuco/fix/issue-8
Support top, right, bottom and left css properties
Latest commit 685c9f7 Oct 9, 2018

README.md

stylelint-8-point-grid

Build Status

Validates any defined margin, padding, height, and width

Why?

Unsupported

calc CSS function and sass variables

Installation

npm

npm install stylelint-8-point-grid --save-dev

yarn

yarn add stylelint-8-point-grid --dev

Usage

Update .stylelintrc or stylelint config in package.json

Recommended config

// .stylelintrc
{
  "extends": [
    "stylelint-8-point-grid"
  ]
}

Extending the config

// .stylelintrc
{
  "extends": [
    "stylelint-8-point-grid"
  ],
  "rules": {
    "plugin/8-point-grid": {
      "base": 4,
      "whitelist": ["2px", "1px"],
      "ignore": ["width", "height"]
    }
  }
}

base (default: 8)

value used for divisibility checking

whitelist

array of px values to be excluded from divisibility checking

ignore

array of css properties to be excluded from divisibility checking

supported values: margin, margin-top margin-bottom, margin-left, margin-right, padding, padding-top, padding-bottom, padding-left, padding-right, height, min-height, max-height, width, min-width, max-width, top, bottom, right, left

License

MIT