feat: add hoistDependencies (#1)

Author: BobbieGoede

.github/workflows/preview-release.yml

@@ -0,0 +1,42 @@
+name: preview release
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - '!**'
+  pull_request:
+    types: [opened, synchronize, labeled]
+    branches: [main]
+    paths-ignore:
+      - 'docs/**'
+      - 'test/**'
+      - 'specs/**'
+      - 'playground/**'
+
+jobs:
+  release:
+    if: ${{ contains(github.event.pull_request.labels.*.name, 'cr-tracked') }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm build
+
+      - name: Release with pkg-pr-new
+        run: pnpx pkg-pr-new publish --no-template --pnpm

.github/workflows/release.yml

@@ -6,7 +6,7 @@ permissions:
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 jobs:
   release:
@@ -22,4 +22,4 @@ jobs:
 
       - run: npx changelogithub
         env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -41,4 +41,5 @@ node_modules
 # Test output
 /.nyc_output
 /coverage
-dist
+dist
+.env

README.md

@@ -8,24 +8,31 @@
 
 A collection of utility functions for Nuxt module authors.
 
-
 ## Installation
 
 ```bash
 npm i nuxt-module-utils
 ```
 
-<!-- ## Usage
+## Usage
+
+### `hoistDependencies(hoist: string[])`
+
+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 { someUtil } from 'nuxt-module-utils'
+import { defineNuxtModule } from '@nuxt/kit'
+import { hoistDependencies } from 'nuxt-module-utils'
 
 export default defineNuxtModule({
-  setup() {
+  async setup() {
+    await hoistDependencies(['my-lib', 'my-other-lib'])
   }
 })
-``` -->
+```
 
 ## Sponsors
 
@@ -34,4 +41,3 @@ export default defineNuxtModule({
     <img src="https://raw.githubusercontent.com/bobbiegoede/static/main/sponsors.svg" />
   </a>
 </p>
-

package.json

@@ -5,6 +5,13 @@
   "type": "module",
   "license": "MIT",
   "funding": "https://github.com/sponsors/bobbiegoede",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bobbiegoede/nuxt-module-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bobbiegoede/nuxt-module-utils/issues"
+  },
   "keywords": [
     "nuxt",
     "module"
@@ -34,9 +41,22 @@
   },
   "packageManager": "pnpm@10.11.1",
   "devDependencies": {
-    "@nuxt/kit": "^3.17.5",
+    "@types/node": "^24.0.13",
     "bumpp": "^10.1.1",
     "tsdown": "^0.12.7",
     "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "nuxt": "^3.16.0 || ^4.0.0-rc.0",
+    "@nuxt/kit": "^3.16.0 || ^4.0.0-rc.0",
+    "@nuxt/schema": "^3.16.0 || ^4.0.0-rc.0"
+  },
+  "dependencies": {
+    "defu": "^6.1.4",
+    "exsolve": "^1.0.7",
+    "magic-string": "^0.30.17",
+    "pathe": "^2.0.3",
+    "pkg-types": "^2.2.0",
+    "unplugin": "^2.3.5"
   }
 }