https://github.com/billybonks/ember-cli-stylelint

Adds styleint to your ember app, to lint all kinds of css
https://github.com/billybonks/ember-cli-stylelint

Last synced: 26 days ago
JSON representation

Adds styleint to your ember app, to lint all kinds of css

• Host: GitHub
• URL: https://github.com/billybonks/ember-cli-stylelint
• Owner: billybonks
• License: mit
• Created: 2016-05-15T15:31:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T17:04:11.000Z (about 2 years ago)
• Last Synced: 2024-12-12T07:21:55.576Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 1.91 MB
• Stars: 47
• Watchers: 6
• Forks: 13
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-ember - ember-cli-stylelint - Adds styleint to your ember app, to lint all kinds of css. (Packages / CSS & etc)

README

        

![dependencies](https://img.shields.io/david/billybonks/ember-cli-stylelint.svg)

[![ember-observer](http://emberobserver.com/badges/ember-cli-stylelint.svg)](https://emberobserver.com/addons/ember-cli-stylelint)

[![downloads](https://img.shields.io/npm/dm/ember-cli-stylelint.svg)](https://www.npmjs.com/package/ember-cli-stylelint)

[![build](https://travis-ci.org/billybonks/ember-cli-stylelint.svg?branch=master)](https://travis-ci.org/billybonks/ember-cli-stylelint/branches)

Installation

------------------------------------------------------------------------------

# ember-cli-stylelint

An Ember-CLI addon that allows easy integration with [stylelint](http://stylelint.io/)

## Installation

`ember install ember-cli-stylelint`

## Syntax

By default syntax is `scss`, if you want to use another one you need to configure the option in your `ember-cli-build`

```javascript

var app = new EmberApp(defaults, {

  stylelint: {

    linterConfig:{

      syntax: 'less'

    },

  }

});

```

You can use one of the following values for `syntax`

- scss

- css

- less

- sugarss

## Configuration

Linting configuration can be added in a

* a stylelint property in package.json

* a .stylelintrc file

* a stylelint.config.js file exporting a JS object

as required by [stylelint](http://stylelint.io/user-guide/configuration/).

the parent key is `styleLint`

## Options

`linterConfig` {Object}

Hash as specified by [stylelint](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/node-api.md)

doesn't accept `files` option

`onError` {function}

A hook that allows you to do whatever you want

`consoleLogger` {function}

This function is called every time a file has an error. It allows you to generate custom error output according to your preferences.

`testFailingFiles` {boolean}

If true it will generate a unit test if the file fails lint.

`testPassingFiles` {boolean}

If true it will generate a unit test if the file passes lint.

`generateTests` {boolean}

If true it will generate tests for both passing and failing tests, overrides the testPassingFiles and testFailingFiles

`disableConsoleLogging` {boolean}

If true it will disable logging of errors to console

`includePaths` {array of strings}

Paths representing trees to lint. The app tree itself will always be included.

In an addon, that path is `tests/dummy/app/styles/` (by default). Addon authors

can set `includePaths: [ 'app/styles' ]` to also lint styles in `app/styles/`.

## Running Tests

* `npm test`

## Development

All tests are currently contained in tests/runner.js. This uses Mocha/Chai, not Ember Testing. Tests can be run with:

`npm test`

Contributing

------------------------------------------------------------------------------

See the [Contributing](CONTRIBUTING.md) guide for details.

License

------------------------------------------------------------------------------

PRs are welcomed and should be issued to the master branch.