refactor: unify log format with new logger utility (#5994)

Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>

packages/docusaurus-logger/src/__tests__/index.test.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import logger from '../index';
+
+describe('formatters', () => {
+  test('path', () => {
+    expect(logger.path('hey')).toMatchInlineSnapshot(`"hey"`);
+  });
+  test('id', () => {
+    expect(logger.name('hey')).toMatchInlineSnapshot(`"hey"`);
+  });
+  test('code', () => {
+    expect(logger.code('hey')).toMatchInlineSnapshot(`"\`hey\`"`);
+  });
+  test('subdue', () => {
+    expect(logger.subdue('hey')).toMatchInlineSnapshot(`"hey"`);
+  });
+});
+
+describe('interpolate', () => {
+  test('should format text with variables & arrays', () => {
+    const name = 'Josh';
+    const items = [1, 'hi', 'Hmmm'];
+    expect(logger.interpolate`Hello ${name}! Here are your goodies:${items}`)
+      .toMatchInlineSnapshot(`
+      "Hello Josh! Here are your goodies:
+      - 1
+      - hi
+      - Hmmm"
+    `);
+  });
+  test('should recognize valid flags', () => {
+    expect(
+      logger.interpolate`The package at path=${'packages/docusaurus'} has number=${10} files. name=${'Babel'} is exported here subdue=${'(as a preset)'} that you can with code=${"require.resolve('@docusaurus/core/lib/babel/preset')"}`,
+    ).toMatchInlineSnapshot(
+      `"The package at packages/docusaurus has 10 files. Babel is exported here (as a preset) that you can with \`require.resolve('@docusaurus/core/lib/babel/preset')\`"`,
+    );
+  });
+  test('should interpolate arrays with flags', () => {
+    expect(
+      logger.interpolate`The following commands are available:code=${[
+        'docusaurus start',
+        'docusaurus build',
+        'docusaurus deploy',
+      ]}`,
+    ).toMatchInlineSnapshot(`
+      "The following commands are available:
+      - \`docusaurus start\`
+      - \`docusaurus build\`
+      - \`docusaurus deploy\`"
+    `);
+  });
+  test('should print detached flags as-is', () => {
+    expect(
+      logger.interpolate`You can use placeholders like code= ${'and it will'} be replaced with the succeeding arguments`,
+    ).toMatchInlineSnapshot(
+      `"You can use placeholders like code= and it will be replaced with the succeeding arguments"`,
+    );
+  });
+  test('should throw with bad flags', () => {
+    expect(
+      () =>
+        logger.interpolate`I mistyped this: cde=${'this code'} and I will be damned`,
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Bad Docusaurus logging message. This is likely an internal bug, please report it."`,
+    );
+  });
+});