feat(utils): sort coverage tree alphabetically with folders before files

Author: matejchalk

packages/utils/src/index.ts

@@ -6,6 +6,7 @@ export {
   toSentenceCase,
   toTitleCase,
 } from './lib/case-conversions.js';
+export { filesCoverageToTree, type FileCoverage } from './lib/coverage-tree.js';
 export { createRunnerFiles } from './lib/create-runner-files.js';
 export { comparePairs, matchArrayItemsByKey, type Diff } from './lib/diff.js';
 export { stringifyError } from './lib/errors.js';

packages/utils/src/lib/coverage-tree.ts

@@ -36,15 +36,16 @@ export function filesCoverageToTree(
     path: formatGitPath(file.path, gitRoot),
   }));
 
-  const tree = normalizedFiles.reduce<FileTree>(
+  const filesTree = normalizedFiles.reduce<FileTree>(
     (acc, coverage) => {
       const { folders, file } = splitFilePath(coverage.path);
       return addNode(acc, folders, file, coverage);
     },
     { name: '.', children: [] },
   );
 
-  const root = calculateTreeCoverage(tree);
+  const coverageTree = calculateTreeCoverage(filesTree);
+  const root = sortCoverageTree(coverageTree);
 
   return {
     type: 'coverage',
@@ -151,3 +152,19 @@ function getNodeCoverageStats(
   cache.set(node, stats);
   return stats;
 }
+
+function sortCoverageTree(root: CoverageTreeNode): CoverageTreeNode {
+  if (!root.children?.length) {
+    return root;
+  }
+  return {
+    ...root,
+    children: root.children
+      .map(sortCoverageTree)
+      .toSorted(
+        (a, b) =>
+          Number(Boolean(b.children?.length)) -
+            Number(Boolean(a.children?.length)) || a.name.localeCompare(b.name),
+      ),
+  };
+}

packages/utils/src/lib/coverage-tree.unit.test.ts

@@ -164,4 +164,62 @@ describe('filesCoverageToTree', () => {
       expect.objectContaining({ title: 'Branch coverage' }),
     );
   });
+
+  it('should sort tree alphabetically with folders before files', () => {
+    const mockCoverage: Omit<FileCoverage, 'path'> = {
+      covered: 0,
+      total: 0,
+      missing: [],
+    };
+    const files: FileCoverage[] = [
+      {
+        ...mockCoverage,
+        path: path.join(process.cwd(), 'src', 'App.jsx'),
+      },
+      {
+        ...mockCoverage,
+        path: path.join(process.cwd(), 'src', 'components', 'TodoList.jsx'),
+      },
+      {
+        ...mockCoverage,
+        path: path.join(process.cwd(), 'src', 'hooks', 'useTodos.js'),
+      },
+      {
+        ...mockCoverage,
+        path: path.join(process.cwd(), 'src', 'components', 'TodoFilter.jsx'),
+      },
+      {
+        ...mockCoverage,
+        path: path.join(process.cwd(), 'src', 'components', 'CreateTodo.jsx'),
+      },
+    ];
+
+    expect(filesCoverageToTree(files, process.cwd())).toEqual(
+      expect.objectContaining({
+        root: expect.objectContaining({
+          name: '.',
+          children: [
+            expect.objectContaining({
+              name: 'src',
+              children: [
+                expect.objectContaining({
+                  name: 'components',
+                  children: [
+                    expect.objectContaining({ name: 'CreateTodo.jsx' }),
+                    expect.objectContaining({ name: 'TodoFilter.jsx' }),
+                    expect.objectContaining({ name: 'TodoList.jsx' }),
+                  ],
+                }),
+                expect.objectContaining({
+                  name: 'hooks',
+                  children: [expect.objectContaining({ name: 'useTodos.js' })],
+                }),
+                expect.objectContaining({ name: 'App.jsx' }),
+              ],
+            }),
+          ],
+        }),
+      }),
+    );
+  });
 });