Expand description
§vcsq lib: Version Control System (VCS) Querying Library
Couple wrapping traits to encompass simple questions you might ask of any common VCS,
regardless of its branding. Also some default implementations are exposed in this crate. The
intention is to make it easier to build tools that need to answer the simple questions about a
Version Control System (VCS) repository. For example, see vcsq-cli crate.
Jargon used in this library:
- “brand” of VCS is some concrete repo format (eg: “Git” or “Mercurial” are brands).
- “driver” or “adapter” is an object that can answer queries about on particular brand.
- eg: see the
repo::Driverandrepo::Validatortraits that every adapter must implement.
- eg: see the
See vcsq repo for more: https://gitlab.com/jzacsh/vcsq
Modules§
- adapter
- Concrete implementations of a handful of VCS brands.
- plexer
- Special pseudo-adapter of a repo that itself just demultiplexes all queries out to concrete
drivers (see
adaptermod) of each brand of VCS that this library ships with support for. - repo
- Defines basics outline of a VCS repo and the queries vcsq is meant to handle. Provides the traits any driver a particular brand of VCS must implement.