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

refactor: Scope package into modules #1025

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor: Scope package into modules #1025

wants to merge 1 commit into from

Conversation

susnux
Copy link
Contributor

@susnux susnux commented Jul 23, 2024

What do you think of this idea?


This splits the package into two modules:

  1. The default one (@nextcloud/files) which provides general utils to work with files or the files app
  2. DAV utils (@nextcloud/files/dav) which provides WebDAV related utils

For legacy reasons to not make this a breaking release the DAV utils are exported with their prefixed names in the default module, but this will be then removed with the next major version.

This splits the package into two modules:
1. The default one (`@nextcloud/files`) which provides general utils to work with files or the files app
2. DAV utils (`@nextcloud/files/dav`) which provides WebDAV related utils

For legacy reasons to not make this a breaking release the DAV utils are exported with their prefixed names in the default module,
but this will be then removed with the next major version.

Signed-off-by: Ferdinand Thiessen <[email protected]>
@susnux susnux added enhancement New feature or request 3. to review labels Jul 23, 2024
@susnux susnux requested review from skjnldsv, Pytal and ShGKme July 23, 2024 12:07
@susnux susnux added the question Further information is requested label Jul 23, 2024
Copy link

codecov bot commented Jul 23, 2024

Bundle Report

Changes will increase total bundle size by 3.67kB ⬆️

Bundle name Size Change
@nextcloud/files-cjs 101.62kB 101.62kB ⬆️
@nextcloud/files-cjs-esm 100.09kB 100.09kB ⬆️
@nextcloud/files-esm (removed) 98.4kB ⬇️
@nextcloud/files-esm-cjs (removed) 99.63kB ⬇️

@skjnldsv
Copy link
Contributor

I would still prefer do a breaking release and push this for nc 31 and above? :)

@susnux
Copy link
Contributor Author

susnux commented Jul 25, 2024

I would still prefer do a breaking release and push this for nc 31 and above? :)

Sure I just wanted to make it non breaking so we might can keep compatible library versions longer for NC releases.
But if you prefer to do this directly breaking, then I can adjust the PR :)

@skjnldsv
Copy link
Contributor

But if you prefer to do this directly breaking, then I can adjust the PR :)

I personally don't mind both.
I'll leave it up to you, if keeping it backward compatible is more maintenance pain, then let's just make a new major. If you think it's not too much work, let's make it a minor then 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review breaking enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants