@perplex-digital/stylelint-config
v18.0.0
Published
Order and Concentric-based property sorting for Stylelint.
Readme
Perplex CSS Order & Property Sorter
🗂️ A heavily opinionated Stylelint config that:
- Supports linting
.vuefiles - Orders CSS the way Perplex does
- Supports Tailwind 4 directives like
@applyand@variant
- Supports Tailwind 4 directives like
- Sorts CSS properties the way Concentric-CSS did but with:
- 'Box sizing' and 'Overflow' modules above the 'Box model - Margin' module
outlinegrouped with the 'Borders' module- 'Backgrounds and box-shadow' module below the 'Box model - Padding' module
- 'Positioning' and 'Anchor positioning' modules above the 'Transforms' module
Usage
- Add stylelint and this package to your project:
pnpm add stylelint @perplex-digital/stylelint-config - Configure your stylelint configuration file to extend this package:
export default { extends: ['@perplex-digital/stylelint-config'], rules: { // Add overrides and additional rules here }, };
Advanced
The default setup applies these rules:
stylelint-config-standard@dreamsicle.io/stylelint-config-tailwindcssstylelint-config-recommended-vue(includingstylelint-config-recommendedandstylelint-config-html)@stylistic/stylelint-plugin,stylelint-use-logical-specstylelint-high-performance-animation- Some overrides of these rules
order/orderwith the Perplex order.order/properties-orderwith the various property groups. If you need to configure other options for this rule, the groups can be imported separately and the rule configured to your needs.
import propertyGroups from '@perplex-digital/stylelint-config/property-groups';
export default {
extends: [], // Do not extend the config here.
rules: {
// Configure the rule manually.
'order/properties-order': propertyGroups.map((group) => ({
...group,
emptyLineBefore: 'always',
noEmptyLineBetween: true,
})),
},
};Releasing
Releases are automated with Changesets and GitHub Actions.
- Create a branch from
developand make your changes. Commit messages must follow Conventional Commits (enforced by commitlint). - Add a changeset for every user-facing change:
Pick the bump type (pnpm changesetpatch,minor,major) and write a short summary; it ends up in the changelog and release notes. Commit the generated.changeset/*.mdfile. A pre-commit hook blocks commits that touchsrc/without a new changeset. - Open a pull request into
develop. CI runspnpm lintandpnpm test. - When ready to release, create a
release/vX.Y.Zbranch fromdevelopand open a pull request intomain. After merging, the release workflow opens (or updates) a "Publish release" PR that bumps the version and updatesCHANGELOG.md. - Merge the "Publish release" PR. The workflow then publishes to npm, pushes the git tag and creates a GitHub release with the changelog as release notes.
- The workflow automatically merges
mainback intodevelopso it has the version bump and changelog.
Publishing uses npm trusted publishing (OIDC), so no npm token is needed. The trusted publisher is configured on npmjs.com for the release.yml workflow.
