Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyler Kellen committed Nov 28, 2012
1 parent 4a77e99 commit 3c1aed3
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 158 deletions.
74 changes: 1 addition & 73 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,73 +1 @@
[Grunt homepage](http://gruntjs.com/) | [Documentation table of contents](https://github.com/gruntjs/grunt/blob/devel/docs/toc.md)

# Contributing to grunt

There are a number of grunt projects.

* [grunt](https://github.com/gruntjs/grunt) - the main grunt project
* [gruntjs.com](https://github.com/gruntjs/gruntjs.com) - the gruntjs.com website
* [grunt-contrib collection](https://github.com/gruntjs/grunt-contrib) - a collection of all grunt "contrib" plugins

In addition, each individual grunt-contrib plugin is a separate repository listed on the [gruntjs org homepage](https://github.com/gruntjs).

## Filing issues
If something isn't working like you think it should, please read the documentation first. If you'd like to chat with someone, [pop into IRC](#discussing-grunt) and ask your question there.

The best way to ensure an issue gets addressed is to file it in the appropriate issues tracker.

**If there's an issue with a specific grunt-contrib plugin:**
Please file an issue on that plugin's issues tracker.

**If you'd like to contribute a new plugin:**
Please file an issue on the [grunt-contrib collection issues tracker](https://github.com/gruntjs/grunt-contrib/issues). We don't accept all plugins, but we'll certainly consider yours.

**If there's an issue with the [website](http://gruntjs.com/):**
Please file an issue on the [gruntjs.com website issues tracker](https://github.com/gruntjs/gruntjs.com/issues).

**If there's an issue that isn't specific to any of the above:**
Please file an issue on the [grunt issues tracker](https://github.com/gruntjs/grunt/issues).

### Simplify the issue
Try to [reduce your code](http://www.webkit.org/quality/reduction.html) to the bare minimum required to reproduce the issue. This makes it much easier (and much faster) to isolate and fix the issue.

### Explain the issue
If we can't reproduce the issue, we can't fix it. Please list the exact steps required to reproduce the issue. Include versions of your OS, Node.js, grunt, etc. Include relevant logs or sample code.

## Discussing grunt
Join the [freenode](http://freenode.net/) IRC #grunt channel. We've got a bot and everything.

_No private messages, please._

## Modifying grunt
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.

1. Fork and clone the repo.
1. Check out the correct branch. Currently, grunt development happens in the `devel` branch.
1. Run `npm install` to install all grunt dependencies.
1. Run `npm link` to put the dev version of grunt in the system path (this is only needed for developing grunt, not for plugins or the website).
1. Run `grunt` to grunt grunt.

Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing breaks.

### Submitting pull requests

1. Create a new branch, please don't work in your `master` or `devel` branch directly.
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
1. Fix stuff.
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
1. Update the documentation to reflect any changes.
1. Push to your fork and submit a pull request.

### Syntax

* Two space indents. Don't use tabs anywhere. Use `\t` if you need a tab character in a string.
* No trailing whitespace, except in markdown files where a linebreak must be forced.
* Don't go overboard with the whitespace.
* No more than [one assignment](http://benalman.com/news/2012/05/multiple-var-statements-javascript/) per `var` statement.
* Delimit strings with single-quotes `'`, not double-quotes `"`.
* Prefer `if` and `else` to ["clever"](http://programmers.stackexchange.com/a/25281) uses of `? :` conditional or `||`, `&&` logical operators.
* Comments are great. Just put them _before_ the line of code, _not_ at the _end_ of the line.
* **When in doubt, follow the conventions you see used in the source already.**

### Reverting back to the "official" grunt
If you've used `npm link` to put a dev version of grunt in the system path and, for some reason, need to revert back to the current official grunt release, just reinstall grunt globally with `npm install -g grunt`
Please see the [Contributing to grunt](http://gruntjs.com/contributing) guide for information on contributing to this project.
74 changes: 22 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,81 +2,50 @@

> Compile Stylus files to CSS.
_Note that this plugin has not yet been released, and only works with the latest bleeding-edge, in-development version of grunt. See the [When will I be able to use in-development feature 'X'?](https://github.com/gruntjs/grunt/blob/devel/docs/faq.md#when-will-i-be-able-to-use-in-development-feature-x) FAQ entry for more information._

## Getting Started
_If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide._
If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide, as it explains how to create a [gruntfile][Getting Started] as well as install and use grunt plugins. Once you're familiar with that process, install this plugin with this command:

From the same directory as your project's [Gruntfile][Getting Started] and [package.json][], install this plugin with the following command:

```bash
```shell
npm install grunt-contrib-stylus --save-dev
```

Once that's done, add this line to your project's Gruntfile:

```js
grunt.loadNpmTasks('grunt-contrib-stylus');
```

If the plugin has been installed correctly, running `grunt --help` at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a `devDependency`, which ensures that it will be installed whenever the `npm install` command is run.

[grunt]: http://gruntjs.com/
[Getting Started]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md
[package.json]: https://npmjs.org/doc/json.html


## The stylus task

### Overview
## Stylus task
_Run this task with the `grunt stylus` command._

In your project's Gruntfile, add a section named `stylus` to the data object passed into `grunt.initConfig()`.
_This task is a [multi task][] so any targets, files and options should be specified according to the [multi task][] documentation._
[multi task]: https://github.com/gruntjs/grunt/wiki/Configuring-tasks

```js
grunt.initConfig({
stylus: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```

This task comes preloaded with [nib](http://visionmedia.github.com/nib/).
### Options

## files
Type: `object`

Defines what files this task will process and should contain key:value pairs.

The key (destination) should be an unique filepath (supports [grunt.template](https://github.com/gruntjs/grunt/blob/master/docs/api_template.md)) and the value (source) should be a filepath or an array of filepaths (supports [minimatch](https://github.com/isaacs/minimatch)).

You can use *.{ext} as your destination filename to individually compile each file to the destination directory. Otherwise, when the source contains an array of multiple filepaths, the contents are concatenated in the order passed. **This API will be changing**
### Options

## options.basePath
#### basePath
Type: `String` (individual only)

Adjusts the folder structure when compiled to the destination directory. When not explicitly set, best effort is made to locate the basePath by comparing all source filepaths left to right for a common pattern.
Adjusts the folder structure when compiled to the destination directory. When not explicitly set, best effort is made to locate the basePath by comparing all source filepaths left to right for a common pattern. You can use *.{ext} as your destination filename to individually compile each file to the destination directory. Otherwise, when the source contains an array of multiple filepaths, the contents are concatenated in the order passed. **This API will be changing**

## options.compress
#### compress
Type: `Boolean`
Default: false

Specifies if we should compress the compiled css.

## options.flatten
#### flatten
Type: `Boolean` (individual only)

Performs a flat compile that dumps all the files into the root of the destination directory, overwriting files if they exist.

## options.paths
Type: `String|Array`
#### paths
Type: `String` `Array`

Specifies directories to scan for @import directives when parsing.

### Examples

```js
Expand Down Expand Up @@ -106,12 +75,13 @@ stylus: {

## Release History

* 2012-10-11 - v0.3.1 - Rename grunt-contrib-lib dep to grunt-lib-contrib.
* 2012-09-23 - v0.3.0 - Options no longer accepted from global config key. Individually compile into dest, maintaining folder structure.
* 2012-09-16 - v0.2.2 - Tests refactored, better watch integration.
* 2012-09-09 - v0.2.0 - Refactored from grunt-contrib into individual repo.
* 2012-10-11   v0.3.1   Rename grunt-contrib-lib dep to grunt-lib-contrib.
* 2012-09-23   v0.3.0   Options no longer accepted from global config key. Individually compile into dest, maintaining folder structure.
* 2012-09-16   v0.2.2   Tests refactored, better watch integration.
* 2012-09-09   v0.2.0   Refactored from grunt-contrib into individual repo.

---

--
Task submitted by <a href="http://ericw.ca">Eric Woroshow</a>.
Task submitted by [Eric Woroshow](http://ericw.ca)

*Generated on Thu Oct 18 2012 19:01:17.*
*This file was generated on Wed Nov 28 2012 08:47:07.*
23 changes: 7 additions & 16 deletions docs/stylus-options.md
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,22 @@
# Options

## files
Type: `object`

Defines what files this task will process and should contain key:value pairs.

The key (destination) should be an unique filepath (supports [grunt.template](https://github.com/gruntjs/grunt/blob/master/docs/api_template.md)) and the value (source) should be a filepath or an array of filepaths (supports [minimatch](https://github.com/isaacs/minimatch)).

You can use *.{ext} as your destination filename to individually compile each file to the destination directory. Otherwise, when the source contains an array of multiple filepaths, the contents are concatenated in the order passed. **This API will be changing**

## options.basePath
## basePath
Type: `String` (individual only)

Adjusts the folder structure when compiled to the destination directory. When not explicitly set, best effort is made to locate the basePath by comparing all source filepaths left to right for a common pattern.
Adjusts the folder structure when compiled to the destination directory. When not explicitly set, best effort is made to locate the basePath by comparing all source filepaths left to right for a common pattern. You can use *.{ext} as your destination filename to individually compile each file to the destination directory. Otherwise, when the source contains an array of multiple filepaths, the contents are concatenated in the order passed. **This API will be changing**

## options.compress
## compress
Type: `Boolean`
Default: false

Specifies if we should compress the compiled css.

## options.flatten
## flatten
Type: `Boolean` (individual only)

Performs a flat compile that dumps all the files into the root of the destination directory, overwriting files if they exist.

## options.paths
Type: `String|Array`
## paths
Type: `String` `Array`

Specifies directories to scan for @import directives when parsing.
Specifies directories to scan for @import directives when parsing.
19 changes: 2 additions & 17 deletions docs/stylus-overview.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Overview
{%= s.multi_task %}

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

```js
grunt.initConfig({
stylus: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```

This task comes preloaded with [nib](http://visionmedia.github.com/nib/).
This task comes preloaded with [nib](http://visionmedia.github.com/nib/).

0 comments on commit 3c1aed3

Please sign in to comment.