Skip to content

refactor: remove exports from package.json and adjust imports#793

Merged
JamieSlome merged 1 commit intofinos:mainfrom
06kellyjac:remove_exports
Nov 14, 2024
Merged

refactor: remove exports from package.json and adjust imports#793
JamieSlome merged 1 commit intofinos:mainfrom
06kellyjac:remove_exports

Conversation

@06kellyjac
Copy link
Copy Markdown
Contributor

Exports makes it hard to access other paths in the project
Until we arrive on stable interfaces to access other parts of git-proxy
removing exports would be helpful.
Import paths have been adjusted slightly for plugins and the docs for
plugins due to the exports aliases being a bit different.

@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 13, 2024

Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Name Link
🔨 Latest commit c5d200d
🔍 Latest deploy log https://app.netlify.com/sites/endearing-brigadeiros-63f9d0/deploys/6734d77141849400089507e6

@JamieSlome
Copy link
Copy Markdown
Member

Seeing as we'd be breaking import statements, we'll make a minor bump to v1.6.0 if we proceed 👍

Exports makes it hard to access other paths in the project
Until we arrive on stable interfaces to access other parts of git-proxy
removing exports would be helpful.
Import paths have been adjusted slightly for plugins and the docs for
plugins due to the exports aliases being a bit different.
@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.11%. Comparing base (dd5d692) to head (c5d200d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #793   +/-   ##
=======================================
  Coverage   63.11%   63.11%           
=======================================
  Files          47       47           
  Lines        1678     1678           
=======================================
  Hits         1059     1059           
  Misses        619      619           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@06kellyjac
Copy link
Copy Markdown
Contributor Author

Running into some blockers due to the exports still which are quite painful.
The hope is to drop this for now until we have some stabilized interfaces.

This does break some import paths because the exports were slightly different to the actual file paths.
This change is pretty trivial to fix so I think we can take the hit without bumping major.
Docs have been updated to match.

Copy link
Copy Markdown
Member

@JamieSlome JamieSlome left a comment

Choose a reason for hiding this comment

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

LGTM! 🍰

Copy link
Copy Markdown
Contributor

@coopernetes coopernetes left a comment

Choose a reason for hiding this comment

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

Agreed with the points raised here. exports can be re-introduced in a later release.

Need update the plugin docs as well once this is released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants