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

BREAKING(path/unstable): move unstable overload of dirname to unstable-dirname #5954

Merged
merged 4 commits into from
Sep 12, 2024

Conversation

kt3k
Copy link
Member

@kt3k kt3k commented Sep 12, 2024

part of #5920

This PR moves the 2nd overload of dirname functions to ./unstable-dirname.

Unstable versions of dirname functions are only available from unstable-dirname, posix/unstable-dirname, or windows/unstable-dirname.

If this looks fine, I'll work on the rest of items in @std/path

Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.32%. Comparing base (b900e72) to head (0c53a61).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5954   +/-   ##
=======================================
  Coverage   96.31%   96.32%           
=======================================
  Files         483      484    +1     
  Lines       39402    39403    +1     
  Branches     5839     5837    -2     
=======================================
+ Hits        37952    37956    +4     
+ Misses       1408     1405    -3     
  Partials       42       42           

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

_tools/check_docs.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@iuioiua iuioiua left a comment

Choose a reason for hiding this comment

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

Nicely done

Copy link
Contributor

@iuioiua iuioiua left a comment

Choose a reason for hiding this comment

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

Wait, we should suggest to use the unstable APIs in the stable API's documentation.

path/dirname.ts Outdated
* }
* ```
* Note: If you are working with file URLs,
* use `dirname` from `@std/path/unstable-dirname`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This suggests that the unstable API will one day become the stable API. Ditto for the other functions.

Suggested change
* use `dirname` from `@std/path/unstable-dirname`.
* use the new version of `dirname` from `@std/path/unstable-dirname`.

Copy link
Contributor

@iuioiua iuioiua left a comment

Choose a reason for hiding this comment

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

Nice. We really should document our new convention for unstable modules somewhere.

@kt3k kt3k merged commit d1f5a36 into denoland:main Sep 12, 2024
16 checks passed
@kt3k kt3k deleted the breaking-move-unstable-dirname branch September 12, 2024 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants