Feat: use framework info

docs/commands/dev.md

@@ -40,8 +40,8 @@ netlify dev
 
 ```bash
 $ netlify dev
-$ netlify dev -c "yarn start"
-$ netlify dev -c hugo
+$ netlify dev -d public
+$ netlify dev -c "hugo server -w" --targetPort 1313
 ```
 
 ---

docs/netlify-dev.md

@@ -56,7 +56,7 @@ alias ndeploy="netlify deploy --prod"
 alias nd="netlify dev"
 alias ndl="netlify dev --live"
 alias nfc="netlify functions:create"
-alias ndx="netlify dev:exec "
+alias ndx="netlify dev:exec"
 ```
 
 </details>
@@ -68,22 +68,21 @@ USAGE
   $ netlify dev
 
 OPTIONS
-  -c, --command=command      command to run
-  -f, --functions=functions  Specify a functions folder to serve
-  -o, --offline              disables any features that require network access
-  -p, --port=port            Specify port of netlify dev
-  -l, --live                 Start a public live session
+  -c, --command=command                                        command to run
+  -d, --dir=dir                                                dir with static files
+  -f, --functions=functions                                    specify a functions folder to serve
+  -l, --live                                                   start a public live session
+  -o, --offline                                                disables any features that require network access
+  -p, --port=port                                              port of netlify dev
+  --targetPort=targetPort                                      port of target app server
 
 DESCRIPTION
-  The dev command will run a local dev server with Netlify's Edge Logic proxies and redirects, serverless functions, and addons
+  The dev command will run a local dev server with Netlify's proxy and redirect rules
 
 EXAMPLES
   $ netlify dev
-  $ netlify dev -c "yarn start"
-  $ netlify dev -c hugo
-
-COMMANDS
-  dev:exec  Exec command
+  $ netlify dev -d public
+  $ netlify dev -c "hugo server -w" --targetPort 1313
 ```
 
 ## Live Share
@@ -96,8 +95,6 @@ netlify dev --live
 
 You will get a URL that looks like `https://clever-cray-2aa156-6639f3.netlify.live/`. This can be accessed by anyone as long as you keep your session open.
 
