feat(utils): provide helper for consistent plugin meta logs formatting

Author: matejchalk

packages/utils/src/index.ts

@@ -50,6 +50,7 @@ export {
   formatBytes,
   formatDuration,
   indentLines,
+  pluginMetaLogFormatter,
   pluralize,
   pluralizeToken,
   roundDecimals,

packages/utils/src/lib/formatting.ts

@@ -1,3 +1,5 @@
+import ansis from 'ansis';
+import stringWidth from 'string-width';
 import {
   MAX_DESCRIPTION_LENGTH,
   MAX_ISSUE_MESSAGE_LENGTH,
@@ -146,7 +148,7 @@ export function truncateMultilineText(
 
 export function transformLines(
   text: string,
-  fn: (line: string) => string,
+  fn: (line: string, index: number) => string,
 ): string {
   return text.split(/\r?\n/).map(fn).join('\n');
 }
@@ -164,3 +166,15 @@ export function serializeCommandWithArgs({
 }): string {
   return [command, ...(args ?? [])].join(' ');
 }
+
+export function pluginMetaLogFormatter(
+  title: string,
+): (message: string) => string {
+  const prefix = ansis.blue(`[${title}]`);
+  const padding = ' '.repeat(stringWidth(prefix));
+  return message =>
+    transformLines(
+      message,
+      (line, idx) => `${idx === 0 ? prefix : padding} ${line}`,
+    );
+}

packages/utils/src/lib/formatting.unit.test.ts

@@ -5,6 +5,7 @@ import {
   formatDate,
   formatDuration,
   indentLines,
+  pluginMetaLogFormatter,
   pluralize,
   pluralizeToken,
   roundDecimals,
@@ -269,3 +270,28 @@ describe('serializeCommandWithArgs', () => {
     expect(serializeCommandWithArgs({ command: 'ls' })).toBe('ls');
   });
 });
+
+describe('pluginMetaLogFormatter', () => {
+  it('should prefix plugin title', () => {
+    expect(pluginMetaLogFormatter('ESLint')('Found 42 rules in total')).toBe(
+      `${ansis.blue('[ESLint]')} Found 42 rules in total`,
+    );
+  });
+
+  it('should align multiline message with prefix', () => {
+    expect(
+      ansis.strip(
+        pluginMetaLogFormatter('Coverage')(
+          'Created 3 groups:\n- Line coverage\n- Branch coverage\n- Function coverage',
+        ),
+      ),
+    ).toBe(
+      `
+[Coverage] Created 3 groups:
+           - Line coverage
+           - Branch coverage
+           - Function coverage
+`.trim(),
+    );
+  });
+});