Readme.markdown

TypedJS

Basic, automatic JavaScript testing. This is just a start. TypedJS will soon provide more complex forms of program specification, and analysis. The goal: safe, correct JavaScript.

(Warning: In need of some refactoring).

Usage

First, annotate your javascript functions with Haskell-like type signatures:

//+ str_first :: String -> String -> String

function str_first(c1,c2){
  return c1;
}

//+ my_prop :: {name:String, valid:Boolean} -> Boolean

function my_prop(obj){
  if(obj.valid === true){
    return "true"; // Error, we are 
  }                // returning a string here
  else{
    return obj.valid;
  }
};

// We can do objects, too:

MyObj = {
  //+ MyObj.test_fun :: Number -> Number -> Number
  test_fun:function(num1, num2){
    return num1 + num2;
  }
}

Run in the Browser

Load your JavaScript file in a browser window and run:

TypedJS.run_tests()

If you want to instrument your annotated functions to dynamically detect type violations, run:

TypedJS.run_tests(true)

Node.js support

Add tests manually:

    var TypedJS = require('../typed');
    typedjs_parser = require('../typedjs_parser');


    // Example function to test...
    function concat(a, b) {
         return a + b;
    }

    // You can manually add tests to TypedJS
    // The first parameter is the type signature
    // The second parameter is the actual function we'll be testing
    var test = TypedJS.addTest('concat :: String -> String -> String', concat);

    // Call 'go' to execute the automated tests
    // go requires one parameter and it's an Array of the tests to run.
    TypedJS.go([test]);

Or load a file:

    var TypedJS = require('../typed');
    typedjs_parser = require('../typedjs_parser');

    // A vm is necessary so you can bind all the global functions to 'window'
    var fs = require('fs');
    var vm = require('vm');

    // Extract the data from the file
    var fileData = fs.readFileSync('examples/test.js', 'utf-8');

    // Pull in all the global functions into window
    window = {};
    vm.runInNewContext(fileData, window);


    // Run TypedJS on the fileData String.
    // TypedJS will parse all your type signatures
    // read the functions from 'window' and execute
    // the automated tests.
    TypedJS.run_tests_on_string(fileData);

Types

Currently available primitives:

Number
String
Boolean

And ORs of primitives:

Number | String   // Number or String
Boolean | Number  // Boolean or Number
...

And tuples (T1, T2, ... TN). For instance:

(Number, String, Boolean, Boolean)  // An example instance => [4,"hello",true,true]
(Boolean, Boolean)                  // An example instance => [true, false]

And arrays:

[Number]            // Array of Numbers. Example instances => [3,4,5] or [45,62,34,78,23]
[Number | String]   // Array of Numbers or Strings. Example instance => [3,"s",5,6,"h"]

And objects, which can be nested and mixed with other types. For instance:

{key1: String, key2:[Number], key3:{subkey1:String, subkey2: Number}}

MIT License

Copyright (C) 2012 Ethan Fast & Taazr Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.