Skip to main content

Getting Started

Installationโ€‹

npm install --save-dev stylelint stylelint-plugin-font

Quick start with a shareable configโ€‹

import { fontPluginConfigs } from "stylelint-plugin-font";

export default fontPluginConfigs["font-recommended"];

Quick start with extendsโ€‹

export default {
extends: [
"stylelint-config-standard",
"stylelint-config-recess-order",
"stylelint-config-idiomatic-order",
"stylelint-config-standard-scss",
"stylelint-config-tailwindcss",
"stylelint-plugin-font/configs/font-recommended",
],
};

Manual plugin registrationโ€‹

If you prefer to compose rules manually:

import fontPlugin from "stylelint-plugin-font";

export default {
plugins: ["stylelint-plugin-font"],
// Alternative explicit pack form:
// plugins: [...fontPlugin],
rules: {
"font/require-font-display": true,
},
};

This package default-exports a plugin-pack array, so both plugin registration forms are supported.