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

refactor: Scope package into modules #1025

Merged
merged 1 commit into from
Nov 13, 2024
Merged

refactor: Scope package into modules #1025

merged 1 commit into from
Nov 13, 2024

Conversation

susnux
Copy link
Contributor

@susnux susnux commented Jul 23, 2024 •
edited
Loading

What do you think of this idea?

This splits the package into modules:

  1. The default one (@nextcloud/files) which provides general classes to work with the Node classes we use nearly everywhere
  2. DAV utils (@nextcloud/files/dav) which provides WebDAV related utils
  3. File list related utils (actions, filters, columns)
  4. Navigation related utils
  5. General purpose small helper functions (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.

@susnux susnux added type: enhancement 🚀 New feature or request 3. to review 3️⃣ Waiting for reviews labels Jul 23, 2024
@susnux susnux requested review from skjnldsv, Pytal and ShGKme July 23, 2024 12:07
@susnux susnux added the status: needs info ❓ Further information is requested label Jul 23, 2024
@codecov Codecov
Copy link

codecov bot commented Jul 23, 2024 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 247.08kB (101.54%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name Size Change
@nextcloud/files-cjs 124.38kB 124.38kB (100%) ⬆️⚠️
@nextcloud/files-cjs-esm 122.7kB 122.7kB (100%) ⬆️⚠️

@skjnldsv skjnldsv added the type: breaking 💥 changes that require a new major version label Jul 25, 2024
@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 🚀

@susnux susnux force-pushed the scope-package branch 2 times, most recently from 1b1106b to d9b9fb6 Compare October 30, 2024 17:59
@codecov Codecov
Copy link

codecov bot commented Oct 30, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 90.90909% with 1 line in your changes missing coverage. Please review.

Project coverage is 91.77%. Comparing base (7a25265) to head (781517b).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
lib/dav/dav.ts 85.71% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1025   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files          23       23           
  Lines         632      632           
  Branches      166      166           
=======================================
  Hits          580      580           
  Misses         45       45           
  Partials        7        7

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

@susnux susnux force-pushed the scope-package branch 2 times, most recently from 0cec312 to 6a280a9 Compare November 13, 2024 12:35
@susnux
refactor: Scope package into modules
781517b 
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 linked an issue Nov 13, 2024 that may be closed by this pull request
RFC: Restructure package into modules #1015
Closed
@susnux susnux merged commit 056e208 into main Nov 13, 2024
17 of 18 checks passed
@susnux susnux deleted the scope-package branch November 13, 2024 13:51
@susnux susnux removed the type: breaking 💥 changes that require a new major version label Nov 13, 2024
@susnux susnux mentioned this pull request Nov 13, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skjnldsv skjnldsv skjnldsv approved these changes

@Pytal Pytal Awaiting requested review from Pytal

@ShGKme ShGKme Awaiting requested review from ShGKme

Assignees
No one assigned
Labels
3. to review 3️⃣ Waiting for reviews status: needs info ❓ Further information is requested type: enhancement 🚀 New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

RFC: Restructure package into modules
2 participants
@susnux @skjnldsv