fighterr v0.0.8

FightErr

JavaScript library to ease type checking and variables value validation for both browser and Node.

Installation and usage

FightErr is available with bower:

bower install fighterr

or via npm:

npm install fighterr

Disabling FightErr in production builds

Sometimes the idea of type checking on production is considered useless, while it is very handy during development. Here are a few tips on how to strip some (or even all) of the FightErr calls from the JavaScript files intended for production use.

The trick is to use UglifyJS for minifying JavaScript files with properly set Global definitions compressor options.

First of all, wrap all the FightErr calls you wish to strip later with DEBUG checks:

var myFunction = function (strArg, numArg) {
  if (DEBUG) {
    F.str('strArg', strArg, 'myFunction');
    F.num('numArg', numArg, 'myFunction');
  }
  
  // rest of the code...
}

Then if you pass:

global_defs: {
  DEBUG: false
}

the compressor will assume that's a constant defintion and will discard code like this as being unreachable.

Adapt the following configuration pieced to your building tools:

Grunt:

It is assumed that grunt-contrib-uglify plugin is installed properly.

// Project configuration.
grunt.initConfig({
  uglify: {
    options: {
      compress: {
        global_defs: {
          "DEBUG": false
        },
        dead_code: true
      }
    },
    my_target: {
      files: {
        'dest/output.min.js': ['src/input.js']
      }
    }
  }
});

Brunch:

It is assumed that uglify-js-brunch plugin is installed properly.

config =
  plugins:
    uglify:
      mangle: false
      compress:
        global_defs: 
          DEBUG: false

Documentation

Annotated source: http://nextusersf.github.io/fighterr/

License

MIT