debug-comments-loader

A simple webpack-loader, that turns javascript-singel-line-comments into debuging tools.

It will make the following code...

var pi2 = square(Math.PI) // {{pi2}} is PI squared.

...print this in the console

9.869604401089358  is PI squared.

Installation

npm install --save-dev debug-comments-loader

Usage

It's recommended to only use it when importing the files that you are currently working with

var stuff = require('debug-comments-loader!stuff.js')

But it can as well be used with a regex in the webpack.config.js

{
  module: {
    loaders: [{
      test: /\.js$/,
      loader: "debug-comments-loader"
    }]
  }
}

Then it's just to add your one line comments like this:

var someJavascriptCode = "whatever" // This will resolve in a console.debug on the line after

// Comments on lines that has no code will resolve into a console.debug after the next row
function someFunction() {
  /* inside here */
  return "whatever"
}
// Use {{someJavascriptCode}} to log variables and such

Use a differnt logging command

Just name a different logger function in the webpack-query-string

var stuff = require('debug-comments-loader?console.log!stuff.js')

Known issues

All known issues can be solved by moving the comment and/or using block comments instead.

// Just a " works fine, but if you escape it \" it will break stuff

var bestArray = [
  bestValue, // single-line-comments in multi-line-expressions doesn't work
  bestvalue2
]

// Comments before one-line functions will not debug inside the function
() = > {}

() => {
  return true // Comments after returns will not log at all.
}