Narcoleptic Programmers' Medicine
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    grunt-sass-formatpublic

    grunt-sass-format

    Check format of sass you wish.

    Getting Started

    This plugin requires Grunt ~0.4.3

    If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

    npm install grunt-sass-format --save-dev

    Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

    grunt.loadNpmTasks('grunt-sass-format');

    The "sassFormat" task

    Overview

    In your project's Gruntfile, add a section named sassFormat to the data object passed into grunt.initConfig().

    grunt.initConfig({
      sassFormat: {
        options: {
          indentChar: '\t',
          indentStep: 1,
          indent: true,
          blankLine: {
            property: true,
            close: true
          },
          whiteSpace: {
            selector: true,
            property: true
          },
          order: true,
          lang: 'en',
          debug: false
        },
        files: {
          src: ['path/to/target/files']
        }
      }
    });

    Options

    options.indentChar

    Type: String Default value: '\t'

    options.indentStep

    Type: Number Default value: 1

    options.indent

    Type: Boolean Default value: true

    options.blankLine

    options.blankLine.property

    Type: Boolean Default value: true

    options.blankLine.close

    Type: Boolean Default value: true

    options.whiteSpace

    options.whiteSpace.selector

    Type: Boolean Default value: true

    options.whiteSpace.property

    Type: Boolean Default value: true

    options.order

    Type: Boolean Default value: true

    options.lang

    Type: String Default value: 'en'

    options.debug

    Type: Boolean Default value: false

    Usage Examples

    Default Options

    grunt.initConfig({
      sassFormat: {
        files: {
          src: ['src/target1.scss', 'src/target2.scss']
        }
      }
    });

    Custom Options

    grunt.initConfig({
      sassFormat: {
        options: {
          indentChar: ' ',
          indentStep: 4
        },
        files: {
          src: ['src/target1.scss', 'src/target2.scss']
        }
      }
    });

    Contributing

    In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

    Release History

    • 2014-03-23   v0.0.1   first release.
    • 2014-03-24   v0.0.3   Modify package.json
    • 2014-03-26   v0.0.4   Modify message to English.
    • 2014-05-06   v0.0.5   Merge PR #3
    • 2014-05-06   v0.0.6   Merge PR #4
    • 2014-08-21   v0.0.7   Merge PR #7 / Update functions / Enable indent check
    • 2014-12-31   v0.0.8   Close Issues #8 / Some bug fix

    install

    npm i grunt-sass-format

    Downloadsweekly downloads

    643

    version

    0.0.8

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar