package
Super convenient syntax for execution tracing, logging and debugging JavaScript applications via a babel plugin.
npm install babel-plugin-traceGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
46.3 kB
Includes dependencies.
Latest published Feb 8, 2018
This is a Babel plugin which adds a straightforward, declarative syntax for adding debug logging to JavaScript applications.
It's common to insert console.log() statements to help keep track of the internal state of functions when writing tricky pieces of code. During development this is very useful, but it creates a lot of noise in the console, and when development of that particular piece of code is complete, the developer is likely to delete the console.log() calls. If we're lucky, they might leave comments in their place.
This is a tragedy - that logging information is extremely useful, not only is it helpful when fixing bugs, it's a great assistance for new developers (including yourself, 6 months from now) when getting to know a codebase.
This plugin repurposes JavaScript LabeledStatements like log: and trace: to provide a logging / tracing syntax which can be selectively enabled or disabled at the folder, file, or function level at build time. Normally, these labels are only used as targets for labeled break and continue statements.
When disabled in production the logging statements are completely dropped out, incurring no overhead. The syntax looks like this:
// login.js
async function authenticate (username, password) {
trace: 'authenticating user', username;
const user = await db.select().from('users').where({username: username});
if (!user) {
trace: 'no such user';
return false;
}
else if (!user.checkPassword(password)) {
trace: 'invalid password';
return false;
}
else if (!user.isActive) {
trace
This will produce output like:
login:authenticate: authenticating user Bob
login:authenticate: no such user
login:authenticate: authenticating user Alice
login:authenticate: invalid password
login:authenticate: authenticating user Alice
login:authenticate: logging user Alice into the siteAs well as trace:, you can also use log: and warn:, or specify your own using the aliases plugin option.
Install via npm.
npm install --save-dev babel-plugin-traceThen, in your babel configuration (usually in your .babelrc file), add "trace" to your list of plugins:
{
"plugins": [
["trace", {
"env": {
"production": { "strip": true }
}
}]
]
}The above example configuration will remove all tracing when NODE_ENV=production.
Alternatively, you may wish to disable all tracing by default, enabling it only for certain files or functions using environment variables:
{
"plugins": [
["trace", { "strip": true }]
]
}TRACE_LEVEL - Enable only specific logging levelsLog only warn statements.
TRACE_LEVEL=warn babel -d ./lib ./srcLog trace and warn statements.
TRACE_LEVEL=trace,warn babel -d ./lib ./srcTRACE_FILE - Enable by filenameEnable logging for any file with login.js in the path.
TRACE_FILE=login.js babel -d ./lib ./srcEnable logging for any file with db/models or components/login in the path.
TRACE_FILE=db/models,components/login babel -d ./lib ./srcTRACE_CONTEXT - Enable for specific functionsEnable logging for any function called login() or logout().
TRACE_CONTEXT=:login,:logout babel -d ./lib ./srcEnable logging for any function in a class called User.
TRACE_CONTEXT=:User: babel -d ./lib ./srcPublished by codemix under a permissive MIT License, see LICENSE.md.