Encourages programming with assertions by providing tools to compile them away.
JavaScript
Clone or download

README.md

unassert

Encourages programming with assertions by providing tools to compile them away.

Build Status NPM version Dependency Status License

See: "unassert - encourage reliable programming by writing assertions in production" -- talk at NodeFest 2015, and "One more thing..." in talk at NodeFest 2016, titled "From Library to Tool - power-assert as a General Purpose Assertion Enhancement Tool"

RELATED MODULES

INSTALL

$ npm install --save-dev unassert

API

var modifiedAst = unassert(ast)

return type
object (ECMAScript AST)

Remove assertion calls matched to patterns from ast (ECMAScript AST). ast is manipulated directly so returned modifiedAst will be the same instance of ast.

Assertion expressions are removed when they match default patterns. In other words, unassert removes assertion calls that are compatible with Node.js standard assert API (and console.assert).

var visitor = unassert.createVisitor(options)

return type
object (visitor object for estraverse)

Create visitor object to be used with estraverse.replace. Visitor can be customized by options.

options

Object for configuration options. passed options is Object.assigned with default options. If not passed, default options will be used.

options.assertionPatterns

Target patterns for assertion removal.

If callee name (for example, assert.equal) matches exactly and number of arguments is satisfied, then the assertion will be removed. Patterns are handled with call-matcher. Any arguments enclosed in bracket (for example, [message]) means optional parameters. Without bracket means mandatory parameters.

options.requirePatterns

Target patterns for require call removal. Must be in form of assignments.

For example,

{
    requirePatterns: [
        'assert = require("assert")'
    ],

will remove var assert = require("assert"), let assert = require("assert"), const assert = require("assert") and var assert; assert = require("assert") as well.

options.importPatterns

Target patterns for import declaration removal.

For example,

{
    importPatterns: [
        'import assert from "assert"',
        'import * as assert from "assert"',
        'import assert from "power-assert"',
        'import * as assert from "power-assert"'
    ]

var options = unassert.defaultOptions()

Returns default options object for createVisitor function. In other words, returns

{
    assertionPatterns: [
        'assert(value, [message])',
        'assert.ok(value, [message])',
        'assert.equal(actual, expected, [message])',
        'assert.notEqual(actual, expected, [message])',
        'assert.strictEqual(actual, expected, [message])',
        'assert.notStrictEqual(actual, expected, [message])',
        'assert.deepEqual(actual, expected, [message])',
        'assert.notDeepEqual(actual, expected, [message])',
        'assert.deepStrictEqual(actual, expected, [message])',
        'assert.notDeepStrictEqual(actual, expected, [message])',
        'assert.fail(actual, expected, message, operator)',
        'assert.throws(block, [error], [message])',
        'assert.doesNotThrow(block, [message])',
        'assert.ifError(value)',
        'console.assert(value, [message])'
    ],
    requirePatterns: [
        'assert = require("assert")',
        'assert = require("power-assert")'
    ],
    importPatterns: [
        'import assert from "assert"',
        'import * as assert from "assert"',
        'import assert from "power-assert"',
        'import * as assert from "power-assert"'
    ]
}

EXAMPLE

For given math.js below,

'use strict';

var assert = require('assert');

function add (a, b) {
    console.assert(typeof a === 'number');
    assert(!isNaN(a));
    assert.equal(typeof b, 'number');
    assert.ok(!isNaN(b));
    return a + b;
}

Apply unassert then generate modified code to console.

var acorn = require('acorn');
var escodegen = require('escodegen');
var unassert = require('unassert');
var fs = require('fs');
var path = require('path');
var filepath = path.join(__dirname, 'math.js');

var ast = acorn.parse(fs.readFileSync(filepath));
var modifiedAst = unassert(ast);

console.log(escodegen.generate(modifiedAst));

Then you will see assert calls disappear.

'use strict';
function add(a, b) {
    return a + b;
}

Note: unassert supports removal of power-assert declarations (var assert = require('power-assert');) too.

SUPPORTED PATTERNS

Assertion expressions are removed when they match patterns below. In other words, unassert removes assertion calls that are compatible with Node.js standard assert API (and console.assert).

  • assert(value, [message])
  • assert.ok(value, [message])
  • assert.equal(actual, expected, [message])
  • assert.notEqual(actual, expected, [message])
  • assert.strictEqual(actual, expected, [message])
  • assert.notStrictEqual(actual, expected, [message])
  • assert.deepEqual(actual, expected, [message])
  • assert.notDeepEqual(actual, expected, [message])
  • assert.deepStrictEqual(actual, expected, [message])
  • assert.notDeepStrictEqual(actual, expected, [message])
  • assert.fail(actual, expected, message, operator)
  • assert.throws(block, [error], [message])
  • assert.doesNotThrow(block, [message])
  • assert.ifError(value)
  • console.assert(value, [message])

unassert also removes assert variable declarations,

  • var assert = require("assert")
  • var assert = require("power-assert")
  • import assert from "assert"
  • import assert from "power-assert"
  • import * as assert from "assert"
  • import * as assert from "power-assert"

and assignments.

  • assert = require("assert")
  • assert = require("power-assert")

OUR SUPPORT POLICY

We support Node under maintenance. In other words, we stop supporting old Node version when their maintenance ends.

This means that any other environment is not supported.

NOTE: If unassert works in any of the unsupported environments, it is purely coincidental and has no bearing on future compatibility. Use at your own risk.

AUTHOR

LICENSE

Licensed under the MIT license.