Grunt support

[vytch]

Hi

Your project rocks!
I would like to use that with grunt.
I know there is already a grunt-docco available.

Are you planning to work on grunt-docco-husky any time soon?

Thanks

Vytch

[adambiggs]

+1

[asciidisco]

The main problem with all of the docco - grunt modules out there is, that docco & docco-husky don´t export functions like 'normal' npm modules do. docco (and docco-husky) must be spawned.
Normally you want somthing that you can require & use in your node program:

var doccoHusky = require('docco-husky');
doccoHusky(myConfigurationObject);

So, before someone starts to build a docco-husky gruntplugin, docco-husky should export at least one function that
takes a configuration object & outputs the generated documentation. Anything else doesn´t make sense, in my humble opinion.

Conclusion, this issue shouldn´t be about grunt support in the first place, it should be about exporting an 'in Node' usable object or function.

[asciidisco]

I´ve seen that @vytch already implemented & pull requested this, shame on me for not checking the PRs ;)

[vytch]

Hi

yes I have done something, to make docco-husky compatible with grunt. I have tested it we can still use the module via command line.

But I think it needs more work around how the parameters can be added via a grunt file.
Also, it looks like the grunt-docco-husky module has an issue with yeoman (built on grunt) when used with the reload hook.

Vytch

[mbrevoort]

Been super busy. I'd like to take the pull request and make sure it's working with grunt and Yeoman and to @asciidisco 's point, I can certainly have the module.exports expose a single function.

[vytch]

Hi

I have done a first draft of a grunt-docco-husky.
https://github.com/vytch/grunt-docco-husky

I am currently testing it on a small personal project.
Vytch

[adambiggs]

Just curious, right now I'm using grunt-exec to run the docco-husky command. What are the advantages of using an actually grunt task instead of the CLI via grunt?

[vytch]

I did not know grunt-exec so thanks for sharing.

That question could be extended to a lot of tasks.
Maybe having a task makes the feature a bit easier to configure (using json instead of a string).

Now there is something I find a bit annoying, all grunt tasks have to be installed at the project level, and not globally.

The good thing about grunt exec is that I can install a node module globally and all my projects can use it.