-> Note: there are currently known issues with ending the live session alongside your webdevserver, as well as with live reloading. We are working on fixing it, and would appreciate repro cases, or you may check [existing issues with the `--live` tag](https://github.com/netlify/netlify-dev-plugin/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A--live). In the mean time you can run `ps aux | grep live-tunnel` and kill these sessions manually.
-
 ## netlify.toml [dev] block
 
 Netlify Dev is meant to work with zero config for the majority of users, by using its detector system. However you may wish to assert more control over its behavior, and should make use of the new `[dev]` block in `netlify.toml` to do so:
@@ -109,7 +106,7 @@ Netlify Dev is meant to work with zero config for the majority of users, by usin
   functions = "functions" # netlify dev uses this directory to scaffold and serve your functions
   publish = "dist"
 
-# note: each of these fields are OPTIONAL, with an exception that when you’re specifying "command" and "targetPort", you must specify framework = "#custom"
+# note: each of these fields are OPTIONAL
 [dev]
   command = "yarn start" # Command to start your dev server
   targetPort = 3000 # The port for your application server, framework or site generator
@@ -126,15 +123,14 @@ Netlify Dev is meant to work with zero config for the majority of users, by usin
 
 ## Project detection
 
-Netlify Dev will attempt to detect the site generator or build command that you are using, and run these on your behalf, while adding other development utilities. If you have a JavaScript project, it looks for the best `package.json` script to run for you, using simple heuristics, so you can use the full flexibility of npm scripts. We may add more intelligence to this in the future.
+Netlify Dev will attempt to detect the site generator or build command that you are using, and run these on your behalf, while adding other development utilities. If you have a JavaScript project, it looks for the best `package.json` script to run for you, using simple heuristics, so you can use the full flexibility of npm scripts.
 
-**Overriding the detectors**: The number of [project types which Netlify Dev can detect](https://github.com/netlify/cli/tree/main/src/detectors) is growing, but if yours is not yet supported (contributions welcome!), you can instruct Netlify Dev to run the project on your behalf by declaring it in a `[dev]` block of your `netlify.toml` file.
+**Overriding framework detection**: The number of [frameworks which Netlify Dev can detect](https://github.com/netlify/framework-info/tree/main/src/frameworks) is growing, but if yours is not yet supported (contributions welcome!), you can instruct Netlify Dev to run the project on your behalf by declaring it in a `[dev]` block of your `netlify.toml` file.
 
 ```toml
 # sample dev block in the toml
 # note: each of these fields are OPTIONAL and should only be used if you need an override
 [dev]
-  framework = "#custom"
   command = "yarn start" # Command to start your dev server
   targetPort = 3000 # # The port for your application server, framework or site generator
   port = 8888 # The port that the netlify dev will be accessible on
@@ -152,8 +148,8 @@ against your project.
 
 Possible values of `framework`:
 
-- `#auto` (default) to check of all [available frameworks](https://github.com/netlify/cli/tree/main/src/detectors).
-- One of the frameworks as specified [here](https://github.com/netlify/cli/tree/main/src/detectors).
+- `#auto` (default) to check of all [available frameworks](https://github.com/netlify/framework-info/tree/main/src/frameworks).
+- One of the framework ids as specified [here](https://github.com/netlify/framework-info/tree/main/src/frameworks).
 - `#static` for a static file server
 - `#custom` to use the `command` option to run an app server and `targetPort` option to connect to it
 
@@ -170,7 +166,7 @@ As for which port to use while doing local development in Netlify Dev, always se
 ```bash
    ┌──────────────────────────────────────────────────────────────┐
    │                                                              │
-   │   [Netlify Dev] Server now ready on http://localhost:64939   │
+   │   [Netlify Dev] Server now ready on http://localhost:8888    │
    │                                                              │
    └──────────────────────────────────────────────────────────────┘
 ```

package.json

@@ -77,7 +77,7 @@
   "dependencies": {
     "@netlify/build": "^15.11.2",
     "@netlify/config": "^12.6.0",
-    "@netlify/framework-info": "^5.7.1",
+    "@netlify/framework-info": "^5.7.2",
     "@netlify/plugin-edge-handlers": "^1.11.21",
     "@netlify/plugins-list": "^2.19.1",
     "@netlify/routing-local-proxy": "^0.30.2",

src/commands/dev/index.js

@@ -12,7 +12,7 @@ const waitPort = require('wait-port')
 
 const { startFunctionsServer } = require('../../lib/functions/server')
 const Command = require('../../utils/command')
-const { serverSettings } = require('../../utils/detect-server')
+const { detectServerSettings } = require('../../utils/detect-server-settings')
 const { getSiteInformation, injectEnvVariables } = require('../../utils/dev')
 const { startLiveTunnel } = require('../../utils/live-tunnel')
 const { NETLIFYDEV, NETLIFYDEVLOG, NETLIFYDEVWARN, NETLIFYDEVERR } = require('../../utils/logo')
@@ -31,7 +31,7 @@ const startStaticServer = async ({ settings, log }) => {
   })
 
   await promisify(server.start.bind(server))()
-  log(`\n${NETLIFYDEVLOG} Server listening to`, settings.frameworkPort)
+  log(`\n${NETLIFYDEVLOG} Static server listening to`, settings.frameworkPort)
 }
 
 const isNonExistingCommandError = ({ command, error }) => {
@@ -53,14 +53,14 @@ const isNonExistingCommandError = ({ command, error }) => {
 }
 
 const startFrameworkServer = async function ({ settings, log, exit }) {
-  if (settings.noCmd) {
+  if (settings.useStaticServer) {
     return await startStaticServer({ settings, log })
   }
 
   log(`${NETLIFYDEVLOG} Starting Netlify Dev with ${settings.framework || 'custom config'}`)
 
   // we use reject=false to avoid rejecting synchronously when the command doesn't exist
-  const frameworkProcess = execa(settings.command, settings.args, { preferLocal: true, reject: false })
+  const frameworkProcess = execa.command(settings.command, { preferLocal: true, reject: false })
   frameworkProcess.stdout.pipe(stripAnsiCc.stream()).pipe(process.stdout)
   frameworkProcess.stderr.pipe(stripAnsiCc.stream()).pipe(process.stderr)
   process.stdin.pipe(frameworkProcess.stdin)
@@ -70,17 +70,17 @@ const startFrameworkServer = async function ({ settings, log, exit }) {
   // eslint-disable-next-line promise/catch-or-return,promise/prefer-await-to-then
   frameworkProcess.then(async () => {
     const result = await frameworkProcess
+    const [commandWithoutArgs] = settings.command.split(' ')
     // eslint-disable-next-line promise/always-return
-    if (result.failed && isNonExistingCommandError({ command: settings.command, error: result })) {
+    if (result.failed && isNonExistingCommandError({ command: commandWithoutArgs, error: result })) {
       log(
         NETLIFYDEVERR,
-        `Failed launching framework server. Please verify ${chalk.magenta(`'${settings.command}'`)} exists`,
+        `Failed launching framework server. Please verify ${chalk.magenta(`'${commandWithoutArgs}'`)} exists`,
       )
     } else {
-      const commandWithArgs = `${settings.command} ${settings.args.join(' ')}`
       const errorMessage = result.failed
         ? `${NETLIFYDEVERR} ${result.shortMessage}`
-        : `${NETLIFYDEVWARN} "${commandWithArgs}" exited with code ${result.exitCode}`
+        : `${NETLIFYDEVWARN} "${settings.command}" exited with code ${result.exitCode}`
 
       log(`${errorMessage}. Shutting down Netlify Dev server`)
     }
@@ -98,7 +98,7 @@ const startFrameworkServer = async function ({ settings, log, exit }) {
       port: settings.frameworkPort,
       output: 'silent',
       timeout: FRAMEWORK_PORT_TIMEOUT,
-      ...(settings.disableLocalServerPolling ? {} : { protocol: 'http' }),
+      ...(settings.pollingStrategies.includes('HTTP') && { protocol: 'http' }),
     })
 
     if (!open) {
@@ -208,7 +208,7 @@ class DevCommand extends Command {
 
     let settings = {}
     try {
-      settings = await serverSettings(devConfig, flags, site.root, log)
+      settings = await detectServerSettings(devConfig, flags, site.root, log)
     } catch (error) {
       log(NETLIFYDEVERR, error.message)
       exit(1)
@@ -249,7 +249,11 @@ DevCommand.description = `Local dev server
 The dev command will run a local dev server with Netlify's proxy and redirect rules
 `
 
-DevCommand.examples = ['$ netlify dev', '$ netlify dev -c "yarn start"', '$ netlify dev -c hugo']
+DevCommand.examples = [
+  '$ netlify dev',
+  '$ netlify dev -d public',
+  '$ netlify dev -c "hugo server -w" --targetPort 1313',
+]
 
 DevCommand.strict = false