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

videojs / videojs-contrib-quality-levels

Other

154 stars 52 forks source link

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

Closed gjanblaszczyk closed 1 year ago

gjanblaszczyk commented 1 year ago

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

[x] Feature implemented / Bug fixed
[x] 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 commented 1 year ago

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

gkatsev commented 1 year ago

@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 commented 1 year ago

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

gkatsev commented 1 year ago

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

gjanblaszczyk commented 1 year ago

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

codecov[bot] commented 1 year ago

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%)`	:arrow_up:
src/plugin.js	`100.00% <100.00%> (+68.75%)`	:arrow_up:

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