docs: use nuxi everywhere (nuxt#1577)

andysay · Oct 29, 2021 · 495aeff · 495aeff
1 parent f60f461
commit 495aeff
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 31 deletions.
diff --git a/docs/content/1.getting-started/3.bridge.md b/docs/content/1.getting-started/3.bridge.md
@@ -55,26 +55,43 @@ npm install -D @nuxt/bridge@npm:@nuxt/bridge-edge
 
 You will also need to update your scripts within your `package.json` to reflect the fact that Nuxt will now produce a Nitro server as build output.
 
+#### Nuxi
+
+Nuxt 3 introduced the new Nuxt CLI command [`nuxi`](/getting-started/commands/). Update your scripts as follows to leverage the better support from Nuxt Bridge:
+
+```diff
+{
+  "scripts": {
+-   "dev": "nuxt",
++   "dev": "nuxi dev",
+-   "build": "nuxt build",
++   "build": "nuxi build",
+-   "start": "nuxt start",
++   "start": "node .output/server/index.mjs"
+  }
+}
+```
+
 #### Static target
 
-If you have set `target: 'static'` in your `nuxt.config` then you need to ensure that you update your build script to be `nuxt generate`.
+If you have set `target: 'static'` in your `nuxt.config` then you need to ensure that you update your build script to be `nuxi generate`.
 
 ```json
 {
   "scripts": {
-    "build": "nuxt generate"
+    "build": "nuxi generate"
   }
 }
 ```
 
 #### Server target
 
-For all other situations, you can use the normal `nuxt build` command.
+For all other situations, you can use the `nuxi build` command.
 
 ```json
 {
   "scripts": {
-    "build": "nuxt build",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }

diff --git a/docs/package.json b/docs/package.json
@@ -2,7 +2,7 @@
   "name": "docs",
   "private": true,
   "scripts": {
-    "dev": "yarn gendocs && nuxt dev",
+    "dev": "yarn gendocs && nuxi dev",
     "build": "yarn gendocs && nuxt generate --force-build",
     "build:ci": "yarn add @nuxt/kit@npm:@nuxt/kit-edge && yarn build",
     "gendocs": "jiti ./scripts/gen-docs.ts"

diff --git a/examples/hello-world/package.json b/examples/hello-world/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/use-async-data/package.json b/examples/use-async-data/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/use-fetch/package.json b/examples/use-fetch/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/use-meta/package.json b/examples/use-meta/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server"
   }
 }
diff --git a/examples/use-state/package.json b/examples/use-state/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/with-components/package.json b/examples/with-components/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/with-composables/package.json b/examples/with-composables/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/with-layouts/package.json b/examples/with-layouts/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/with-pages/package.json b/examples/with-pages/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/examples/with-wasm/package.json b/examples/with-wasm/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
     "release": "yarn && yarn lint && FORCE_COLOR=1 lerna publish -m \"chore: release\" && yarn stub",
     "nuxi": "./node_modules/.bin/nuxi",
     "nuxt": "./node_modules/.bin/nuxi",
-    "play": "yarn run nuxt dev playground",
+    "play": "yarn run nuxi dev playground",
     "example": "yarn workspace example-$0 dev",
     "example:build": "yarn workspace example-$0 build",
     "lint": "eslint --ext .vue,.ts,.js .",

diff --git a/playground/package.json b/playground/package.json
@@ -5,8 +5,8 @@
     "nuxt3": "latest"
   },
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build",
+    "dev": "nuxi dev",
+    "build": "nuxi build",
     "start": "node .output/server/index.mjs"
   }
 }
diff --git a/test/fixtures/basic/package.json b/test/fixtures/basic/package.json
@@ -2,6 +2,6 @@
   "private": true,
   "name": "fixture-bridge",
   "scripts": {
-    "build": "nuxt build"
+    "build": "nuxi build"
   }
 }
diff --git a/test/fixtures/bridge/package.json b/test/fixtures/bridge/package.json
@@ -2,8 +2,8 @@
   "private": true,
   "name": "fixture-basic",
   "scripts": {
-    "dev": "nuxt dev",
-    "build": "nuxt build"
+    "dev": "nuxi dev",
+    "build": "nuxi build"
   },
   "devDependencies": {
     "@nuxt/bridge": "*",