Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Remove unnecessary peer dependencies from Feast UI #4577

Merged
merged 2 commits into from
Sep 26, 2024
Merged

fix: Remove unnecessary peer dependencies from Feast UI #4577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20cff55
fix: Remove unnecessary peer dependencies from Feast UI
peruukki Sep 26, 2024
3ec94ca
docs: Update Feast UI peer dependency documentation
peruukki Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/reference/alpha-web-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,14 @@ Start with bootstrapping a React app with `create-react-app`
npx create-react-app your-feast-ui
```

Then, in your app folder, install Feast UI and its peer dependencies. Assuming you use yarn
Then, in your app folder, install Feast UI and optionally its peer dependencies. Assuming you use yarn

```
yarn add @feast-dev/feast-ui
yarn add @elastic/eui @elastic/datemath @emotion/react moment prop-types inter-ui react-query react-router-dom use-query-params zod typescript query-string d3 @types/d3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove all of these?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are no longer in the peer dependencies, so there's no need to install them anymore, at least not for Feast UI to work.

Copy link
Contributor Author

@peruukki peruukki Sep 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So these are now considered internal dependencies of Feast UI, mostly irrelevant for apps using it as a module. They are still included in Feast UI's dependencies, so they get installed automatically with it.

# For custom UI using the Elastic UI Framework (optional):
yarn add @elastic/eui
# For general custom styling (optional):
yarn add @emotion/react
```

Edit `index.js` in the React app to use Feast UI.
Expand Down
7 changes: 5 additions & 2 deletions ui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,14 @@ Start with bootstrapping a React app with `create-react-app`
npx create-react-app your-feast-ui
```

Then, in your app folder, install Feast UI and its peer dependencies. Assuming you use yarn
Then, in your app folder, install Feast UI and optionally its peer dependencies. Assuming you use yarn

```
yarn add @feast-dev/feast-ui
yarn add @elastic/eui @elastic/datemath @emotion/react moment prop-types inter-ui react-query react-router-dom use-query-params zod typescript query-string d3 @types/d3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question, shouldn't these go below in optional?

# For custom UI using the Elastic UI Framework (optional):
yarn add @elastic/eui
# For general custom styling (optional):
yarn add @emotion/react
```

Edit `index.js` in the React app to use Feast UI.
Expand Down
21 changes: 9 additions & 12 deletions ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,18 @@
"types": "./dist/FeastUI.d.ts",
"module": "./dist/feast-ui.module.js",
"peerDependencies": {
"@elastic/datemath": "^5.0.3",
"@elastic/eui": "^55.0.1",
"@emotion/react": "^11.7.1",
"d3": "^7.3.0",
"inter-ui": "^3.19.3",
"moment": "^2.29.1",
"prop-types": "^15.8.1",
"query-string": "^7.1.1",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-query": "^3.34.12",
"react-router-dom": "<6.4.0",
"react-scripts": "^5.0.0",
"use-query-params": "^1.2.3",
"zod": "^3.11.6"
"react-dom": "^17.0.2"
},
"peerDependenciesMeta": {
"@elastic/eui": {
"optional": true
},
"@emotion/react": {
"optional": true
}
},
"dependencies": {
"@elastic/datemath": "^5.0.3",
Expand Down
Loading