grunt-ag-dependencies v0.1.8

grunt-ag-dependencies

This grunt plugins shows all composer, bower and npm dependencies for your project. It creates a markdown file that contains a list of all dependencies on other projects ordered for composer, bower and npm. All local(!) projects, that are dependent on your project, will be listed too.

Getting Started

This plugin requires Grunt ~1.0.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-ag-dependencies --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-ag-dependencies');

The "ag_dependencies" task

Overview

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

grunt.initConfig({
    ag_dependencies: {
        my_options: {
            options: {
                'scanForFolders': true
            },
            files: {'src': ['./../path/to/your/projects/']}
        }
    }
});

Options

options.outputFileName

Type: String Default value: ´ag-dependencies.md`

A string value that sets the name of the output markdown file.

Usage Examples

Default Options

grunt.initConfig({
    ag_dependencies: {
        my_options: {
            options: {
                'outputFileName': 'ag_dependencies.md'
            },
            files: {'src': ['./']}
        }
    }
});

Custom Options

I will add custom options as soon as they are developed. :-)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.