test(logger): use jest-serializer-ansi-escapes

[mrazauskas]

Pre-flight checklist

• I have read the Contributing Guidelines on pull requests.

Motivation

I noticed that ansi escape sequences are included in snapshots of @docusaurus/logger tests. Recently I wrote a snapshot serializer which is replacing the sequences with human readable strings. For example, '\u001b[3;32mSuccess!\u001b[0m' gets snapshotted as '<italic, green>Success!</>'.

Just though – perhaps you will find it useful? After using the plugin in a couple of projects, it felt to me that the improved readability helps to maintain snapshots. Of course, in the end the same output is snapshotted.

---

jest-serializer-ansi-escapes is inspired by ConvertAnsi plugin which ships with pretty-format and is bundled with Jest as well. Currently ConvertAnsi does not support blue or underline. Also its implementation is based on ansi-styles (which does not work for vanilla sequences with more than one arguments: \u001b[3;32m).

These and similar limitations was the reason why I created jest-serializer-ansi-escapes. It supports vanilla escape sequences as well as the ones produced by libraries like chalk and it replaces color, style and cursor control escape sequences.

Test Plan

Snapshots are updated. All current tests should pass.

Test links

N/A

Related issues/PRs

N/A

[mrazauskas]

By the way, snapshots become cSpell friendly as well.

[netlify]

✅ [V2]

Built without sensitive environment variables

Name	Link
🔨 Latest commit	f4271cb
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/62b877b971d1c000080e8b17
😎 Deploy Preview	https://deploy-preview-7685--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[github-actions]

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟢 92	🟢 100	🟢 100	🟢 100	🟢 90	Report
/docs/installation	🟠 85	🟢 100	🟢 100	🟢 100	🟢 90	Report

[Josh-Cena]

Thanks! I agree this looks nicer. Can we make this serializer global? We have other places using ANSI snapshots as well.

BTW, the readability is not a huge issue for me, since there's a VS Code extension:

But I do buy the spell-checker point, so I want this ported to other places as well.

[mrazauskas]

@Josh-Cena Thanks for review.

Just moved the serialiser to jest.config. I was thinking that after #5994 @docusaurus/logger is the only place which will have escape sequences in snapshots. Or?

[Josh-Cena]

Oh, I suddenly realize we already have this: #7131 Yeah I think this is fair enough. Thanks!