grunt-madge-badoo

Check for circular dependencies in AMD or CommonJS modules using Madge.

Getting Started

This plugin requires Grunt ~0.4.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:

1npm install grunt-madge-badoo --save-dev

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

1grunt.loadNpmTasks('grunt-madge-badoo');

The "madge" task

Overview

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

1grunt.initConfig({
2  madge: {
3	options: {
4	  format: 'amd'
5	},
6	all: ['js/modules']
7  },
8})

Options

format

Type: String Default value: 'cjs'

Which format the modules being checked are using (cjs, amd).

exclude

Type: String Default value: ''

String from which a regex will be constructed for excluding files from the scan.

force

Type: Boolean Default value: false

Set force to true to report errors but not fail the task.

breakOnError

Type: Boolean Default value: true

Set breakOnError to false to not fail the task on parser errors and when modules are missing.