Filter out pages tree view for app dir only output

vercel · Sep 7, 2023 · ca1e387 · ca1e387
1 parent 068002b
commit ca1e387
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 16 deletions.
diff --git a/packages/next/src/build/utils.ts b/packages/next/src/build/utils.ts
@@ -297,6 +297,31 @@ export function isInstrumentationHookFilename(file?: string) {
   )
 }
 
+const filterAndSortList = (
+  list: ReadonlyArray<string>,
+  routeType: ROUTER_TYPE,
+  hasCustomApp: boolean
+) => {
+  let pages: string[]
+  if (routeType === 'app') {
+    // filter out static app route of /favicon.ico
+    pages = list.filter((e) => e !== '/favicon.ico')
+  } else {
+    // filter built-in pages
+    pages = list
+      .slice()
+      .filter(
+        (e) =>
+          !(
+            e === '/_document' ||
+            e === '/_error' ||
+            (!hasCustomApp && e === '/_app')
+          )
+      )
+  }
+  return pages.sort((a, b) => a.localeCompare(b))
+}
+
 export interface PageInfo {
   isHybridAmp?: boolean
   size: number
@@ -369,21 +394,9 @@ export async function printTreeView(
       .replace(/(?:^|[.-])([0-9a-z]{6})[0-9a-z]{14}(?=\.)/, '.$1')
 
   // Check if we have a custom app.
-  const hasCustomApp =
+  const hasCustomApp = !!(
     pagesDir && (await findPageFile(pagesDir, '/_app', pageExtensions, false))
-
-  const filterAndSortList = (list: ReadonlyArray<string>) =>
-    list
-      .slice()
-      .filter(
-        (e) =>
-          !(
-            e === '/_document' ||
-            e === '/_error' ||
-            (!hasCustomApp && e === '/_app')
-          )
-      )
-      .sort((a, b) => a.localeCompare(b))
+  )
 
   // Collect all the symbols we use so we can print the icons out.
   const usedSymbols = new Set()
@@ -404,6 +417,11 @@ export async function printTreeView(
     list: ReadonlyArray<string>
     routerType: ROUTER_TYPE
   }) => {
+    const filteredPages = filterAndSortList(list, routerType, hasCustomApp)
+    if (filteredPages.length === 0) {
+      return
+    }
+
     messages.push(
       [
         routerType === 'app' ? 'Route (app)' : 'Route (pages)',
@@ -412,7 +430,7 @@ export async function printTreeView(
       ].map((entry) => chalk.underline(entry)) as [string, string, string]
     )
 
-    filterAndSortList(list).forEach((item, i, arr) => {
+    filteredPages.forEach((item, i, arr) => {
       const border =
         i === 0
           ? arr.length === 1

diff --git a/test/e2e/app-dir/not-found/basic/index.test.ts b/test/e2e/app-dir/not-found/basic/index.test.ts
@@ -23,7 +23,7 @@ createNextDescribe(
 
       it('should not output /404 in tree view logs', async () => {
         const output = await next.cliOutput
-        expect(output).not.toContain('/404')
+        expect(output).not.toContain('○ /404')
       })
 
       it('should use root not-found content for 404 html', async () => {

diff --git a/test/production/app-dir/build-output/index.test.ts b/test/production/app-dir/build-output/index.test.ts
@@ -0,0 +1,23 @@
+import { createNextDescribe } from 'e2e-utils'
+
+createNextDescribe(
+  'production - app dir - build output',
+  {
+    files: {
+      'app/page.js': `export default function Page() { return null }`,
+      'app/layout.js': `export default function Layout({ children }) {
+        return (
+          <html><body>{children}</body></html>
+        )
+      }`,
+    },
+  },
+  ({ next }) => {
+    it('should only log app routes', async () => {
+      const output = next.cliOutput
+      expect(output).toContain('Route (app)')
+      expect(output).not.toContain('Route (pages)')
+      expect(output).not.toContain('/favicon.ico')
+    })
+  }
+)