fix!: deprecate hoistDependencies

Author: BobbieGoede

README.md

@@ -16,27 +16,6 @@ npm i nuxt-module-utils
 
 ## Usage
 
-### `hoistDependencies(hoist: string[])`
-
-> [!NOTE]
-> [Nuxt `4.0.0+` now supports modules adding to `typescript.hoist`](https://github.com/nuxt/nuxt/pull/32601), this utility is only needed to support projects using Nuxt `3.x` with `compatibilityVersion: 4`.
-
-While Nuxt provides the `typescript.hoist` option to generate aliases for nested dependencies within pnpm monorepos, it is processed before modules are set up.
-
-The `hoistDependencies` utility allows you to hoist dependencies from within your module's `setup` function. It works by resolving the paths of the specified packages and adding them to Nuxt's TypeScript configuration, ensuring they are included in the generated `tsconfig.json`.
-
-```ts
-// src/module.ts
-import { defineNuxtModule } from '@nuxt/kit'
-import { hoistDependencies } from 'nuxt-module-utils'
-
-export default defineNuxtModule({
-  async setup() {
-    await hoistDependencies(['my-lib', 'my-other-lib'])
-  }
-})
-```
-
 ### `getLayerModuleOptions<T>(layer: NuxtConfigLayer, configKey: string, name: string)`
 
 Get module options from a given Nuxt layer.
@@ -70,6 +49,25 @@ export default defineNuxtModule<ModuleOptions>({
 })
 ```
 
+### `hoistDependencies(hoist: string[])`
+
+> [!WARNING]
+> Deprecated and will be removed in v1 - [Nuxt `4.0.0` supports modules adding to `typescript.hoist`](https://github.com/nuxt/nuxt/pull/32601)
+
+The `hoistDependencies` utility allows you to hoist dependencies from within your module's `setup` function. It works by resolving the paths of the specified packages and adding them to Nuxt's TypeScript configuration, ensuring they are included in the generated `tsconfig.json`.
+
+```ts
+// src/module.ts
+import { defineNuxtModule } from '@nuxt/kit'
+import { hoistDependencies } from 'nuxt-module-utils'
+
+export default defineNuxtModule({
+  async setup() {
+    await hoistDependencies(['my-lib', 'my-other-lib'])
+  }
+})
+```
+
 ## Sponsors
 
 <p align="center">

src/hoist.ts

@@ -34,6 +34,7 @@ async function resolveTypePath(path: string, subpath: string, searchPaths = tryU
  * @param nuxt - The Nuxt instance.
  *
  * @see [Nuxt source](https://github.com/nuxt/nuxt/blob/5146bed75eb1a6617e2fb17ea97b3d121cd94930/packages/nuxt/src/core/nuxt.ts#L188-L290)
+ * @deprecated Module support for `typescript.hoist` was added in Nuxt 4.0.0.
  */
 export async function hoistDependencies(hoist: string[], nuxt = useNuxt()) {
   const isVersion4 = (await readPackageJSON("nuxt"))?.version?.startsWith("4");