Package Exports

gulp-amdcheck

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-amdcheck) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-amdcheck

Finds and removes unused dependencies in AMD modules.

Getting Started

npm install gulp-amdcheck --save-dev

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 gulp plugin can detect and remove those useless dependencies without modifying source files.

Usage

var amdcheck = require('gulp-amdcheck');

gulp.task('amdcheck', function() {
  gulp.src('**/*.js')
    .pipe(amdcheck())
    .pipe(gulp.dest('dist'))
});

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.

/* exceptsPaths: view/c */
define(["view/a", "view/b", "view/c"], function (a, b, c) {
  b.fetch();
});

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.

Release History

2014-03-27 v0.0.0 First commit.