Skip to main content

Getting Started

Install the plugin next to Stylelint:

npm install --save-dev stylelint stylelint-plugin-grid

Use the recommended config for a low-noise baseline:

import { gridPluginConfigs } from "stylelint-plugin-grid";

export default gridPluginConfigs["grid-recommended"];

Or extend a subpath config from a larger Stylelint config:

export default {
extends: ["stylelint-plugin-grid/configs/grid-recommended"]
};

Enable individual rules when you need a tighter policy:

export default {
plugins: ["stylelint-plugin-grid"],
rules: {
"grid/no-invalid-areas": true,
"grid/validate-area-shapes": true,
"grid/no-unused-areas": true
}
};

Start with grid-recommended. Add grid-all only after checking the same-file assumptions in grid/no-unused-areas, grid/no-overlapping-areas, and grid/consistent-area-naming against your project structure.