@edx/stylelint-config-edx

Stylelint configs for edX Sass files.

Stats

StarsIssuesVersionUpdatedCreatedSize
@edx/stylelint-config-edx
101.1.13 years ago4 years agoMinified + gzip package size for @edx/stylelint-config-edx in KB

Readme

edX Stylelint configs

Build Status

Stylelint configs for edX Sass files.

Table of Contents

  1. Overview
  2. License
  3. Dependencies
  4. Usage
  5. The Configs

Overview

In order to standardize and enforce edX's Sass coding style across multiple codebases, edX has adopted Stylelint. This package provides the rules defined by the edX development community.

License

The code in this repository is released under the Apache 2.0 license unless otherwise noted. Please see the LICENSE file for details.

Usage

To begin using the edX Stylelint configs in a codebase, install this package from npm:

npm install --save-dev @edx/stylelint-config-edx

Then, configure your project's Stylelint config to extend stylelint-config-edx (see the ESLint docs on Using a Shareable Config).

The simplest option is to add the following to a file stylelint.config.js at the root of your repository:

module.exports = {
  extends: '@edx/stylelint-config-edx'
};

Sass Style Guide

For the most part, edX follows the recommended SCSS rules defined by the stylelint-config-recommended-scss package.

The only changes are that the following rules have been disabled:

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.