Skip to content

scss-lint

scss-lint documentation

scss-lint - GitHub

Configuration in Mega-Linter

Variable Description Default value
CSS_SCSS_LINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
CSS_SCSS_LINT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src\|lib)		 Include every file
CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test\|examples)		 Exclude no file
CSS_SCSS_LINT_CLI_LINT_MODE Override default CLI lint mode
- file: Calls the linter for each file
- list_of_files: Call the linter with the list of files as argument
- project: Call the linter from the root of the project		 {linter.cli_lint_mode}
CSS_SCSS_LINT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]		 [".scss", ".saas"]
CSS_SCSS_LINT_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]		 Include every file
CSS_SCSS_LINT_PRE_COMMANDS List of bash commands to run before the linter None
CSS_SCSS_LINT_POST_COMMANDS List of bash commands to run after the linter None
CSS_SCSS_LINT_CONFIG_FILE scss-lint configuration file name
Use LINTER_DEFAULT to let the linter find it		 .scss-lint.yml
CSS_SCSS_LINT_RULES_PATH Path where to find linter configuration file Workspace folder, then Mega-Linter default rules
CSS_SCSS_LINT_DISABLE_ERRORS Run linter but consider errors as warnings false
CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0

IDE Integration

Use scss-lint in your favorite IDE to catch errors before Mega-Linter !

IDE Extension Name Install
Atom linter-scss-lint Visit Web Site
IDEA scss-lint-plugin
Visual Studio Code scss-lint Install in VsCode

Mega-Linter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default Mega-Linter Flavor 94 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 41 Docker Image Size (tag) Docker Pulls
documentation Mega-Linter for documentation projects 40 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 47 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 42 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 42 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 49 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 44 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 49 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 41 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 41 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 43 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 41 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 41 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 45 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .scss, .saas

How the linting is performed

  • scss-lint is called one time by identified file

Example calls

scss-lint myfile.scss

scss-lint -config .scss-lint.yml myfile.scss

Help content

Usage: scss-lint [options] [scss-files]
    -f, --format Formatter           Specify how to display lints
    -r, --require path               Require Ruby file
    -i, --include-linter linter,...  Specify which linters you want to run
    -x, --exclude-linter linter,...  Specify which linters you don't want to run
    -c, --config config-file         Specify which configuration file you want to use
    -e, --exclude file,...           List of file names to exclude
        --stdin-file-path file-path  Specify the path to assume for the file passed via STDIN
    -o, --out path                   Write output to a file instead of STDOUT
        --[no-]color                 Force output to be colorized
        --show-formatters            Shows available formatters
        --show-linters               Display available linters
    -h, --help                       Display help documentation
    -v, --version                    Display version

Installation on mega-linter Docker image

Example success log

Results of scss-lint linter (version 0.59.0)
See documentation on https://megalinter.github.io/descriptors/css_scss_lint/
-----------------------------------------------

[SUCCESS] .automation/test/scss/scss_good_01.scss

Example error log

Results of scss-lint linter (version 0.59.0)
See documentation on https://megalinter.github.io/descriptors/css_scss_lint/
-----------------------------------------------

[ERROR] .automation/test/scss/scss_bad_01.scss
    .automation/test/scss/scss_bad_01.scss:15:1 [E] Syntax: Syntax Error: Invalid CSS after "  }": expected selector or at-rule, was "}"