Crate version_control_clean_check

version-control-clean-check

Checks the status of the version control system. Based on cargo’s check_version_control. In cargo it is used as a safety check before possibly destructive changes are done like running cargo fix.

Feature Flags

• clap - Provides clap derives for the options struct

Display Messages for Errors

Display messages for errors are meant to be human readable and as such are not considered a breaking change if they are changed for clarity.

Tests

The test create a folder inside of tests/ and sets up sub folders as expected by the tests. The setup process is skipped if the sub folder already exists. It does not check if the folder is setup properly but instead just ASSUMES that it is correct. If you are unsure if the sub folders are setup correctly simply remove tests/test_folders and it will be recreated correctly when the tests are run.

NB: The folder is not deleted upon completion of the tests but is instead left behind for reuse.

License

All code in this repository is dual-licensed under either:

• Apache License, Version 2.0
• MIT license

at your option. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are very good reasons to include both as noted in this issue on Bevy’s repo.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Sample Code

use version_control_clean_check::{CheckOptions, check_version_control};
let mut opts = CheckOptions::new();
opts.allow_no_vcs = true; // Disable actual checks for example
let actual = check_version_control("path_here", &opts);
assert!(actual.is_ok());

Structs

CheckOptions

Stores the options available for calling check_version_control and controls which checks if any are run

Enums

VCSError

Enumerates the possible error values that can be generated by this crate

Functions

check_version_control

Based on the CheckOptions passed it does test on the version control at path. See CheckOptions for more details on what checks do and don’t get run depending on what is passed

Type Aliases

VCSResult

Type alias for Result<T, VCSError>