Laravel Elixir SCSS-Lint Extension

1.3.1 verified Fri May 01 auth: no javascript deprecated

Laravel Elixir extension to integrate SCSS-Lint into your build process. Current stable version 1.3.1, last released in 2016. Requires Laravel Elixir >=3.0.0 <6.0.0. Allows linting SCSS files via the mix.scssLint() command. Differentiated by tight integration with Laravel Elixir but relies on external Ruby gem 'scss-lint' and is now largely outdated given Elixir's deprecation.

Common errors

error Error: Cannot find module 'laravel-elixir' ↓

cause Missing peer dependency laravel-elixir.

fix

Install laravel-elixir: npm install laravel-elixir --save-dev

error sh: scss-lint: command not found ↓

cause Ruby gem scss-lint is not installed.

fix

Install the gem: gem install scss-lint

Warnings

deprecated Laravel Elixir is itself deprecated, and this extension is no longer maintained. ↓

fix Consider using Laravel Mix and standalone scss-lint or stylelint.

gotcha Requires Ruby gem 'scss-lint' to be installed separately. Not installed via npm. ↓

fix Run 'gem install scss-lint' before using the extension.

Install

npm install laravel-elixir-scss-lint

yarn add laravel-elixir-scss-lint

pnpm add laravel-elixir-scss-lint

Imports

laravel-elixir-scss-lint
wrong
```
import ... from 'laravel-elixir-scss-lint'
```
correct
```
require('laravel-elixir-scss-lint')
```
CommonJS require only, no ESM or named exports
.scssLint()
wrong
```
mix.scssLint() without requiring the package first
```
correct
```
mix.scssLint()
```
Must require('laravel-elixir-scss-lint') before using in Gulpfile

Quickstart

Basic Gulpfile setup to lint SCSS files using Elixir's mix command.

var elixir = require('laravel-elixir');
require('laravel-elixir-scss-lint');

elixir(function(mix) {
    mix.scssLint();
});