The title at https://github.com/guard/guard-compat/ is "Test helper for testing Guard plugins", and the first line of the README.md is:
Currently, provides only a test helper for testing custom Guard plugins.
... but then it goes on to include sections such as "Migrating your API calls", which are apparently not specific to testing guard plugins. And there is no explanation why any plugin author would want or need to migrate API calls. Maybe I'm being stupid, but I have been hacking on several Guard plugins sporadically for several years, and despite being fairly far from a Guard newbie I'm a bit confused by this.
I would normally assume that any module/gem/plugin with compat in the name would exist solely to provide a compatibility layer, so that consumers of older APIs would still work. This is a standard development pattern, which has the goal of eventually dropping the deprecated APIs, and the corresponding compatibility layer. But the => arrows in this section seem to suggest the opposite, i.e. that Guard::Compat::* are the recommended APIs, and https://github.com/guard/guard-compat/blob/master/lib/guard/compat/example.rb seems to corroborate this.
So please can we clarify which are the new APIs and which are the old APIs, and when/why guard-compat should be used? For example it seems strange for what is apparently a canonical example of a guard plugin implementation (also corroborated by Create a guard) to live in a compat repository rather than the main repository.
Thanks a lot!
The title at https://github.com/guard/guard-compat/ is "Test helper for testing Guard plugins", and the first line of the README.md is:
... but then it goes on to include sections such as "Migrating your API calls", which are apparently not specific to testing guard plugins. And there is no explanation why any plugin author would want or need to migrate API calls. Maybe I'm being stupid, but I have been hacking on several Guard plugins sporadically for several years, and despite being fairly far from a Guard newbie I'm a bit confused by this.
I would normally assume that any module/gem/plugin with
compatin the name would exist solely to provide a compatibility layer, so that consumers of older APIs would still work. This is a standard development pattern, which has the goal of eventually dropping the deprecated APIs, and the corresponding compatibility layer. But the=>arrows in this section seem to suggest the opposite, i.e. thatGuard::Compat::*are the recommended APIs, and https://github.com/guard/guard-compat/blob/master/lib/guard/compat/example.rb seems to corroborate this.So please can we clarify which are the new APIs and which are the old APIs, and when/why
guard-compatshould be used? For example it seems strange for what is apparently a canonical example of a guard plugin implementation (also corroborated by Create a guard) to live in acompatrepository rather than the main repository.Thanks a lot!