grunt-amdcheck

grunt-amdcheck

Use AST to find and remove unused dependencies in AMD modules.

Getting Started

This plugin requires Grunt ~0.4.0

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-amdcheck --save-dev

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

grunt.loadNpmTasks('grunt-amdcheck');

The "amdcheck" task

Overview

When an AMD based project grows, number of it's js files grows too and some dependencies of the modules that had been used before, can become useless later. The AMD module loader (e.g. requirejs) loads those useless dependencies from network which can increase initial page load time. This grunt plugin can detect and remove those useless dependencies without modifying source files.

example

source.js

define('module1', ['p1', 'p2'], function (a, b) {
  return a;
});

define('module2', ['p1', 'p2', 'p3'], function (a, b, c) {
  return b;
});

optimized-source.js

define('module1', ['p1'], function (a) {
  return a;
});

define('module2', ['p2'], function (b) {
  return b;
});

Options

excepts

Type: Array
Default value: []

An array of strings or RegExps that represent dependency names that should not take into account.

exceptsPaths

Type: Array
Default value: []

An array of strings or RegExps that represent dependency paths that should not take into account.

NOTE: exceptsPaths can also be declared before each module definition as a comment of strings of module paths separated by commas. This only applies on the underlying module definition.

source.js

/* exceptsPaths: p3 */
define(['p1', 'p2', 'p3'], function (a, b, c) {
  return b;
});

optimized-source.js

/* exceptsPaths: p3 */
define(['p2', 'p3'], function (b, c) {
  return b;
});

logFilePath

Type: boolean
Default value: true

Log the file path of the current processing file if this option or one of the options logDependencyPaths, logDependencyNames, logUnusedDependencyPaths or logUnusedDependencyNames was true.

logModuleId

Type: boolean
Default value: false

Logs the id of the module if the module id is specified.

logDependencyPaths

Type: boolean
Default value: false

Logs the list of dependencies paths of the module.

logDependencyNames

Type: boolean
Default value: false

Logs the list of dependencies names of the module.

logUnusedDependencyPaths

Type: boolean
Default value: true

Logs the list of unused dependencies paths of the module.

logUnusedDependencyNames

Type: boolean
Default value: false

Logs the list of unused dependencies names of the module.

removeUnusedDependencies

Type: boolean
Default value: true

Removes detected unused dependencies and save the new files.

saveFilesWithUnusedDependenciesOnly

Type: boolean
Default value: false

When removing unused dependencies (i.e. removeUnusedDependencies: true), only write out files that have unused dependencies.

Usage Examples

grunt.initConfig({
  amdcheck: {
    dev: {
      options: {
        excepts: ['module'],
        exceptsPaths: ['require', /^jquery\./]
      },
      files: [
        {
          expand: true,
          cwd: 'js/',
          src: ['**/*.js'],
          dest: 'build/'
        }
      ]
    }
  }
});

Release History

• 2014-08-16   v1.2.0   Entirely use AST.
• 2014-07-20   v1.0.0   Uses AST to find out unused dependencies.
• 2014-04-21   v0.3.0   Added option to only write out files that have unused dependencies.
• 2014-03-19   v0.2.2   Update the dependency version.
• 2014-01-22   v0.2.1   exceptsPaths can also be defined before each module definition.
• 2014-01-13   v0.2.0   Extracted the core as a separate package (amdextract).
• 2014-01-12   v0.1.7   Bug fix on commented dependencies. Add the new exceptsPaths option. Options excepts and exceptsPaths can take RegExps.
• 2014-01-11   v0.1.6   Bug fix on commented dependencies.
• 2014-01-05   v0.1.5   Can remove unused dependencies. Add some logging options.
• 2014-01-02   v0.1.1   Works on files with multiple modules. Can detect module id if provided.
• 2014-01-01   v0.1.0   Works on files with a single module.