Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ysakmrkm/grunt-sass-format

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/ysakmrkm/grunt-sass-format
Owner: ysakmrkm
License: mit
Created: 2014-03-23T02:51:56.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2016-02-21T07:24:42.000Z (almost 9 years ago)
Last Synced: 2024-11-07T15:58:22.823Z (3 months ago)
Language: CoffeeScript
Size: 269 KB
Stars: 4
Watchers: 1
Forks: 2
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT

Awesome Lists containing this project

README

# grunt-sass-format

> Check format of sass you wish.

## Getting Started
This plugin requires Grunt `~0.4.3`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
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:

```js
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()`.

```js
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

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

#### Custom Options

```js
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](http://gruntjs.com/).

## 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