-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
64 lines (64 loc) · 8.09 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
"name": "grunt-contrib-compass",
"description": "Compile Compass to CSS",
"version": "0.1.3",
"homepage": "https://github.com/gruntjs/grunt-contrib-compass",
"author": {
"name": "Grunt Team",
"url": "http://gruntjs.com/"
},
"repository": {
"type": "git",
"url": "git://github.com/gruntjs/grunt-contrib-compass.git"
},
"bugs": {
"url": "https://github.com/gruntjs/grunt-contrib-compass/issues"
},
"licenses": [
{
"type": "MIT",
"url": "https://github.com/gruntjs/grunt-contrib-compass/blob/master/LICENSE-MIT"
}
],
"main": "Gruntfile.js",
"engines": {
"node": ">=0.8.0"
},
"scripts": {
"test": "grunt test"
},
"dependencies": {
"grunt-lib-contrib": "~0.5.2",
"tmp": "0.0.16"
},
"devDependencies": {
"grunt-contrib-clean": "~0.4.0",
"grunt-contrib-jshint": "~0.2.0",
"grunt-contrib-nodeunit": "~0.1.2",
"grunt-contrib-internal": "~0.4.2",
"grunt": "~0.4.0"
},
"peerDependencies": {
"grunt": "~0.4.0"
},
"keywords": [
"gruntplugin",
"compass",
"scss",
"sass",
"css",
"compile",
"preprocessor",
"style"
],
"readme": "# grunt-contrib-compass [![Build Status](https://secure.travis-ci.org/gruntjs/grunt-contrib-compass.png?branch=master)](http://travis-ci.org/gruntjs/grunt-contrib-compass)\n\n> Compile Compass to CSS\n\n\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf 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:\n\n```shell\nnpm install grunt-contrib-compass --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-contrib-compass');\n```\n\n\n\n\n## Compass task\n_Run this task with the `grunt compass` command._\n\nThis task requires you to have [Ruby](http://www.ruby-lang.org/en/downloads/) and [Compass](http://compass-style.org/install/). If you're on OS X or Linux you probably already have Ruby installed, try `ruby -v` in your terminal. When you've confirmed you have Ruby installed, run `gem update --system && gem install compass` to install Compass.\n\nCompass operates on a folder level, because of this you don't specify any src/dest, but instead define the `sassDir` and `cssDir` options.\n\n_This plugin is only compatible with Grunt `>= 0.4.x`._\n\n### Options\n\nCompass doesn't expose all of its [options][config] through the CLI, which this task makes use of. If you need an option not mentioned below you can either specify a path to a config.rb file in the `config` option or embed it directly into the `raw` option. Options defined in your Gruntfile will override those specified in your config.rb or `raw` property. `config` and `raw` are mutually exclusive.\n\n#### config ```string```\n\nSpecify the location of the Compass [configuration file][config] explicitly. Defaults to the same path as your Gruntfile.\n\n#### raw ```string```\n\nString form of the Compass [configuration file][config].\n\n#### basePath ```string```\n\nThe the path Compass will run from. Defaults to the same path as your Gruntfile.\n\n#### app ```string```\n\nTell compass what kind of application it is integrating with. Can be `stand_alone` (default) or `rails`.\n\n#### sassDir ```string```\n\nThe source directory where you keep your Sass stylesheets.\n\n#### cssDir ```string```\n\nThe target directory where you keep your CSS stylesheets.\n\n#### specify ```string|array```\n\nLets you specify which files you want to compile. Useful if you don't want to compile the whole folder. Globbing supported. Ignores filenames starting with underscore. Files must be in the directory you specified in `sassDir`.\n\n#### imagesDir ```string```\n\nThe directory where you keep your images.\n\n#### javascriptsDir ```string```\n\nThe directory where you keep your JavaScript files.\n\n#### fontsDir ```string```\n\nThe directory where you keep your fonts.\n\n#### environment ```string```\n\nUse sensible defaults for your current environment. Can be: `development` (default) or `production`\n\n#### outputStyle ```string```\n\nCSS output mode. Can be: `nested`, `expanded`, `compact`, `compressed`.\n\n#### relativeAssets ```boolean```\n\nMake Compass asset helpers generate relative urls to assets.\n\n#### noLineComments ```boolean```\n\nDisable line comments.\n\n#### require ```string|array```\n\nRequire the given Ruby library before running commands. This is used to access Compass plugins without having a project configuration file.\n\n#### load ```string|array```\n\nLoad the framework or extensions found in the specified directory.\n\n#### loadAll ```string|array```\n\nLoad all the frameworks or extensions found in the specified directory.\n\n#### importPath ```string|array```\n\nMakes files under the specified folder findable by Sass's @import directive.\n\n#### debugInfo ```boolean```\n\nCauses the line number and file where a selector is defined to be emitted into the compiled CSS in a format that can be understood by the browser. Automatically disabled when using `outputStyle: 'compressed'`.\n\n#### quiet ```boolean```\n\nQuiet mode.\n\n#### trace ```boolean```\n\nShow a full stacktrace on error.\n\n#### force ```boolean```\n\nAllows Compass to overwrite existing files.\n\n#### dryRun ```boolean```\n\nDry Run. Tells you what it plans to do.\n\n#### boring ```boolean```\n\nTurn off colorized output.\n\n#### bundleExec ```boolean```\n\nRun `compass compile` with [bundle exec](http://gembundler.com/man/bundle-exec.1.html): `bundle exec compass compile`.\n\n\n[config]: http://compass-style.org/help/tutorials/configuration-reference/\n\n### Usage Examples\n\n#### Example config\n\n```javascript\ngrunt.initConfig({\n compass: { // Task\n dist: { // Target\n options: { // Target options\n sassDir: 'sass',\n cssDir: 'css',\n environment: 'production'\n }\n },\n dev: { // Another target\n options: {\n sassDir: 'sass',\n cssDir: 'css'\n }\n }\n }\n});\n\ngrunt.loadNpmTasks('grunt-contrib-compass');\n\ngrunt.registerTask('default', ['jshint', 'compass']);\n```\n\n\n#### Example usage\n\n\n##### Use external config file\n\n```javascript\ngrunt.initConfig({\n compass: {\n dist: {\n options: {\n config: 'config/config.rb'\n }\n }\n }\n});\n```\n\n##### Override setting in external config file\n\n```javascript\ngrunt.initConfig({\n compass: {\n dist: {\n options: {\n config: 'config/config.rb', // css_dir = 'dev/css'\n cssDir: 'dist/css'\n }\n }\n }\n});\n```\n\n##### Use `raw` option\n\n```javascript\ngrunt.initConfig({\n compass: {\n dist: {\n options: {\n sassDir: 'sass',\n cssDir: 'css',\n raw: 'preferred_syntax = :sass\\n' // Use `raw` since it's not directly available\n }\n }\n }\n});\n```\n\n\n## Release History\n\n * 2013-02-27 v0.1.3 Fixes bundleExec.\n * 2013-02-17 v0.1.2 Ensure Gruntfile.js is included on npm.\n * 2013-02-15 v0.1.1 First official release for Grunt 0.4.0.\n * 2013-02-05 v0.1.1rc8 Added new options: basePath specify, debugInfo.\n * 2013-01-25 v0.1.1rc7 Updating grunt/gruntplugin dependencies to rc7. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.\n * 2013-01-10 v0.1.1rc5 Updating to work with grunt v0.4.0rc5.\n * 2012-10-22 v0.1.0 Initial release\n\n---\n\nTask submitted by [Sindre Sorhus](http://github.com/sindresorhus)\n\n*This file was generated on Wed Feb 27 2013 23:08:31.*\n",
"readmeFilename": "README.md",
"contributors": [
{
"name": "Sindre Sorhus",
"url": "http://github.com/sindresorhus"
}
],
"_id": "grunt-contrib-compass@0.1.3",
"_from": "grunt-contrib-compass@~0.1.3"
}