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.

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

External contributors cannot install packages without our FontAwesome Pro key #74

Open
robere2 opened this issue Apr 6, 2024 · 1 comment
Labels
Complexity: HIGH This issue may require in-depth knowledge of module features and require significant testing Module: UI This issue pertains to the apps/ui module Priority: MED This issue isn't critical or security-related but is holding back other issues or efficiency. Type: Bug Something isn't working

Comments

@robere2
Copy link
Member

robere2 commented Apr 6, 2024

Describe the bug
If a user attempts to run npm i in the root directory or /apps/ui directory, the installation will fail due to being unable to find the FontAwesome Pro icons packages. This is because they're stored in another package registry that requires a Pro key.

To Reproduce
Steps to reproduce the behavior:

  1. Make sure you have no .npmrc file containing the FontAwesome registry information
  2. Run npm i in the root of the project

Expected behavior
Installation should complete, and when the packages should only be imported if they are present. If using a Pro icon without Pro icons installed, the icon simply won't be visible on your device. It will still be visible on deployment.

Additional context
This may require dynamic imports, which may be a problem for tree shaking. FontAwesome is a large set of libraries (62MB for all of them currently installed). It is our largest dependency for the UI. Tree shaking may not be as critical if we have SSR, however I'm not quite sure how that works.

A temporary workaround is to remove the packages from the package.json, but this only works if they are not running the UI.

@robere2 robere2 added Priority: MED This issue isn't critical or security-related but is holding back other issues or efficiency. Type: Bug Something isn't working Module: UI This issue pertains to the apps/ui module Complexity: HIGH This issue may require in-depth knowledge of module features and require significant testing labels Apr 6, 2024
@robere2
Copy link
Member Author

robere2 commented Apr 6, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: HIGH This issue may require in-depth knowledge of module features and require significant testing Module: UI This issue pertains to the apps/ui module Priority: MED This issue isn't critical or security-related but is holding back other issues or efficiency. Type: Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant