Skip to content

Commit

Permalink
refactor!: add dat.gui and angular to peerDependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenle committed Jan 20, 2023
1 parent 29593da commit 16b5e29
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
13 changes: 8 additions & 5 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@ After:
import * as dom from '@blinkk/degu/lib/dom/dom.js';
```

### Install peerDependencies when using `lit` or `lottie-web`
### Install optional peerDependencies

A few 3rd party dependencies have been moved to optional peerDependencies. If you're using a module that uses `lit` or `lottie-web`, you may need to install it in your project, e.g.
A few 3rd party dependencies have been moved to optional peerDependencies. If you're using a module that uses one of the 3rd party libs below, you may need to `npm install` it into your project if you haven't already.

* angular
* dat.gui
* lit
* lottie-web
* pixi.js

```
yarn install lottie-web
```
See the full list in [package.json#peerDependencies](package.json).
9 changes: 8 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@
"@open-wc/testing": "^3.0.3",
"@types/angular": "1.6.57",
"@types/angular-sanitize": "^1.7.0",
"@types/dat-gui": "0.6.3",
"@types/dat.gui": "^0.7.5",
"@types/jquery": "^3.3.32",
"@types/mocha": "^9.0.0",
Expand Down Expand Up @@ -154,13 +153,21 @@
"posttest": "npm run lint"
},
"peerDependencies": {
"angular": "*",
"dat.gui": "*",
"jquery": "*",
"lit": "*",
"lottie-web": "*",
"pixi.js": "*",
"three": "*"
},
"peerDependenciesMeta": {
"angular": {
"optional": true
},
"dat.gui": {
"optional": true
},
"jquery": {
"optional": true
},
Expand Down

0 comments on commit 16b5e29

Please sign in to comment.