fix(package): moves yoga-icons dep to peer dependencies

[rafael-rollo]

Description 📄

This PR only proposes making the dependency on @gympass/yoga-icons a peer dependency in @gympass/yoga.

Since client applications generally tend to depend directly on the @gympass/yoga-icons package, its presence as a direct dependency on the @gympass/yoga package often causes the application to have dependency duplication problems. In many cases, package managers such as Yarn do not resolve the conflict (see duplicate package errors) even by running deduplication programs, which can be problematic for optimizing the js bundle.

Below is evidence collected from initiatives in the Wellhub app.

Platforms 📲

• Web
• Mobile

Type of change 🔍

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
  • Maybe to clarify the need to install the icons package alongside yoga?

How Has This Been Tested? 🧪

• Unit Test
• Snapshot Test
• By solving dependency duplicates in a client app

Checklist: 🔍

• My code follows the contribution guide of this project Contributing Guide
• Layout matches design prototype: FIGMA
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules
• I have checked my code and corrected any misspellings

Screenshots 📸

• After dedupe with yoga-icons base dependency pointing to a version lower than the yoga sub-dependency:

error @gympass/yoga-icons (found 4 copies)
warn   0.9.0 end-user-native/node_modules/@gympass/yoga-old/node_modules/@gympass/yoga-icons
warn   1.23.1 end-user-native/node_modules/@gympass/yoga-icons
warn   1.26.0 end-user-native/node_modules/@gympass/yoga/node_modules/@gympass/yoga-icons
warn   1.26.0 end-user-native/node_modules/@yoga-inner/native/node_modules/@gympass/yoga-icons

• After dedupe with yoga-icons base dependency pointing to a greater version

> deduplication solved 2 copies

• After moving to peerDependencies

> no duplication risk

[wellhub-gsevla]

Besides my comment about the optional flag, I think you are absolutely right. Well done!

[sonarqubecloud]

Quality Gate passed

Issues
423 New issues
9 Accepted issues

Measures
0 Security Hotspots
83.2% Coverage on New Code
1.3% Duplication on New Code

See analysis details on SonarQube Cloud