extend-console

Config

If none is provided under a config/config.json at the root of execution, the default one is used

In all following options, the last is the fallback case

In config/config.json:

3 possible values for logFilenamesFormat and errorFilenamesFormat:

• filename
• relative (relative to the global.projectRoot, absolute if none)
• absolute

4 possible values for logLevel:

• 0 (None)
• 1 (Errors)
• 2 (Errors + Warnings)
• 3 (Errors + Warnings + Infos)

In process.env:

2 possible values for format_errors:

• false (logs err.stack instead)
• true (tries to parse filename, functionName, lineNumber and rowNumber where the error happened)

If the last argument to console.reportError is an Error instance and format_errors is not provided in process.env or is set to true, it will try to parse it (behavior of defaultFormatArgsForError)

If you absolutely want to report errors where the err is not at the end or you want to report multiple at once, you should provide a formatArgs to console.createReportError, for that you might want to check out the formatErr and parseErr functions provided

Example usage

See test.js and its associated output

A more advanced usage can be found here where it provides custom logFormat, formatArgs and shouldLog functions to console.createReport, console.createReportWarn and console.createReportError

It is also possible to expand on the create functions to provide some project specific default behavior to all reports, as seen here where the extension is removed from the filePath if it contains 'internals' or if it is the path of the current file (index.js in this case)

Advice

Require this module once after all others with your global.projectRoot set beforehand to make sure it always correctly loads the filenames format functions relative to your global.projectRoot

You are in trouble if you require packages around in your project that might use this package, defining their own global.projectRoot, although it's unlikely for a module meant to be used as a node_module to define a global.projectRoot

That said, you can always use filename or absolute and make sure none of this happens