# grunt-ag-dependencies

> This grunt plugins shows all composer, bower and npm dependencies for your project.

Latest version **0.1.8** (published 2016-10-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install grunt-ag-dependencies
pnpm add grunt-ag-dependencies
yarn add grunt-ag-dependencies
bun add grunt-ag-dependencies
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2016-10-30 |
| First published | 2016-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Adrian Grund |
| Maintainers | ade72 |
| Keywords | gruntplugin, composer, bower, npm, dependencies |

## Links

- npm: https://www.npmjs.com/package/grunt-ag-dependencies
- Repository: https://gitlab.agidl.de/aggrunt/grunt-ag-dependencies
- Issues: https://gitlab.agidl.de/aggrunt/grunt-ag-dependencies/issues
- npm.io page: https://npm.io/package/grunt-ag-dependencies

## Recent versions

- 0.1.8 (latest) — 2016-10-30
- 0.1.7 — 2016-10-28
- 0.1.6 — 2016-10-27
- 0.1.5 — 2016-10-27
- 0.1.4 — 2016-10-26
- 0.1.3 — 2016-10-26
- 0.1.2 — 2016-10-26
- 0.1.1 — 2016-10-25
- 0.0.19 — 2016-10-25
- 0.0.18 — 2016-10-24
- 0.0.17 — 2016-10-23
- 0.0.16 — 2016-10-23
- 0.0.15 — 2016-10-23
- 0.0.14 — 2016-10-23
- 0.0.13 — 2016-10-23
- … 12 more at https://npm.io/package/grunt-ag-dependencies/versions

## README

# 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](http://gruntjs.com/) before, be sure to
check out the [Getting Started](http://gruntjs.com/getting-started)
guide, as it explains how to create a
[Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and
use Grunt plugins. Once you're familiar with that process, you may
install this plugin with this command:

```shell
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:

```js
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()`.

```js
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

```js
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](http://gruntjs.com/).

---
_Source: https://npm.io/package/grunt-ag-dependencies · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._