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!: v1.0.0 - API breaking changes #201

Merged
merged 15 commits into from
Mar 4, 2023
Merged

feat!: v1.0.0 - API breaking changes #201

merged 15 commits into from
Mar 4, 2023

Conversation

shortcuts
Copy link
Owner

@shortcuts shortcuts commented Feb 27, 2023

📃 Summary

This PR introduces the v1.0.0 of the plugin, which comes with several breaking changes at the API level.

The plugin evolved fast but some part of the API are not extensible enough to continue the iteration, this much needed breaking change allow future features to be added without having to break the it again.


Breaking changes

Before After
enableOnVimEnter autocmds.enableOnVimEnter
enableOnTabEnter autocmds.enableOnTabEnter
toggleMapping mappings.toggle
widthUpMapping mappings.widthUp
widthDownMapping mappings.widthDown
backgroundColor colors.background
textColor colors.text
blend colors.blend
left.backgroundColor left.colors.background
left.textColor left.colors.text
left.blend left.colors.blend
right.backgroundColor right.colors.background
right.textColor right.colors.text
right.blend right.colors.blend

  • add warning for all the following deprecation changes
  • group all mappings under a dedicated object
    • disable mappings by default to prevent impacting other users workflow
    • set default values when enabled
  • group all colors under a dedicated object
    • global to both buffers
    • for each side buffer
  • group all autocmds under a dedicated object
  • more documentation with type definitions
  • ensure all tests passes
  • update README.md

@shortcuts shortcuts self-assigned this Feb 27, 2023
@shortcuts shortcuts marked this pull request as ready for review March 4, 2023 23:44
@shortcuts shortcuts merged commit 2b6cb3c into main Mar 4, 2023
@shortcuts shortcuts deleted the next branch March 4, 2023 23:45
shortcuts added a commit that referenced this pull request Mar 4, 2023
🤖 I have created a release *beep* *boop*
---


##
[1.0.0](v0.10.2...v1.0.0)
(2023-03-04)


### ⚠ BREAKING CHANGES

* v1.0.0 - API breaking changes
([#201](#201))

### Features

* v1.0.0 - API breaking changes
([#201](#201))
([2b6cb3c](2b6cb3c))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
krmbzds added a commit to krmbzds/nvim that referenced this pull request Mar 5, 2023
krmbzds added a commit to krmbzds/nvim that referenced this pull request Mar 5, 2023
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.

None yet

1 participant