How to tell node.js app environment supports styled/colored Console output?

Question

I want to style Console output (console.log('%cTest', 'color: lime')) for debug purposes so I need to tell if script is running inside VSCode or not. Is it possible?

Clarification: I want "isomorphic" code which can detect if it's running inside VSCode and run colored console.log output or not in VSCode and run regular console.log.

You can run node yourfilename.js inside the terminal which comes with vscode if that's what you are asking. Your question is unclear. — Muhammad Kamran
– Muhammad Kamran, Commented Jul 7, 2019 at 16:30
@muhammad-kamran I want "isomorphic" code which can detect if it's running inside VSCode and run colored console.log output or not in VSCode and run regular console.log. — TotalAMD
– TotalAMD, Commented Jul 7, 2019 at 23:19

shaochuancs · Accepted Answer · 2019-07-08 08:41:43Z

2

Actually, what you need is detecting whether the console support color (and how well it supports color), not sniff whether the Node.js program is launched from VSCode.

To implement this requirement, npm module supports-color can be used:

// Code example taken from supports-color document

const supportsColor = require('supports-color');

if (supportsColor.stdout) {
    console.log('Terminal stdout supports color');
}

if (supportsColor.stdout.has256) {
    console.log('Terminal stdout supports 256 colors');
}

if (supportsColor.stderr.has16m) {
    console.log('Terminal stderr supports 16 million colors (truecolor)');
}

answered Jul 8, 2019 at 8:41

shaochuancs

16.4k3 gold badges63 silver badges68 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

TotalAMD Over a year ago

Actually, the code inside this module just check the platform and environment to figure out the support, not actually checking it.

shaochuancs Over a year ago

Well, the supports-color module will check process.env (environment variables for current process), such as FORCE_COLOR or COLORTERM etc. I think it is the right thing to do (check current process details). The module does not sniff specific platform.

TotalAMD Over a year ago

TBH, it does check if win platform: github.com/chalk/supports-color/blob/…

Collectives™ on Stack Overflow

How to tell node.js app environment supports styled/colored Console output?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related