-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Configuration not work #8
Comments
Hi @mostofreddy and thank you for this contribution, As its explained in the Grunt documentation Grunt options I think the plugin should support the following :
Your pull request seems good and I'll integrate it and test it in version For future releases of the plugin I'm wondering if specifying the options without the
Is it compliant with Grunt recommendations / Grunt common practices ? Perhaps your proposition (use the
What do you think about that ? Thanks, Baptiste |
I agree with the options property, though as long as the configuration works I'm fine with either =) Do you have plans on integrating the ignore option? |
I am also having issues! The issue lies here: (https://github.com/gomoob/grunt-phpdocumentor/blob/master/tasks/lib/phpdocumentor.js#L80)
The runner contains the options but after this method is called the options have dropped. |
Sorry I see that you need to specify 'dist' -> 'options' yet the readme says 'dist'. |
After reflection I think this declaration should be considered invalid : phpdocumentor: {
dist: {
directory : './libs',
phar: null
}
} Supporting the 2 formats (with and without the So I propose to only update the documentation with : phpdocumentor: {
dist: {
options: {
directory : './libs',
phar: null
}
}
} We could also add a more complex sample with multiple Grunt targets and a common Task level configuration in the documentation for the 0.4.1 release. grunt.initConfig({
phpdocumentor: {
// Place here Task level options (i.e common to all your phpDocumentor targets)
options : {
command : 'run',
},
// Grunt Target used to generate a first documentation
first_api_documentation : {
options: {
directory : 'src/first_api',
target : 'docs/first_api_documentation'
}
},
// Grunt target used to generate a second documentation
second_api_documentation : {
options : {
directory : 'src/second_api',
target : 'docs/second_api_documentation'
}
},
// Sample target used to display the phpDocumentor help
display_help : {
options : {
command : 'help'
}
}
}
}) Thanks |
Add a unit test to test Task options overwriting
Documentation fixed in version 0.4.1, thanks for your involvement ! |
Yes, @mostofreddy provided a pull request #10 to support all available options for the I'm planning to test it and integrate it for the 0.5.0 release. |
Using the example in the documentation, directory, phar and target configuration not working.
The correct configuration is:
phpdocumentor: {
dist: {
options: {
directory : './libs',
phar: null
}
}
}
or modify code to detect both configurations
The text was updated successfully, but these errors were encountered: