# Compass Linters

These linters are designed specifically for codebases which utilize the
[Compass](http://compass-style.org/) framework. They are disabled by default,
but can be enabled by adding the following to your configuration:

```yaml
linters:
  Compass::*:
    enabled: true
```

You can of course enable/disable specific linters by referring to them by full
name, e.g. `Compass::PropertyWithMixin`.

## Compass::PropertyWithMixin

Prefer Compass mixins for properties when they exist.

**Bad: property possibly not fully supported in all browsers**
```scss
border-radius: 5px;
```

**Good: using Compass mixin ensures all vendor-prefixed extensions are rendered**
```scss
@include border-radius(5px);
```

These mixins include the necessary vendor-prefixed properties to increase the
number of browsers the CSS supports.

In the event you don't want to be warned about certain properties, you can opt
to ignore them by listing them in the `ignore` option.

Configuration Option  | Description
----------------------|--------------------------------------------------------
`ignore`              | Array of Compass mixins that should not be preferred.

# Compass Linters

These linters are designed specifically for codebases which utilize the
[Compass](http://compass-style.org/) framework. They are disabled by default,
but can be enabled by adding the following to your configuration:

```yaml
linters:
  Compass::*:
    enabled: true
```

You can of course enable/disable specific linters by referring to them by full
name, e.g. `Compass::PropertyWithMixin`.

## Compass::PropertyWithMixin

Prefer Compass mixins for properties when they exist.

**Bad: property possibly not fully supported in all browsers**
```scss
border-radius: 5px;
```

**Good: using Compass mixin ensures all vendor-prefixed extensions are rendered**
```scss
@include border-radius(5px);
```

These mixins include the necessary vendor-prefixed properties to increase the
number of browsers the CSS supports.

In the event you don't want to be warned about certain properties, you can opt
to ignore them by listing them in the `ignore` option, e.g. in your
`.scss-lint.yml`:

```yaml
linters:
  Compass::PropertyWithMixin:
    ignore:
      - 'inline-block'
```

Configuration Option  | Description
----------------------|--------------------------------------------------------
`ignore`              | Array of Compass mixins that should not be preferred.

Add example for PropertyWithMixin ignore option
Add example for PropertyWithMixin ignore option

A question raised on the issues page suggested this linter needed
additional documentation.

Change-Id: I309ff8d38b925613d365e5106efd212cf2b2ec81
Reviewed-on: http://gerrit.causes.com/42243
Tested-by: jenkins <d95b56ce41a2e1ac4cecdd398defd7414407cc08@causes.com>
Reviewed-by: Shane da Silva <67fb7bfe39f841b16a1f86d3928acc568d12c716@brigade.com>
