Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
241 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,242 +1,3 @@ | ||
| # THIS GRUNT PLUGIN IS DEPRECATED SINCE THE RELEASE OF GRUNT.JS v0.4.0. | ||
| # [deprecated] grunt-compass | ||
|
|
||
| # PLEASE USE [`grunt-contrib-compass`](https://github.com/gruntjs/grunt-contrib-compass) FROM NOW ON. | ||
|
|
||
| ----- | ||
|
|
||
| # grunt-compass [](http://travis-ci.org/kahlil/grunt-compass) | ||
|
|
||
| This is a custom grunt.js multitask aka [gruntplugin](http://jsfiddle.net/cowboy/qzRjD/show/) that executes `compass compile` on the command line for you and prints the COMPASS output to `grunt.log.write()`. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| You need to have [node.js](http://nodejs.org/), [grunt.js](https://github.com/cowboy/grunt), [Ruby](http://www.ruby-lang.org/), [SASS](http://sass-lang.com/) and [Compass](http://compass-style.org/) installed for this to work. | ||
|
|
||
| ## Installation & Options | ||
|
|
||
| 1. Install this grunt plugin next to your project's grunt.js gruntfile with: `npm install grunt-compass`. | ||
| 2. Call `grunt.loadNpmTasks( 'grunt-compass' )` in your gruntfile. | ||
| 3. Configure `grunt watch` to watch your scss files and call the task(s). | ||
| e.g.: | ||
|
|
||
| ```javascript | ||
| watch: { | ||
| files: [ 'assets/scss/*.scss' ], | ||
| tasks: [ 'compass:dev', 'compass:prod' ] | ||
| } | ||
| ``` | ||
|
|
||
| 4. Setup your SASS and CSS paths | ||
|
|
||
| ```javascript | ||
| src: 'assets/scss', | ||
| dest: 'assets/css' | ||
| ``` | ||
|
|
||
| `src` is the folder with sass or scss files and `dest` is the folder where the css files will be placed. | ||
|
|
||
| 5. Use `specify` to specify certain files you want to compile: | ||
|
|
||
| A single file. | ||
|
|
||
| ```javascript | ||
| specify: 'assets/scss/base.scss' | ||
| ``` | ||
|
|
||
| Use globbing to match files, like: | ||
|
|
||
| ```javascript | ||
| specify: 'assets/scss/*.scss' // Match all scss files under `assets/scss` but not include files in subdirctory. | ||
| specify: 'assets/scss/**/*.scss' // Match all scss files under `assets/scss` include files in subdirctory. | ||
| ``` | ||
|
|
||
| See [minimatch](https://github.com/isaacs/minimatch) for more globbing usage. | ||
|
|
||
| Note a SASS/SCSS file will be ignored if its filename begin with an underscore `_`. And all files you specify **MUST** be under the directory that you specified with `src`. | ||
|
|
||
| See [SASS-partials](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#partials). | ||
|
|
||
| 6. Use `basePath` to specify the location in which to run Compass. Useful for when using grunt with multiple projects with seperate folder structures. | ||
|
|
||
| ```javascript | ||
| basePath: 'path/to/project/' | ||
| ``` | ||
|
|
||
| 7. You can set your custom output style like this: | ||
|
|
||
| ```javascript | ||
| outputstyle: 'compressed' | ||
| ``` | ||
| 8. You can disable line comments like this: | ||
|
|
||
| ```javascript | ||
| linecomments: false | ||
| ``` | ||
| 9. If you have multiple compass tasks and you want to force compass compilation you can do this: | ||
|
|
||
| ```javascript | ||
| forcecompile: true | ||
| ``` | ||
| 10. You can require ruby libraries before running commands like this: | ||
|
|
||
| ```javascript | ||
| require: 'animate-sass' | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ```javascript | ||
| require: [ | ||
| 'animate-sass', | ||
| 'mylib' | ||
| ] | ||
| ``` | ||
|
|
||
| 11. You can add the `--debug-info` option for use with [FireSass](https://addons.mozilla.org/en-US/firefox/addon/firesass-for-firebug/) like so: | ||
|
|
||
| ```javascript | ||
| debugsass: true | ||
| ``` | ||
|
|
||
| 12. You can set the relative assets to `true` and set an image path for the Compass spriting feature: | ||
|
|
||
| ```javascript | ||
| images: '/path/to/images', | ||
| relativeassets: true | ||
| ``` | ||
|
|
||
| 13. You can run compass with bundle exec if you need to as well: | ||
|
|
||
| ```javascript | ||
| bundleExec: true | ||
| ``` | ||
|
|
||
| 14. If you have a Compass configuration file, you can use it instead of or in addition to the options in your gruntfile: | ||
|
|
||
| ```javascript | ||
| config: '/path/to/config' | ||
| ``` | ||
|
|
||
| If the path is not absolute, it is relative to the directory containing your gruntfile. | ||
|
|
||
| 15. If you have a Compass configuration file, you set the environment variable for the config.rb file: | ||
|
|
||
| ```javascript | ||
| environment: 'production' | ||
| ``` | ||
|
|
||
| Then use it in your config.rb like so: | ||
|
|
||
| ```ruby | ||
| output_style = ( environment == :production ) ? :compressed : :expanded | ||
| ``` | ||
|
|
||
| 16. You can add a custom `IMPORT_PATH` folder, which makes files under the path findable by Sass's `@import` directive: | ||
|
|
||
| ```javascript | ||
| importPath: '/path/to/importPath' | ||
| ``` | ||
|
|
||
| 17. `grunt compass-clean` | ||
|
|
||
| Sometimes it can be faster to execute `compass clean` and recompile for production instead of doing `--force` compile. | ||
| Now grunt-compass comes with a `grunt compass-clean` task that you can use when registering prod tasks in your gruntfile like: | ||
|
|
||
| ```js | ||
| grunt.registerTask( 'prod', [ 'compass-clean', 'compass:prod' ] ); | ||
| ``` | ||
|
|
||
| 18. Run "grunt watch" and edit some SASS files :) | ||
|
|
||
| # An Example Setup | ||
|
|
||
| ```javascript | ||
| compass: { | ||
| dev: { | ||
| src: 'assets/scss', | ||
| dest: 'assets/dev/css', | ||
| linecomments: true, | ||
| forcecompile: true, | ||
| require: [ | ||
| 'animate-sass', | ||
| 'mylib' | ||
| ], | ||
| debugsass: true, | ||
| images: '/path/to/images', | ||
| relativeassets: true | ||
| }, | ||
| prod: { | ||
| src: 'assets/scss', | ||
| dest: 'assets/prod/css', | ||
| outputstyle: 'compressed', | ||
| linecomments: false, | ||
| forcecompile: true, | ||
| require: [ | ||
| 'animate-sass', | ||
| 'mylib' | ||
| ], | ||
| debugsass: false, | ||
| images: '/path/to/images', | ||
| relativeassets: true | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| # 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](/gruntjs/grunt). | ||
|
|
||
| # Real World Examples | ||
|
|
||
| * [krzysu](https://github.com/krzysu) posted a Gist with his `compass compile` configuration [over here](https://gist.github.com/2917330). | ||
| * [javiervd](https://github.com/javiervd) kindly shares his grunt.js setup [over here](https://gist.github.com/2941501). | ||
|
|
||
| # Changelog | ||
|
|
||
| v0.3.8: basepath option added. | ||
|
|
||
| v0.3.6: @shama added grunt v0.4 compatibility and the grunt-contrib style of structuring gruntplugins. Also: first tests! | ||
|
|
||
| v0.3.2: add support for IMPORT_PATH | ||
|
|
||
| v0.3.1: adds compiling of single files or a minimatch path via the `src` option | ||
|
|
||
| v0.2.14: @nebelschwade added `fonts-dir` option and fixed issue with config.rb due to changes in last version. | ||
|
|
||
| v0.2.13: Added `grunt.template.process()` function to process `src` and `dest` paths. Suggested by @necolas in issue #9. | ||
|
|
||
| v0.2.12: The option to set the image path for spriting and the relativeassets to true have been added by @gcpantazis. | ||
|
|
||
| v0.2.11: @gcpantazis added the option to set the `--debug-info` flag for Sass, useful for integration with the FireSass debugger. | ||
|
|
||
| v0.2.10: Added 'gruntplugin' as a keyword in the package.json to get listed [here](http://jsfiddle.net/cowboy/qzRjD/show/). | ||
|
|
||
| v0.2.9: Ability to require a given ruby lib before running commands. Added by @FGRibreau. | ||
|
|
||
| v0.2.8: Added an option to force compilation of SASS files via the `--force` option. | ||
|
|
||
| ---- | ||
|
|
||
| # LICENSE MIT | ||
|
|
||
| Copyright (c) 2012 Kahlil Lechelt | ||
|
|
||
| Permission is hereby granted, free of charge, to any person | ||
| obtaining a copy of this software and associated documentation | ||
| files (the "Software"), to deal in the Software without | ||
| restriction, including without limitation the rights to use, | ||
| copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the | ||
| Software is furnished to do so, subject to the following | ||
| conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
| OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT | ||
| HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
| WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
| OTHER DEALINGS IN THE SOFTWARE. | ||
| Deprecated in favor of [grunt-contrib-compass](https://github.com/gruntjs/grunt-contrib-compass). |