scriptie-talkie
v0.4.7
Published
Makes your code tell you what the intermediate results are when executing a script.
Downloads
44
Readme
scriptie-talkie
Makes your code tell you what the intermediate results are when executing a script.
var a = 3;
a = a + 1;
a++;
var b = 2;
b = b + a;
Installation
npm install scriptie-talkie
(Add -g
to install as global command line tool)
Command Line Tool
scriptie-talkie path/to/script.js
Prints the highlighted code of script.js
with intermediate results.
API
scriptie-talkie(script, scriptPath, opts)
/**
* Evaluates all snippets in the given script and calls opts.write with the result.
*
* @name exports
* @function
* @param script {String} The String to evaluate.
* @param scriptPath {String} The path to the script (important to resolve require statements)
* @param opts {Object} {
* toLines: function(code:String) -> [String] - to split script into lines -- uses cardinal syntax highlighter by default
* write : function(result:String) - to be called to write the result -- default console.log
*/
var talk = require('scriptie-talkie')
, fs = require('fs');
, script = fs.readFileSync(scriptPath, 'utf-8');
talk(script, scriptPath, { write: console.error });
Roadmap
- version that works in the browser
- integrate with replpad
More Examples
var o = { a: 1 };
o.a = 2;
var a = 3;
a + b;
var b = 2;
console.log(b.hello());
var a = 1;
foo();
function foo () {
return a++;
}
foo() + 1;