Alley Stylelint Configuration

A set of stylelint configuration rules that extends the stylelint-config-sass-guidelines intended for use with SCSS syntax.

This stylelint config:

• extends the stylelint-config-sass-guidelines linter. You can view the documented configured lints for the stylelint-config-sass-guidelines in the projects readme.
• has a peer dependency of stylelint.
• has a peer dependency of stylelint-config-sass-guidelines.
• has a peer dependency of stylelint-order.

Installation

$ npm install @alleyinteractive/stylelint-config --save-dev

Usage

If you've installed @alleyinteractive/stylelint-config locally within your project, just set your stylelint config to:

{
    "extends": "@alleyinteractive/stylelint-config"
}

Property order

Properties must be in alphabetical order (order/properties-alphabetical-order). To sort existing stylesheets automatically, run:

$ npx stylelint --fix "**/*.scss"

Extending the config

Simply add a "rules" key to your config and add your overrides there.

For example, to change the block-no-empty to false and turn off the block-no-empty rule:

{
    "extends": "@alleyinteractive/stylelint-config",
    "rules": {
        "block-no-empty": false,
    }
}

Dependencies

This configuration has peer dependencies of stylelint, stylelint-config-sass-guidelines, and stylelint-order.

Changelog

0.0.1 – Initial release

Development Process

This package is developed as part of the Alley Scripts project on GitHub. The project is organized as a monorepo using npm workspaces and individual packages are published to npm under the @alleyinteractive organization.

Contributing

You can contribute to this project in several ways:

• Visit the main Alley Scripts GitHub repo to Open an issue or submit PRs.
• Alley employees can ask questions or ask for support in the #ux_development channel in Slack.

Releases

This project adheres to the Semantic Versioning 2.0.0 specification. All major, minor, and patch releases are published to npm and tagged in the repo. We will maintain separate branches for each minor release (e.g. block-editor-tools/0.1) to manage patch releases while keeping future development in the main branch.

Maintainers

This project is actively maintained by Alley Interactive. Like what you see? Come work with us.