From 44fd8cb3fa38940d49ed0b5b56bc7ab4e949a454 Mon Sep 17 00:00:00 2001
From: Marcus Schiesser <mail@marcusschiesser.de>
Date: Mon, 11 Mar 2024 14:16:15 +0700
Subject: [PATCH] refactor: clean nextjs config generation (use JSON) (#631)
---
create-app.ts | 2 +-
helpers/types.ts | 1 -
helpers/typescript.ts | 33 +++++++++----------
.../types/streaming/nextjs/next.config.app.js | 19 -----------
.../types/streaming/nextjs/next.config.json | 15 +++++++++
.../types/streaming/nextjs/next.config.mjs | 13 ++++++++
.../streaming/nextjs/next.config.static.js | 21 ------------
7 files changed, 44 insertions(+), 60 deletions(-)
delete mode 100644 templates/types/streaming/nextjs/next.config.app.js
create mode 100644 templates/types/streaming/nextjs/next.config.json
create mode 100644 templates/types/streaming/nextjs/next.config.mjs
delete mode 100644 templates/types/streaming/nextjs/next.config.static.js
diff --git a/create-app.ts b/create-app.ts
index 2f7db13a..f59a9e9a 100644
--- a/create-app.ts
+++ b/create-app.ts
@@ -113,7 +113,7 @@ export async function createApp({
path.join(root, "README.md"),
);
} else {
- await installTemplate({ ...args, backend: true, forBackend: framework });
+ await installTemplate({ ...args, backend: true });
}
process.chdir(root);
diff --git a/helpers/types.ts b/helpers/types.ts
index 74227737..76be9af3 100644
--- a/helpers/types.ts
+++ b/helpers/types.ts
@@ -41,7 +41,6 @@ export interface InstallTemplateArgs {
customApiPath?: string;
openAiKey?: string;
llamaCloudKey?: string;
- forBackend?: string;
model: string;
embeddingModel: string;
communityProjectPath?: string;
diff --git a/helpers/typescript.ts b/helpers/typescript.ts
index bab6812f..ae97c2e2 100644
--- a/helpers/typescript.ts
+++ b/helpers/typescript.ts
@@ -61,10 +61,10 @@ export const installTSTemplate = async ({
ui,
eslint,
customApiPath,
- forBackend,
vectorDb,
postInstallAction,
-}: InstallTemplateArgs) => {
+ backend,
+}: InstallTemplateArgs & { backend: boolean }) => {
console.log(bold(`Using ${packageManager}.`));
/**
@@ -82,23 +82,20 @@ export const installTSTemplate = async ({
});
/**
- * If the backend is next.js, rename next.config.app.js to next.config.js
- * If not, rename next.config.static.js to next.config.js
+ * If next.js is not used as a backend, update next.config.js to use static site generation.
*/
- if (framework == "nextjs" && forBackend === "nextjs") {
- const nextConfigAppPath = path.join(root, "next.config.app.js");
- const nextConfigPath = path.join(root, "next.config.js");
- await fs.rename(nextConfigAppPath, nextConfigPath);
- // delete next.config.static.js
- const nextConfigStaticPath = path.join(root, "next.config.static.js");
- await fs.rm(nextConfigStaticPath);
- } else if (framework == "nextjs" && typeof forBackend === "undefined") {
- const nextConfigStaticPath = path.join(root, "next.config.static.js");
- const nextConfigPath = path.join(root, "next.config.js");
- await fs.rename(nextConfigStaticPath, nextConfigPath);
- // delete next.config.app.js
- const nextConfigAppPath = path.join(root, "next.config.app.js");
- await fs.rm(nextConfigAppPath);
+ if (framework === "nextjs" && !backend) {
+ // update next.config.json for static site generation
+ const nextConfigJsonFile = path.join(root, "next.config.json");
+ const nextConfigJson: any = JSON.parse(
+ await fs.readFile(nextConfigJsonFile, "utf8"),
+ );
+ nextConfigJson.output = "export";
+ nextConfigJson.images = { unoptimized: true };
+ await fs.writeFile(
+ nextConfigJsonFile,
+ JSON.stringify(nextConfigJson, null, 2) + os.EOL,
+ );
}
/**
diff --git a/templates/types/streaming/nextjs/next.config.app.js b/templates/types/streaming/nextjs/next.config.app.js
deleted file mode 100644
index 83b4de91..00000000
--- a/templates/types/streaming/nextjs/next.config.app.js
+++ /dev/null
@@ -1,19 +0,0 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {
- webpack: (config) => {
- // See https://webpack.js.org/configuration/resolve/#resolvealias
- config.resolve.alias = {
- ...config.resolve.alias,
- sharp$: false,
- "onnxruntime-node$": false,
- };
- return config;
- },
- experimental: {
- outputFileTracingIncludes: {
- "/*": ["./cache/**/*"],
- },
- },
-};
-
-module.exports = nextConfig;
diff --git a/templates/types/streaming/nextjs/next.config.json b/templates/types/streaming/nextjs/next.config.json
new file mode 100644
index 00000000..64b603e1
--- /dev/null
+++ b/templates/types/streaming/nextjs/next.config.json
@@ -0,0 +1,15 @@
+{
+ "experimental": {
+ "outputFileTracingIncludes": {
+ "/*": ["./cache/**/*"]
+ }
+ },
+ "webpack": {
+ "resolve": {
+ "alias": {
+ "sharp$": false,
+ "onnxruntime-node$": false
+ }
+ }
+ }
+}
diff --git a/templates/types/streaming/nextjs/next.config.mjs b/templates/types/streaming/nextjs/next.config.mjs
new file mode 100644
index 00000000..f6224537
--- /dev/null
+++ b/templates/types/streaming/nextjs/next.config.mjs
@@ -0,0 +1,13 @@
+/** @type {import('next').NextConfig} */
+import fs from "fs";
+import _ from "lodash";
+
+const nextConfig = JSON.parse(fs.readFileSync("./next.config.json", "utf-8"));
+const webpackConfig = _.cloneDeep(nextConfig.webpack);
+
+// webpack config must be a function in NextJS, to use a JSON as config, we merge the settings from next.config.json
+nextConfig.webpack = (config) => {
+ return _.merge(config, webpackConfig);
+};
+
+export default nextConfig;
diff --git a/templates/types/streaming/nextjs/next.config.static.js b/templates/types/streaming/nextjs/next.config.static.js
deleted file mode 100644
index 92b89bde..00000000
--- a/templates/types/streaming/nextjs/next.config.static.js
+++ /dev/null
@@ -1,21 +0,0 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {
- output: "export",
- images: { unoptimized: true },
- webpack: (config) => {
- // See https://webpack.js.org/configuration/resolve/#resolvealias
- config.resolve.alias = {
- ...config.resolve.alias,
- sharp$: false,
- "onnxruntime-node$": false,
- };
- return config;
- },
- experimental: {
- outputFileTracingIncludes: {
- "/*": ["./cache/**/*"],
- },
- },
-};
-
-module.exports = nextConfig;
--
GitLab