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

feat: deprecate mergeOptions() and use merge() instead #138

Merged
merged 11 commits into from
Mar 31, 2023

Conversation

gjanblaszczyk
Copy link
Member

Description

The video.js mergeOptions() function is deprecated. The plugin should use videojs.obj.merge() function.

Specific Changes proposed

  • remove videojs.mergeOptions() and use videojs.obj.merge() instead
  • fix js-doc warnings
  • remove old videojs.plugin

Requirements Checklist

  • Feature implemented / Bug fixed
  • If necessary, more likely in a feature request than a bug fix
    • Unit Tests updated or fixed
    • Docs/guides updated
  • Reviewed by Two Core Contributors

@gjanblaszczyk gjanblaszczyk requested a review from gkatsev October 4, 2022 15:59
@gjanblaszczyk
Copy link
Member Author

Maybe I should also update video.js version in package.json from "6 | 7" to "8". @gkatsev any thoughts?

@gkatsev
Copy link
Member

gkatsev commented Oct 4, 2022

@gjanblaszczyk I was just thinking about this that this would be a breaking change but maybe not an issue. Yeah, if we want to keep it as a breaking change, we should update the package.json. Alternative is to use videojs.obj.merge if available and otherwise use videojs.mergeOptions().

@gjanblaszczyk
Copy link
Member Author

@gkatsev I removed v6 from package.json. Is that fine? or maybe It is still needed...

@gkatsev
Copy link
Member

gkatsev commented Oct 4, 2022

Yeah, that would work, though, technically still a breaking change.

Copy link
Member

@misteroneill misteroneill left a comment

Choose a reason for hiding this comment

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

Yeah, let's just do a breaking change here. @gjanblaszczyk would you mind making this compatible with ^8 only and removing the mergeOptions fallback?

Let's keep it simple!

package.json Outdated Show resolved Hide resolved
@gjanblaszczyk
Copy link
Member Author

@misteroneill Sure, I don't have a problem with that. I have just updated the PR. Does it look fine?

@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Merging #138 (1174c63) into main (81d2293) will increase coverage by 17.22%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##             main     #138       +/-   ##
===========================================
+ Coverage   77.77%   95.00%   +17.22%     
===========================================
  Files           3        3               
  Lines          81       80        -1     
  Branches        8        7        -1     
===========================================
+ Hits           63       76       +13     
+ Misses         18        4       -14     
Impacted Files Coverage Δ
src/quality-level-list.js 100.00% <ø> (+6.00%) ⬆️
src/plugin.js 100.00% <100.00%> (+68.75%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants