next
Version:
The React Framework
108 lines (105 loc) • 3.79 kB
JavaScript
import path from 'path';
import * as Log from '../build/output/log';
import { promises as fs } from 'fs';
import { bold } from './picocolors';
import { APP_DIR_ALIAS } from './constants';
const globOrig = require('next/dist/compiled/glob');
const glob = (cwd, pattern)=>{
return new Promise((resolve, reject)=>{
globOrig(pattern, {
cwd
}, (err, files)=>{
if (err) {
return reject(err);
}
resolve(files);
});
});
};
function getRootLayout(isTs) {
if (isTs) {
return `export const metadata = {
title: 'Next.js',
description: 'Generated by Next.js',
}
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
`;
}
return `export const metadata = {
title: 'Next.js',
description: 'Generated by Next.js',
}
export default function RootLayout({ children }) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
`;
}
export async function verifyRootLayout({ dir, appDir, tsconfigPath, pagePath, pageExtensions }) {
let rootLayoutPath;
try {
const layoutFiles = await glob(appDir, `**/layout.{${pageExtensions.join(',')}}`);
const isFileUnderAppDir = pagePath.startsWith(`${APP_DIR_ALIAS}/`);
const normalizedPagePath = pagePath.replace(`${APP_DIR_ALIAS}/`, '');
const pagePathSegments = normalizedPagePath.split('/');
// Find an available dir to place the layout file in, the layout file can't affect any other layout.
// Place the layout as close to app/ as possible.
let availableDir;
if (isFileUnderAppDir) {
if (layoutFiles.length === 0) {
// If there's no other layout file we can place the layout file in the app dir.
// However, if the page is within a route group directly under app (e.g. app/(routegroup)/page.js)
// prefer creating the root layout in that route group.
const firstSegmentValue = pagePathSegments[0];
availableDir = firstSegmentValue.startsWith('(') ? firstSegmentValue : '';
} else {
pagePathSegments.pop() // remove the page from segments
;
let currentSegments = [];
for (const segment of pagePathSegments){
currentSegments.push(segment);
// Find the dir closest to app/ where a layout can be created without affecting other layouts.
if (!layoutFiles.some((file)=>file.startsWith(currentSegments.join('/')))) {
availableDir = currentSegments.join('/');
break;
}
}
}
} else {
availableDir = '';
}
if (typeof availableDir === 'string') {
const resolvedTsConfigPath = path.join(dir, tsconfigPath);
const hasTsConfig = await fs.access(resolvedTsConfigPath).then(()=>true, ()=>false);
rootLayoutPath = path.join(appDir, availableDir, `layout.${hasTsConfig ? 'tsx' : 'js'}`);
await fs.writeFile(rootLayoutPath, getRootLayout(hasTsConfig));
Log.warn(`Your page ${bold(`app/${normalizedPagePath}`)} did not have a root layout. We created ${bold(`app${rootLayoutPath.replace(appDir, '')}`)} for you.`);
// Created root layout
return [
true,
rootLayoutPath
];
}
} catch (e) {
console.error(e);
}
// Didn't create root layout
return [
false,
rootLayoutPath
];
}
//# sourceMappingURL=verify-root-layout.js.map