Skip to content package
babel-plugin-sitrep v1.2.2 Log all assignments and the return value of a function with a simple comment
node any 0 deps cjs open source
overview readme
license MIT
deps 0
unpacked Unknown
files Unknown
node any $ npm install babel-plugin-sitrep@1.2.2n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
console console.log babel plugin babel-plugin-sitrep babel log logging logger log
versions Latest published Oct 11, 2017
maintainers Registry package owners.
contents babel-plugin-sitrep
Log all assignments and the return value of a function with a simple comment
Example
In
// sitrep
function bar () {
var a = 'foo'
const b = 'bar'
let c = [a, b]. map (x => x)
return c. join ( '-' )
}
// sitrep
var cb = x => x. charAt ( 0 )
// sitrep
var cb = x => {
x = x + 2
x. charAt ( 0 )
return x
↓ ↓ ↓ ↓ ↓ ↓
Out
// sitrep
function bar () {
console. groupCollapsed ( 'bar' );
var a = 'foo' ;
console. log ( 'a: ' , a);
const b = 'bar' ;
console. log ( 'b: ' , b);
let c = [a, b]. map (x => x);
console. log ( 'c: ' , c);
var _returnValue = c. join ( '-' );
console. log ( 'Return Value:' , _returnValue);
console. groupEnd
Installation
npm install --save-dev babel-plugin-sitrep copy
Usage
Via .babelrc (Recommended)
.babelrc
Without options:
{
"plugins" : [ "sitrep" ]
} copy
Via CLI
babel --plugins sitrep script.js copy
Via Node API
require ( "babel-core" ). transform ( "code" , {
plugins: [ "sitrep" ]
}); copy
Options
label
string, defaults to sitrep.
This option changes the label that enables the plugin
Example
If we set label to "log-all-the-things"
In
// log-all-the-things
function fn (a) {
a = a. map (x => x)
return a
} copy
↓ ↓ ↓ ↓ ↓ ↓
Out
// log-all-the-things
function fn (a) {
console. groupCollapsed ( "fn" );
a = a. map (x => x);
console. log ( "a: " , a);
var _returnValue = a;
console. log ( "Return Value:" , _returnValue);
console. groupEnd ( "fn" );
return _returnValue;
} copy
collapsed
boolean, defaults to true.
This option enables the following:
Collapse the group of console logs associated with a function
}
// sitrep
var a = function () {
return 'foo'
}
const obj = {
// sitrep
fn () {
let a = 5
return a + 5
}
}
class Boom {
// sitrep
fire () {
let a = 2
return a + 5
}
}
// sitrep prefix
function bar () {
var a = 'foo'
return a
}
copy
(
'bar'
);
return _returnValue;
}
// sitrep
var cb = function (x) {
console. groupCollapsed ( 'cb' );
var _returnValue3 = x. charAt ( 0 );
console. log ( 'Return Value:' , _returnValue3);
console. groupEnd ( 'cb' );
return _returnValue3;
};
// sitrep
var cb = function (x) {
console. groupCollapsed ( 'cb' );
x = x + 2 ;
console. log ( 'x: ' , x);
x. charAt ( 0 );
var _returnValue4 = x;
console. log ( 'Return Value:' , _returnValue4);
console. groupEnd ( 'cb' );
return _returnValue4;
};
// sitrep
var a = function () {
console. groupCollapsed ( 'a' );
var _returnValue5 = 'foo' ;
console. log ( 'Return Value:' , _returnValue5);
console. groupEnd ( 'a' );
return _returnValue5;
};
const obj = {
// sitrep
fn () {
console. groupCollapsed ( 'fn' );
let a = 5 ;
console. log ( 'a: ' , a);
var _returnValue6 = a + 5 ;
console. log ( 'Return Value:' , _returnValue6);
console. groupEnd ( 'fn' );
return _returnValue6;
}
};
class Boom {
// sitrep
fire () {
console. groupCollapsed ( 'fire' );
let a = 2 ;
console. log ( 'a: ' , a);
var _returnValue7 = a + 5 ;
console. log ( 'Return Value:' , _returnValue7);
console. groupEnd ( 'fire' );
return _returnValue7;
}
}
// sitrep prefix
function bar () {
console. groupCollapsed ( '(prefix) bar' );
var a = 'foo' ;
console. log ( 'a: ' , a);
var _returnValue8 = c. join ( '-' );
console. log ( 'Return Value:' , _returnValue8);
console. groupEnd ( '(prefix) bar' );
return _returnValue8;
}
copy