A Code Climate engine for the mighty, modern CSS linter
Switch branches/tags
Nothing to show
Clone or download
Latest commit 48906fb Jul 14, 2018

README.md

Code Climate Stylelint Engine

Maintainability

A Code Climate engine that wraps stylelint.
You can run it on your local environment using the Code Climate CLI, or on the hosted analysis platform.

Stylelint is a tool to help you enforce consistent conventions and avoid errors in your stylesheets.
It can be configured using a configuration file.

Installation

  1. If you haven't already, install the Code Climate CLI.
  2. Run codeclimate engines:enable stylelint. This command both installs the engine and enables it in your .codeclimate.yml file.
  3. Add a stylelint config file.
  4. You're ready to analyze! Browse into your project's folder and run codeclimate analyze.

Configuration Options

  • ignore_warnings: true|false (default false) - skip warnings with styletint quiet flag
  • config: Specify a relative path for the configuration file. (ex: config/.stylelintrc)

Configs

Plugins

This engine has support for the recommended plugins:

If you need something else, please open an issue.

Processors

This engine has support for some of the recommended processors:

Development

If you want to run the code locally, you'll need to install docker and build the image.
Navigate to the project in your terminal and run:

docker build -t codeclimate/codeclimate-stylelint .

Tests

run npm test or ./run-tests.sh after building the image.

If you need something else, please open an issue.

Need help?

For help with stylelint, check out their documentation.