Permalink
Browse files

rough in .4

  • Loading branch information...
1 parent 9672630 commit caa3e095a5229a8aba87f1c553c6003c51966038 @tkellen tkellen committed Oct 19, 2012
Showing with 195 additions and 66 deletions.
  1. +14 −0 .jshintrc
  2. +73 −0 CONTRIBUTING.md
  3. +17 −25 grunt.js → Gruntfile.js
  4. +58 −18 README.md
  5. +2 −0 docs/{examples.md → jade-examples.md}
  6. +7 −9 docs/{options.md → jade-options.md}
  7. +16 −0 docs/jade-overview.md
  8. +0 −1 docs/overview.md
  9. +4 −2 package.json
  10. +4 −11 tasks/jade.js
View
14 .jshintrc
@@ -0,0 +1,14 @@
+{
+ "curly": true,
+ "eqeqeq": true,
+ "immed": true,
+ "latedef": true,
+ "newcap": true,
+ "noarg": true,
+ "sub": true,
+ "undef": true,
+ "boss": true,
+ "eqnull": true,
+ "node": true,
+ "es5": true
+}
View
73 CONTRIBUTING.md
@@ -0,0 +1,73 @@
+[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`
View
42 grunt.js → Gruntfile.js
@@ -6,29 +6,20 @@
* Licensed under the MIT license.
*/
+'use strict';
+
module.exports = function(grunt) {
- 'use strict';
// Project configuration.
grunt.initConfig({
- lint: {
- all: ['grunt.js', 'tasks/*.js', '<config:nodeunit.tasks>']
- },
-
jshint: {
+ all: [
+ 'Gruntfile.js',
+ 'tasks/*.js',
+ '<%= nodeunit.tests %>'
+ ],
options: {
- curly: true,
- eqeqeq: true,
- immed: true,
- latedef: true,
- newcap: true,
- noarg: true,
- sub: true,
- undef: true,
- boss: true,
- eqnull: true,
- node: true,
- es5: true
+ jshintrc: '.jshintrc'
}
},
@@ -55,24 +46,25 @@ module.exports = function(grunt) {
}
},
-
// Unit tests.
nodeunit: {
- tasks: ['test/*_test.js']
+ tests: ['test/*_test.js']
}
});
// Actually load this plugin's task(s).
grunt.loadTasks('tasks');
- // The clean plugin helps in testing.
- grunt.loadNpmTasks('grunt-contrib-clean');
+ // These plugins provide necessary tasks.
+ grunt.loadNpmTasks('grunt-contrib-jshint');
+ grunt.loadNpmTasks('grunt-contrib-nodeunit');
+ grunt.loadNpmTasks('grunt-contrib-internal');
- // Whenever the 'test' task is run, first clean the 'tmp' dir, then run this
+ // Whenever the "test" task is run, first clean the "tmp" dir, then run this
// plugin's task(s), then test the result.
- grunt.renameTask('test', 'nodeunit');
- grunt.registerTask('test', 'clean jade nodeunit');
+ grunt.registerTask('test', ['nodeunit']);
// By default, lint and run all tests.
- grunt.registerTask('default', 'lint test');
+ grunt.registerTask('default', ['jade', 'test', 'build-contrib']);
+
};
View
76 README.md
@@ -2,33 +2,66 @@
> Compile Jade files to HTML.
-### Overview
+_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._
-Inside your `grunt.js` file add a section named `jade`. This section specifies files to compile and the options passed to [jade](https://github.com/visionmedia/jade#public-api).
+## Getting Started
+_If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide._
-#### Parameters
+From the same directory as your project's [Gruntfile][Getting Started] and [package.json][], install this plugin with the following command:
-##### files ```object```
+```bash
+npm install grunt-contrib-jade --save-dev
+```
-This defines what files this task will process and should contain key:value pairs.
+Once that's done, add this line to your project's Gruntfile:
-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)).
+```js
+grunt.loadNpmTasks('grunt-contrib-jade');
+```
-Note: When the value contains an array of multiple filepaths, the contents are concatenated in the order passed.
+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.
-##### options ```object```
+[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
-This controls how this task (and its helpers) operate and should contain key:value pairs, see options below.
-#### Options
+## The jade task
-##### data ```object```
+### Overview
-Sets the data passed to ```jade``` during template compilation. Any data can be passed to the template (including ```grunt``` templates).
+In your project's Gruntfile, add a section named `jade` to the data object passed into `grunt.initConfig()`.
-#### Config Examples
+```js
+grunt.initConfig({
+ jade: {
+ options: {
+ // Task-specific options go here.
+ },
+ your_target: {
+ // Target-specific file lists and/or options go here.
+ },
+ },
+})
+```
+### Options
-``` javascript
+## files
+Type: `Object`
+
+This 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)).
+
+Note: When the value contains an array of multiple filepaths, the contents are concatenated in the order passed.
+
+## options.data
+Type: `Object`
+
+Sets the data passed to `jade` during template compilation. Any data can be passed to the template (including `grunt` templates).
+### Examples
+
+```js
jade: {
compile: {
options: {
@@ -45,7 +78,7 @@ jade: {
If you want to generate a debug file and a release file from the same template:
-``` javascript
+```js
jade: {
debug: {
options: {
@@ -72,7 +105,7 @@ jade: {
If you want to use `grunt` template in `options.data`:
-``` javascript
+```js
jade: {
debug: {
options: {
@@ -90,7 +123,7 @@ jade: {
or you can use `grunt` helpers (grunt object was exposed at template context):
-``` javascript
+```js
jade: {
debug: {
options: {
@@ -106,6 +139,13 @@ jade: {
}
```
+## 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.
+ * 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](https://github.com/errcw).*
+*Generated on Thu Oct 18 2012 19:03:21.*
View
2 docs/examples.md → docs/jade-examples.md
@@ -1,3 +1,5 @@
+# Examples
+
```js
jade: {
compile: {
View
16 docs/options.md → docs/jade-options.md
@@ -1,17 +1,15 @@
-##### files ```object```
+# Options
+
+## files
+Type: `Object`
This 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)).
Note: When the value contains an array of multiple filepaths, the contents are concatenated in the order passed.
-##### options ```object```
-
-This controls how this task (and its helpers) operate and should contain key:value pairs, see options below.
-
-#### Options
-
-##### data ```object```
+## options.data
+Type: `Object`
-Sets the data passed to ```jade``` during template compilation. Any data can be passed to the template (including ```grunt``` templates).
+Sets the data passed to `jade` during template compilation. Any data can be passed to the template (including `grunt` templates).
View
16 docs/jade-overview.md
@@ -0,0 +1,16 @@
+# Overview
+
+In your project's Gruntfile, add a section named `jade` to the data object passed into `grunt.initConfig()`.
+
+```js
+grunt.initConfig({
+ jade: {
+ options: {
+ // Task-specific options go here.
+ },
+ your_target: {
+ // Target-specific file lists and/or options go here.
+ },
+ },
+})
+```
View
1 docs/overview.md
@@ -1 +0,0 @@
-Options are passed to [jade](https://github.com/visionmedia/jade#public-api).
View
6 package.json
@@ -32,8 +32,10 @@
"grunt-lib-contrib": "~0.3.0"
},
"devDependencies": {
- "grunt": "~0.3.15",
- "grunt-contrib-clean": "~0.3.0"
+ "grunt-contrib-jshint": "0.1.0",
+ "grunt-contrib-nodeunit": "0.1.0",
+ "grunt-contrib-internal": "*",
+ "grunt": "~0.4.0a"
},
"keywords": [
"gruntplugin"
View
15 tasks/jade.js
@@ -6,27 +6,20 @@
* Licensed under the MIT license.
*/
-module.exports = function(grunt) {
- 'use strict';
+'use strict';
- // TODO: ditch this when grunt v0.4 is released
- grunt.util = grunt.util || grunt.utils;
+module.exports = function(grunt) {
grunt.registerMultiTask('jade', 'Compile Jade templates into HTML.', function() {
+ var srcFiles, taskOutput;
var helpers = require('grunt-lib-contrib').init(grunt);
- var options = helpers.options(this, {
+ var options = this.options({
data: {}
});
grunt.verbose.writeflags(options, 'Options');
- // TODO: ditch this when grunt v0.4 is released
- this.files = this.files || helpers.normalizeMultiTaskFiles(this.data, this.target);
-
- var srcFiles;
- var taskOutput;
-
this.files.forEach(function(file) {
srcFiles = grunt.file.expandFiles(file.src);

0 comments on commit caa3e09

Please sign in to comment.