👷 Pr comment markdown table alignment (#3876)

Author: thomas-lebeau

scripts/lib/executionUtils.ts

@@ -46,7 +46,7 @@ export function formatSize(bytes: number | null, { includeSign = false } = {}):
 
   const sign = includeSign && bytes > 0 ? '+' : ''
 
-  if (bytes < 1024) {
+  if (bytes > -1024 && bytes < 1024) {
     return `${sign}${Math.round(bytes)} B`
   }
 

scripts/performance/lib/bundleSizes.ts

@@ -50,7 +50,14 @@ export function formatBundleSizes({
 }) {
   let highIncreaseDetected = false
   let message = markdownArray({
-    headers: ['📦 Bundle Name', 'Base Size', 'Local Size', '𝚫', '𝚫%', 'Status'],
+    headers: [
+      { label: '📦 Bundle Name', align: 'left' },
+      { label: 'Base Size', align: 'right' },
+      { label: 'Local Size', align: 'right' },
+      { label: '𝚫', align: 'right' },
+      { label: '𝚫%', align: 'right' },
+      { label: 'Status', align: 'center' },
+    ],
     rows: localBundleSizes.map((localBundleSize) => {
       const baseBundleSize = baseBundleSizes.find((baseBundleSize) => baseBundleSize.name === localBundleSize.name)
 

scripts/performance/lib/cpuPerformance.ts

@@ -121,7 +121,12 @@ function formatCpuPerformance({
   localCpuPerformances: PerformanceMetric[]
 }) {
   return markdownArray({
-    headers: ['Action Name', 'Base CPU Time (ms)', 'Local CPU Time (ms)', '𝚫 (%)'],
+    headers: [
+      { label: 'Action Name', align: 'left' },
+      { label: 'Base CPU Time (ms)', align: 'right' },
+      { label: 'Local CPU Time (ms)', align: 'right' },
+      { label: '𝚫%', align: 'right' },
+    ],
     rows: localCpuPerformances.map((localCpuPerformance) => {
       const baseCpuPerformance = baseCpuPerformances.find(
         (baseCpuPerformance) => baseCpuPerformance.name === localCpuPerformance.name

scripts/performance/lib/memoryPerformance.ts

@@ -169,7 +169,12 @@ function formatMemoryPerformance({
   localMemoryPerformances: PerformanceMetric[]
 }) {
   return markdownArray({
-    headers: ['Action Name', 'Base Memory Consumption', 'Local Memory Consumption', '𝚫'],
+    headers: [
+      { label: 'Action Name', align: 'left' },
+      { label: 'Base Memory Consumption', align: 'right' },
+      { label: 'Local Memory Consumption', align: 'right' },
+      { label: '𝚫', align: 'right' },
+    ],
     rows: localMemoryPerformances.map((localMemoryPerformance) => {
       const baseMemoryPerformance = baseMemoryPerformances.find(
         (baseMemoryPerformance) => baseMemoryPerformance.name === localMemoryPerformance.name

scripts/performance/lib/reportAsAPrComment.ts

@@ -76,14 +76,26 @@ async function updatePrComment(prNumber: number, message: string): Promise<void>
 }
 
 interface MarkdownArrayOptions {
-  headers: string[]
+  headers: Array<{ label: string; align: 'left' | 'right' | 'center' }>
   rows: string[][]
 }
 
 export function markdownArray({ headers, rows }: MarkdownArrayOptions): string {
-  let markdown = `| ${headers.join(' | ')} |\n| ${new Array(headers.length).fill('---').join(' | ')} |\n`
+  let markdown = `| ${headers.map((header) => header.label).join(' | ')} |\n`
+  markdown += `| ${headers.map((header) => align(header.align)).join(' | ')} |\n`
+
   rows.forEach((row) => {
     markdown += `| ${row.join(' | ')} |\n`
   })
   return markdown
 }
+
+function align(align: 'left' | 'right' | 'center') {
+  if (align === 'center') {
+    return ':---:'
+  } else if (align === 'right') {
+    return '---:'
+  }
+
+  return '---'
+}