feat: make spotlight an optional peer dep (#50)

Just a proposal... let me know if there should be a readme note --------- Co-authored-by: Sebastien Vanvelthem <[email protected]>
BuilderIO · Oct 2, 2024 · e0807d1 · e0807d1
1 parent 566918c
commit e0807d1
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.changeset/beige-countries-punch.md b/.changeset/beige-countries-punch.md
@@ -0,0 +1,15 @@
+---
+"@builder.io/react-hydration-overlay": minor
+---
+
+Mark @spotlightjs/spotlight as an optional peer dependency
+
+If you enable spotlight integration, please install the dependency explicitly
+in your project.
+
+```bash
+npm install @spotlightjs/spotlight --dev
+yarn add @spotlightjs/spotlight --dev 
+pnpm add @spotlightjs/spotlight --dev
+```
+
diff --git a/packages/lib/package.json b/packages/lib/package.json
@@ -45,6 +45,11 @@
     "webpack": ">=4",
     "@spotlightjs/spotlight": "^1.2.11"
   },
+  "peerDependenciesMeta": {
+    "@spotlightjs/spotlight": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
     "@types/beautify": "^0.0.3",