Skip to content
Stylelint configs for edX Sass files
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.eslintrc.js
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
package.json
stylelint.config.js

README.md

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:

You can’t perform that action at this time.