Cypress: Allow formatting cy.log() text

[itsravenous]

Current behavior:

cy.log() prints grey text to the left column:

Desired behavior:

cy.log() takes an option for formatting, e.g. color, bold:

cy.log('Given I am logged in', { color: 'blue' })

Steps to reproduce:

N/A

Versions

3.x

[wangduanduan]

maybe you can use this

console.log('%c Given I am logged in', 'color: blue;')

[jennifer-shehane]

The driver code for the log command is located here: https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/cy/commands/misc.coffee#L14

But the server and reporter packages would both need to be updated to understand how to interpret this and display this as a properly formatted color.

I would not expect this work to get in anytime soon, just by comparing the value added with the work required to implement, unless we do see a large amount of requests for this.

[itsravenous]

Fair enough! It's just a nice-to-have :smiley: thanks for your quick response, and thanks for the great product!

[chrisbreiding]

You can use markdown in the cy.log message and it will be formatted. It looks like we don't have this documented, so I've created an issue.

While you can't specify a color for the text, if you want blue text at least, you can trick it by making the message a link :)

cy.log('normal')
cy.log('**bold**')
cy.log('_italic_')
cy.log('[blue](http://example.com)')

[itsravenous]

That's pretty neat - thanks!

[UncleGus]

It would be great to have similar functionality in the describe code.

[vijayfelixraj]

I just wanted to apply color other than the Bule and not to link. I just wanted to apply in normal text. Please do advice.

[qeba]

Yes would be so great can change the text and background color

[kamilmoskal]

bump

[cbrunnkvist]

I sometimes work around the problem of quickly finding certain lines by adding 🍇emojis to the start of certain 🔑messages to make them stand out.