The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import { green } from "chalk";
import { NEXTJS_DEMO_ROUTE_NAME } from "../constants/config";
import {
LINK_TO_NEXT_JS_GUIDE,
LINK_TO_NEXT_JS_SAMPLE,
} from "../constants/messages";
import { getNextJsPagesWrapperOrAppWrapperSnippet } from "../snippets/nextjs-snippets";
import { checkIsInTypeScriptProject } from "./check-typescript-project";
import {
checkIfUsingAppOrPagesRouter,
getImportPathForRootLayout,
getNextJsSourceDirectoryPrefix,
} from "./nextjs-helpers";
export const getNextJsSetupMessages = async ({
componentPath,
hasNextJsCustomAppOrRootLayout,
hasExpressJsServer,
}: {
componentPath: string;
hasNextJsCustomAppOrRootLayout: boolean;
hasExpressJsServer: boolean;
}): Promise<string[]> => {
const router = await checkIfUsingAppOrPagesRouter();
const isInTypeScriptProject = await checkIsInTypeScriptProject();
const sourcePrefix = getNextJsSourceDirectoryPrefix();
const componentExtension = isInTypeScriptProject ? "tsx" : "js";
const snippets = [];
const layoutFile = `${sourcePrefix}${router === "app" ? "app/layout" : "pages/_app"}.${componentExtension}`;
let componentSnippet = `Added an ${green("/" + NEXTJS_DEMO_ROUTE_NAME)} route to your "${green(router)}" directory.\n`;
if (hasNextJsCustomAppOrRootLayout) {
const layoutSnippet = getNextJsPagesWrapperOrAppWrapperSnippet({
router,
resolveImport: (pathName) =>
getImportPathForRootLayout(componentPath, pathName),
});
// If the user already has an _app.tsx or layout.tsx, we need to show them the snippet,
// so they can add the example providers and the example CSS to their file.
componentSnippet += ` Next, add the example providers and CSS stylesheet to your ${green(layoutFile)} file. For example:
${green(layoutSnippet)}`;
} else {
// Otherwise, we tell them that we've generated the needed files.
componentSnippet += ` An example Next.js ${layoutFile} is also added with the example providers and CSS stylesheet.`;
}
snippets.push(componentSnippet);
let afterSetupMessage = "";
if (hasExpressJsServer) {
afterSetupMessage += ` Instead of running a separate Express.js server, you can create API routes for them.
See the examples from ${green(LINK_TO_NEXT_JS_SAMPLE)}.\n\n`;
}
afterSetupMessage += ` For guides on using Next.js with Embedding SDK, see
${green(LINK_TO_NEXT_JS_GUIDE)}`;
snippets.push(afterSetupMessage);
return snippets.map((snippet) => snippet.trim());
};