Have ideas to improve npm?Join in the discussion! »

stylelint-8-point-grid

1.0.0 • Public • Published

stylelint-8-point-grid

Node.js CI

Validates any defined margin, padding, height, and width.

Supports px and rem values.

Inspiration

Ignores

  • css calc() function
  • 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,
      "allowlist": ["2px", "1px"],
      "ignorelist": ["width", "height"]
    }
  }
}

base (default: 8)

value used for divisibility checking

allowlist

array of px or rem values to be excluded from divisibility checking

ignorelist

array of css properties to be excluded from divisibility checking

  • 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

Install

npm i stylelint-8-point-grid

DownloadsWeekly Downloads

13,843

Version

1.0.0

License

MIT

Unpacked Size

282 kB

Total Files

19

Last publish

Collaborators

  • avatar