Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 2.12 KB

README.md

File metadata and controls

57 lines (41 loc) · 2.12 KB
Raw

Make-Sass-Lint-Config

npm version Build Status Coverage Status

Convert your .scss-lint.yml config file into the equivalent .sass-lint.yml

Use the Online Converter

The easiest way to use this tool is to simply paste the contents of your .scss-lint.yml file into the demonstration converter at sasstools.github.io/make-sass-lint-config.

Command Line Usage

$ npm install -g make-sass-lint-config
$ make-sass-lint-config
  Usage: make-sass-lint-config [path]

  Convert your .scss-lint.yml config file into the equivalent .sass-lint.yml

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -o, --output [output]  the path and filename where you would like output to be written

Programmatic Usage

var makeSassLintConfig = require('make-sass-lint-config');
var jsyaml = require('js-yaml');
var fs = require('fs');

var scssLintConfigYaml = fs.readFileSync('.scss-lint.yml', 'utf8');

// Parse YAML into an object and get the object representation
// of the sass-lint config
var scssLintConfig = jsyaml.safeLoad(scssLintConfigYaml);
console.log(makeSassLintConfig.convert(scssLintConfig));

// Convert a YAML file and get YAML output
console.log(makeSassLintConfig.convertYaml(scssLintConfigYaml));

convert(scssSettings [ , options ])

Converts a scss-lint config file into a sass-lint config file

  • scssSettings - Settings parsed from YAML
  • options.debug - include additional debug information in the returned settings object, default false

convertYaml(scssSettingsYaml)

Perform convert on a string and output the converted yaml

  • scssSettingsYaml - scss-lint config in YAML format