@nuxt/docs-nightly 4.6.0-29792791.d6bf1f45 → 4.6.0-29798469.ab647774

package/4.api/5.kit/14.logging.md

@@ -53,3 +53,57 @@ export default defineNuxtModule({
   },
 })
 ```
+
+## `useTerminal`
+
+Returns a set of primitives for interacting with the user's terminal. When Nuxt is running inside an interactive host such as the `nuxt dev` terminal UI, prompts, tasks and notifications are handed to it, so they are answerable and rendered in one place. Otherwise they fall back to logging.
+
+### Usage
+
+```ts twoslash
+declare function runPackageInstall (name: string): Promise<void>
+// ---cut---
+import { defineNuxtModule, useTerminal } from '@nuxt/kit'
+
+export default defineNuxtModule({
+  async setup () {
+    const terminal = useTerminal()
+
+    const install = await terminal.prompt('Do you want to install `my-module`?', { type: 'confirm' })
+    if (!install) {
+      return
+    }
+
+    const task = terminal.startTask('Installing `my-module`...')
+    // run your actual task
+    await runPackageInstall('my-module')
+    task.stop('Installed `my-module`')
+  },
+})
+```
+
+### Type
+
+```ts
+function useTerminal (): NuxtTerminal
+
+interface NuxtTerminal {
+  readonly interactive: boolean
+  withTerminal: <T>(work: () => Promise<T>) => Promise<T>
+  prompt: (message: string, options?: NuxtPromptOptions) => Promise<any>
+  startTask: (label: string) => NuxtTerminalTask
+  notify: (notification: NuxtTerminalNotification) => NuxtTerminalNotice
+}
+```
+
+### Properties
+
+**`interactive`**: Whether an interactive host is present. When `false`, the primitives below log to the current process streams instead.
+
+**`withTerminal`**: Borrows the terminal for the duration of `work`, suspending any host UI and releasing `stdin`. Use it when you need to write to the terminal or read from `stdin` directly. Concurrent callers are serialised, and a nested call from within a borrow runs immediately.
+
+**`prompt`**: Asks the user a question, borrowing the terminal for as long as the prompt is open. Takes the same options as `logger.prompt`.
+
+**`startTask`**: Starts a long-running task, rendered on the host's status surface where available. Finish it with `task.stop(message?, outcome?)`, or change its label with `task.update(label)`.
+
+**`notify`**: Shows a message and holds it on screen until the user acknowledges it or `notice.dismiss()` is called. `notice.dismissed` settles once the notice is gone.

package/4.api/6.advanced/1.hooks.md

@@ -44,6 +44,8 @@ Check the [schema source code](https://github.com/nuxt/nuxt/blob/main/packages/s
 | `restart`                   | `{ hard?: boolean }`                                     | To be called to restart the current Nuxt instance.                                                                                                                                                                                                                                           |
 | `modules:before`            | -                                                        | Called during Nuxt initialization, before installing user modules.                                                                                                                                                                                                                           |
 | `modules:done`              | -                                                        | Called during Nuxt initialization, after installing user modules.                                                                                                                                                                                                                            |
+| `module:before`             | `module`                                                 | Called immediately before each individual module is set up.                                                                                                                                                                                                                                  |
+| `module:done`               | `module`                                                 | Called immediately after each individual module has been set up, including how long it took.                                                                                                                                                                                                  |
 | `app:resolve`               | `app`                                                    | Called after resolving the `app` instance.                                                                                                                                                                                                                                                   |
 | `app:templates`             | `app`                                                    | Called during `NuxtApp` generation, to allow customizing, modifying or adding new files to the build directory (either virtually or to written to `.nuxt`).                                                                                                                                  |
 | `app:templatesGenerated`    | `app`                                                    | Called after templates are compiled into the [virtual file system](/docs/4.x/directory-structure/nuxt) (vfs).                                                                                                                                                                                |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/docs-nightly",
-  "version": "4.6.0-29792791.d6bf1f45",
+  "version": "4.6.0-29798469.ab647774",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/nuxt.git",
@@ -17,5 +17,6 @@
     "**/*.md",
     "**/*.yml"
   ],
-  "_name": "@nuxt/docs"
+  "_name": "@nuxt/docs",
+  "scripts": {}
 }