Permalink
Browse files

rough in for grunt 0.4

  • Loading branch information...
1 parent 01c6945 commit ef4ccf2c5a2c6c4299123f0f64eee732db2741bc @tkellen tkellen committed Oct 18, 2012
Showing with 156 additions and 92 deletions.
  1. +14 −0 .jshintrc
  2. +73 −0 CONTRIBUTING.md
  3. +14 −22 grunt.js → Gruntfile.js
  4. +39 −58 README.md
  5. +2 −0 docs/examples.md
  6. +2 −0 docs/options.md
  7. +2 −0 docs/overview.md
  8. +5 −2 package.json
  9. +5 −10 tasks/yuidoc.js
View
@@ -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
@@ -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
@@ -13,24 +13,14 @@ module.exports = function(grunt) {
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
- 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'
}
},
@@ -80,21 +70,23 @@ 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.
+ // These plugins provide necessary tasks.
+ grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-clean');
+ 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 yuidoc nodeunit');
+ grunt.registerTask('test', ['clean', 'yuidoc', 'nodeunit']);
// By default, lint and run all tests.
- grunt.registerTask('default', 'lint test');
+ grunt.registerTask('default', ['jshint', 'test', 'build-contrib']);
};
View
@@ -1,58 +1,39 @@
-# grunt-contrib-yuidoc [![Build Status](https://secure.travis-ci.org/gruntjs/grunt-contrib-yuidoc.png?branch=master)](http://travis-ci.org/gruntjs/grunt-contrib-yuidoc)
-
-> Compile YUIDoc Documentation.
-
-## Getting Started
-Install this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-contrib-yuidoc`
-
-Then add this line to your project's `grunt.js` gruntfile:
-
-```javascript
-grunt.loadNpmTasks('grunt-contrib-yuidoc');
-```
-
-[grunt]: https://github.com/gruntjs/grunt
-[getting_started]: https://github.com/gruntjs/grunt/blob/master/docs/getting_started.md
-
-### Overview
-
-Inside your `grunt.js` file add a section named `yuidoc`. [Visit the YUIDoc project home](http://yui.github.com/yuidoc/) for more information on YUIDocs and commenting syntax.
-
-#### Parameters
-
-##### options ```object```
-
-This controls how this task operates and should contain key:value pairs, see options below.
-
-#### Options
-
-Options correlate to [YUIDoc config objects](http://yui.github.com/yuidoc/args/index.html).
-
-##### paths (required) ```string|array```
-
-What directory should be scanned to generate doc data.
-
-##### outdir (required) ```string```
-
-Where to save the documentation.
-
-#### Config Example
-
-``` javascript
-yuidoc: {
- compile: {
- "name": "Project Name",
- "description": "Project Description",
- "version": "1.0.2",
- "url": "http://projecturl.com/",
- options: {
- paths: "path/to/source/code/",
- outdir: "where/to/save/docs/"
- }
- }
-}
-```
-
---
-
-*Task submitted by [George Pantazis](https://github.com/gcpantazis).*
+# grunt-contrib-yuidoc [![Build Status](https://secure.travis-ci.org/gruntjs/grunt-contrib-yuidoc.png?branch=master)](http://travis-ci.org/gruntjs/grunt-contrib-yuidoc)
+
+> Compile YUIDoc Documentation.
+
+_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._
+
+From the same directory as your project's [Gruntfile][Getting Started] and [package.json][], install this plugin with the following command:
+
+```bash
+npm install grunt-contrib-yuidoc --save-dev
+```
+
+Once that's done, add this line to your project's Gruntfile:
+
+```js
+grunt.loadNpmTasks('grunt-contrib-yuidoc');
+```
+
+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
+
+
+## Release History
+
+ * 2012-10-11 - v0.3.2 - Rename grunt-contrib-lib dep to grunt-lib-contrib.
+ * 2012-09-30 - v0.3.1 - Project options are parsed as templates.
+ * 2012-09-22 - 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://georgepantazis.com/">George Pantazis</a>.
+
+*Generated on Thu Oct 18 2012 17:04:34.*
View
@@ -1,3 +1,5 @@
+# Examples
+
```js
yuidoc: {
compile: {
View
@@ -1,3 +1,5 @@
+# Options
+
##### options ```object```
This controls how this task operates and should contain key:value pairs, see options below.
View
@@ -1 +1,3 @@
+# Overview
+
[Visit the YUIDoc project home](http://yui.github.com/yuidoc/) for more information on YUIDocs and commenting syntax.
View
@@ -32,8 +32,11 @@
"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-clean": "0.4.0a",
+ "grunt-contrib-internal": "*",
+ "grunt": "~0.4.0a"
},
"keywords": [
"gruntplugin"
View
@@ -6,11 +6,9 @@
* 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('yuidoc', 'Create YUIDocs', function() {
@@ -21,17 +19,15 @@ module.exports = function(grunt) {
var starttime = (new Date()).getTime();
var json;
- var options = helpers.options(this, {
+ var options = this.options({
quiet: true
});
// process project data templates
- // TODO: ditch this when grunt v0.4 is released
- var _ = grunt.util._;
var projectData = {};
- _.each(this.data, function(value, key) {
+ grunt.util._.each(this.data, function(value, key) {
if (kindOf(value) === 'string') {
- projectData[key] = grunt.template.process(value);
+ projectData[key] = value;
}
});
@@ -57,7 +53,6 @@ module.exports = function(grunt) {
if (kindOf(options.paths) === 'string') {
options.paths = [ options.paths ];
}
-
json = (new Y.YUIDoc(options)).run();
options = Y.Project.mix(json, options);

0 comments on commit ef4ccf2

Please sign in to comment.