Module cargo_culture_kit::rules[−][src]

Provides the Rule trait and several implementations, available through the default_rules() function.

Structs

BuildsCleanlyWithoutWarningsOrErrors	Rule that asserts a good Rust project: "Should `cargo clean` and `cargo build` without any warnings or errors."
CargoMetadataReadable	Rule that asserts a good Rust project: "Should have a well-formed Cargo.toml file readable by `cargo metadata`"
HasContinuousIntegrationFile	Rule that asserts a good Rust project: "Should have a file suggesting the use of a continuous integration system."
HasContributingFile	Rule that asserts a good Rust project: "Should have a CONTRIBUTING file in the project directory."
HasLicenseFile	Rule that asserts a good Rust project: "Should have a LICENSE file in the project directory."
HasReadmeFile	Rule that asserts a good Rust project: "Should have a README.md file in the project directory."
HasRustfmtFile	Rule that asserts a good Rust project: "Should have a rustfmt.toml file in the project directory."
PassesMultipleTests	Rule that asserts a good Rust project: "Should have multiple tests which pass."
RuleContext	Parameter struct for the `Rule::evaluate` method. Should provide the minimum information necessary for project-level quality and completeness checks to be run.
UnderSourceControl	Rule that asserts a good Rust project: "Should be under source control"
UsesPropertyBasedTestLibrary	Rule that asserts a good Rust project: "Should be making an effort to use property based tests."

The result of a Rule.evaluate call.

Rule	The core trait of this crate. A `Rule` describes an idiom or best-practice for projects and provides a means of evaluating whether that rule of thumb is being upheld.

Constructs new instances of the default Rules recommended as a starting point by the project maintainers.