Skip to content
Browse files

Make backwards compatibility explicit

  • Loading branch information...
1 parent 018fc71 commit a744d4c5f0c6086251aab66ec68cb9299869b1e9 @xolox committed Apr 20, 2013
Showing with 25 additions and 0 deletions.
  1. +2 −0
  2. +23 −0 compat.vim
@@ -27,6 +27,8 @@ Regardless of the inclusion strategies discussed above, my current scheme has a
This means that when I break compatibility in the miscellaneous scripts, I have to make sure to merge the changes into all of my plug-ins. Even then, if a user has more than one of my plug-ins installed but updates only one of them, the other plug-ins (that are not yet up to date) can break (because of the backwards incompatible change).
+The `xolox#misc#compat#check()` function makes sure that incompatibilities are detected early so that the user knows which plug-in to update if incompatibilities arise.
## Contact
If you have questions, bug reports, suggestions, etc. the author can be contacted at <>. The latest version is available at <> and <>.
23 compat.vim
@@ -0,0 +1,23 @@
+" Vim auto-load script
+" Author: Peter Odding <>
+" Last Change: April 20, 2013
+" URL:
+" The following integer will be bumped whenever a change in the miscellaneous
+" scripts breaks backwards compatibility. This enables my Vim plug-ins to fail
+" early when they detect an incompatible version, instead of breaking at the
+" worst possible moments :-).
+let g:xolox#misc#compat#version = 1
+" Remember the directory where the miscellaneous scripts are loaded from
+" so the user knows which plug-in to update if incompatibilities arise.
+let s:misc_directory = fnamemodify(expand('<sfile>'), ':p:h')
+function! xolox#misc#compat#check(plugin_name, required_version)
+ if a:required_version != g:xolox#misc#compat#version
+ let msg = "The %s plug-in requires version %i of the miscellaneous scripts, however version %i was loaded from %s!"
+ throw printf(msg, a:plugin_name, a:required_version, g:xolox#misc#compat#version, s:misc_directory)
+ endif
+" vim: ts=2 sw=2 et

0 comments on commit a744d4c

Please sign in to comment.
Something went wrong with that request. Please try again.