gulp-amdcheck

v1.3.2

Published

2 years ago

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

Downloads

142

0High
0Medium
0Low

mehdishojaei

gulpplugin optimize AMD dependency unused useless requirejs

gulp-amdcheck

Uses AST to find and remove 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'))
});

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

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

gulp.task('amdcheck', function() {
  var options = {
    exceptsPaths: ['bootstrap', /^jquery/i]
  };

  gulp.src('**/*.js')
    .pipe(amdcheck(options))
    .pipe(gulp.dest('dist'));
});

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;
});