fix: tell users to re-run netlify dev after interrupting dev to init project

When a user runs `netlify dev` on an unlinked repository and they're
using an extension that requires a linked repository (e.g. Neon), we
interrupt them to initialize a project. Because of the way we cache
information about the current site, we're unable to effectively
invalidate the site state before starting the dev process, and so we
exit and expect the user to run `netlify dev` again to proceed.

We currently don't explicitly tell the user we're about to exit and
that they need to re-run `netlify dev`, though, which is jarring and
leaves the user in a bit of a lurch.

This changeset adds an informational message after `netlify dev` exits,
telling them to re-run the dev command. Ideally we would not require
this step, but we need to do some work on how we invalidate cached site
data before we can do that.

Author: ndhoule

src/commands/dev/dev.ts

@@ -16,6 +16,7 @@ import {
   chalk,
   log,
   normalizeConfig,
+  netlifyCommand,
 } from '../../utils/command-helpers.js'
 import detectServerSettings, { getConfigWithPlugins } from '../../utils/detect-server-settings.js'
 import { UNLINKED_SITE_MOCK_ID, getDotEnvVariables, getSiteInformation, injectEnvVariables } from '../../utils/dev.js'
@@ -111,7 +112,21 @@ export const dev = async (options: OptionValues, command: BaseCommand) => {
       } a linked project, but you don't have one linked yet. Let's do that first.`,
     )
     const { init } = await import('../init/init.js')
-    await init(getBaseOptionValues(options), command)
+    const { LINKED_NEW_SITE_EXIT_CODE, LINKED_EXISTING_SITE_EXIT_CODE } = await import('../init/constants.js')
+
+    await init(getBaseOptionValues(options), command, {
+      customizeExitMessage: (code, defaultMessage) => {
+        switch (code) {
+          case LINKED_NEW_SITE_EXIT_CODE:
+          // fallthrough
+          case LINKED_EXISTING_SITE_EXIT_CODE:
+            return `${defaultMessage !== '' ? `${defaultMessage}\n` : ''}You can run ${chalk.cyanBright.bold(
+              `${netlifyCommand()} dev`,
+            )} again to start the local development server.`
+        }
+      },
+      exitAfterConfiguringRepo: true,
+    })
   }
 
   const blobsContext = await getBlobsContextWithEdgeAccess({

src/commands/init/constants.ts

@@ -0,0 +1,5 @@
+export const LINKED_NEW_SITE_EXIT_CODE = 'LINKED_NEW_SITE'
+
+export const LINKED_EXISTING_SITE_EXIT_CODE = 'LINKED_EXISTING_SITE'
+
+export type InitExitCode = typeof LINKED_NEW_SITE_EXIT_CODE | typeof LINKED_EXISTING_SITE_EXIT_CODE

src/commands/init/init.ts

@@ -12,6 +12,7 @@ import { link } from '../link/link.js'
 import { sitesCreate } from '../sites/sites-create.js'
 import type { CLIState, SiteInfo } from '../../utils/types.js'
 import { getBuildSettings, saveNetlifyToml } from '../../utils/init/utils.js'
+import { type InitExitCode, LINKED_EXISTING_SITE_EXIT_CODE, LINKED_NEW_SITE_EXIT_CODE } from './constants.js'
 
 const persistState = ({ siteInfo, state }: { siteInfo: SiteInfo; state: CLIState }): void => {
   // Save to .netlify/state.json file
@@ -43,10 +44,12 @@ const createNewSiteAndExit = async ({
   command,
   state,
   disableLinking,
+  customizeExitMessage,
 }: {
   command: BaseCommand
   state: CLIState
   disableLinking: boolean
+  customizeExitMessage: InitExitMessageCustomizer | undefined
 }): Promise<never> => {
   const siteInfo = await sitesCreate({}, command)
 
@@ -78,8 +81,8 @@ const createNewSiteAndExit = async ({
   }
 
   log()
-  log(`To deploy to this project, run ${chalk.cyanBright.bold(`${netlifyCommand()} deploy`)}`)
-
+  const defaultExitMesage = `To deploy to this project, run ${chalk.cyanBright.bold(`${netlifyCommand()} deploy`)}.`
+  log(customizeExitMessage?.(LINKED_NEW_SITE_EXIT_CODE, defaultExitMesage) ?? defaultExitMesage)
   return exit()
 }
 
@@ -124,11 +127,13 @@ const handleNoGitRemoteAndExit = async ({
   error,
   state,
   disableLinking,
+  customizeExitMessage,
 }: {
   command: BaseCommand
   error?: unknown
   state: CLIState
   disableLinking: boolean
+  customizeExitMessage: InitExitMessageCustomizer | undefined
 }): Promise<never> => {
   log()
   log(chalk.yellow('No git remote was found, would you like to set one up?'))
@@ -159,7 +164,8 @@ git remote add origin https://github.com/YourUserName/RepoName.git
   ])
 
   if (noGitRemoteChoice === NEW_SITE_NO_GIT) {
-    return createNewSiteAndExit({ state, command, disableLinking })
+    // TODO(ndhoule): Shove a custom error message in here
+    return createNewSiteAndExit({ state, command, disableLinking, customizeExitMessage })
   }
   return logGitSetupInstructionsAndExit()
 }
@@ -194,15 +200,36 @@ const createOrLinkSiteToRepo = async (command: BaseCommand) => {
   return await link({}, command)
 }
 
-const logExistingRepoSetupAndExit = ({ repoUrl, siteName }: { repoUrl: string; siteName: string }): void => {
+const logExistingRepoSetupAndExit = ({
+  repoUrl,
+  siteName,
+  customizeExitMessage,
+}: {
+  repoUrl: string
+  siteName: string
+  customizeExitMessage: InitExitMessageCustomizer | undefined
+}): void => {
   log()
   log(chalk.underline.bold(`Success`))
-  log(`This project "${siteName}" is configured to automatically deploy via ${repoUrl}`)
+
+  const defaultExitMessage = `This project "${siteName}" is configured to automatically deploy via ${repoUrl}.`
+  log(customizeExitMessage?.(LINKED_EXISTING_SITE_EXIT_CODE, defaultExitMessage) ?? defaultExitMessage)
   // TODO add support for changing GitHub repo in site:config command
   exit()
 }
 
-export const init = async (options: OptionValues, command: BaseCommand): Promise<SiteInfo> => {
+type InitExitMessageCustomizer = (code: InitExitCode, defaultMessage: string) => string | undefined
+
+type InitExtraOptions = {
+  customizeExitMessage?: InitExitMessageCustomizer | undefined
+  exitAfterConfiguringRepo?: boolean | undefined
+}
+
+export const init = async (
+  options: OptionValues,
+  command: BaseCommand,
+  { customizeExitMessage, exitAfterConfiguringRepo = false }: InitExtraOptions = {},
+): Promise<SiteInfo> => {
   command.setAnalyticsPayload({ manual: options.manual, force: options.force })
 
   const { repositoryRoot, state } = command.netlify
@@ -222,11 +249,13 @@ export const init = async (options: OptionValues, command: BaseCommand): Promise
   // Look for local repo
   const repoData = await getRepoData({ workingDir: command.workingDir, remoteName: options.gitRemoteName })
   if ('error' in repoData) {
+    // TODO(ndhoule): Custom error messaage here
     return await handleNoGitRemoteAndExit({
       command,
       error: repoData.error,
       state,
       disableLinking: options.disableLinking,
+      customizeExitMessage,
     })
   }
 
@@ -237,12 +266,19 @@ export const init = async (options: OptionValues, command: BaseCommand): Promise
   // Check for existing CI setup
   const remoteBuildRepo = getRepoUrl(siteInfo)
   if (remoteBuildRepo && !options.force) {
-    logExistingRepoSetupAndExit({ siteName: siteInfo.name, repoUrl: remoteBuildRepo })
+    logExistingRepoSetupAndExit({ siteName: siteInfo.name, repoUrl: remoteBuildRepo, customizeExitMessage })
   }
 
   persistState({ state, siteInfo })
 
   await configureRepo({ command, siteId: siteInfo.id, repoData, manual: options.manual })
+  if (exitAfterConfiguringRepo) {
+    const customErrorMessage = customizeExitMessage?.(LINKED_EXISTING_SITE_EXIT_CODE, '')
+    if (customErrorMessage) {
+      log(customErrorMessage)
+    }
+    return exit()
+  }
 
   return siteInfo
 }