From 4b70f9fa37bf8fec25c3b054d08e8868acba3d1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20De=20Boey?= Date: Thu, 16 Mar 2023 00:38:49 +0100 Subject: [PATCH] feat(remix-dev): show deprecation warning when `serverBuildDirectory` config is used (#5704) --- .changeset/wild-beers-agree.md | 5 +++++ packages/remix-dev/config.ts | 26 ++++++++++++++++++++++---- 2 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 .changeset/wild-beers-agree.md diff --git a/.changeset/wild-beers-agree.md b/.changeset/wild-beers-agree.md new file mode 100644 index 00000000000..b554995e328 --- /dev/null +++ b/.changeset/wild-beers-agree.md @@ -0,0 +1,5 @@ +--- +"@remix-run/dev": minor +--- + +show deprecation warning when `serverBuildDirectory` config is used diff --git a/packages/remix-dev/config.ts b/packages/remix-dev/config.ts index 7430315b260..dcdab1dac61 100644 --- a/packages/remix-dev/config.ts +++ b/packages/remix-dev/config.ts @@ -726,6 +726,8 @@ const resolveServerBuildPath = ( // retain deprecated behavior for now if (appConfig.serverBuildDirectory) { + warnOnce(serverBuildDirectoryWarning, "serverBuildDirectory"); + serverBuildPath = path.join(appConfig.serverBuildDirectory, "index.js"); } @@ -743,10 +745,26 @@ let listFormat = new Intl.ListFormat("en", { type: "conjunction", }); -export let browserBuildDirectoryWarning = `⚠️ DEPRECATED: The \`browserBuildDirectory\` config option is deprecated. Use \`assetsBuildDirectory\` instead.`; -export let serverBuildTargetWarning = `⚠️ DEPRECATED: The \`serverBuildTarget\` config option is deprecated. Use a combination of \`publicPath\`, \`serverBuildPath\`, \`serverConditions\`, \`serverDependenciesToBundle\`, \`serverMainFields\`, \`serverMinify\`, \`serverModuleFormat\` and/or \`serverPlatform\` instead.`; - -export let flatRoutesWarning = `⚠️ DEPRECATED: The old nested folders route convention has been deprecated in favor of "flat routes". Please enable the new routing convention via the \`future.v2_routeConvention\` flag in your \`remix.config.js\` file. For more information, please see https://remix.run/docs/en/main/file-conventions/route-files-v2.`; +export let browserBuildDirectoryWarning = + "⚠️ DEPRECATED: The `browserBuildDirectory` config option is deprecated. " + + "Use `assetsBuildDirectory` instead."; + +export let serverBuildDirectoryWarning = + "⚠️ DEPRECATED: The `serverBuildDirectory` config option is deprecated. " + + "Use `serverBuildPath` instead."; + +export let serverBuildTargetWarning = + "⚠️ DEPRECATED: The `serverBuildTarget` config option is deprecated. Use a " + + "combination of `publicPath`, `serverBuildPath`, `serverConditions`, " + + "`serverDependenciesToBundle`, `serverMainFields`, `serverMinify`, " + + "`serverModuleFormat` and/or `serverPlatform` instead."; + +export let flatRoutesWarning = + "⚠️ DEPRECATED: The old nested folders route convention has been " + + "deprecated in favor of 'flat routes'. Please enable the new routing " + + "convention via the `future.v2_routeConvention` flag in your " + + "`remix.config.js` file. For more information, please see " + + "https://remix.run/docs/en/main/file-conventions/route-files-v2."; export const errorBoundaryWarning = "⚠️ DEPRECATED: The separation of `CatchBoundary` and `ErrorBoundary` has " +