Crate willbe

Module:: willbe

Utility to publish multi-crate and multi-workspace environments and maintain their consistency.

Basic use-case

1. Multi-Workspace Consistency: In a project setup involving multiple workspaces with shared dependencies, willbe maintains consistency. It ensures all workspaces are updated with compatible dependency versions.

2. Publishing Multi-Crate Projects: If your project structure includes multiple crates that need simultaneous publishing, willbe manages the process seamlessly. It ensures the crates are published in the right order while staying in version sync.

3. Dependency Analysis: willbe can perform a thorough analysis of your project’s dependencies, providing a detailed highlight of inconsistencies or areas that need attention.

4. Test Execution With Varied Configurations: willbe can execute tests with varying configurations, such as different combinations of crate features. This assists in ensuring comprehensive coverage of test scenarios.

5. Generate Health Table: Quickly visualize important project metrics like build status for each crate, creating a single, easy-to-read table.

6. Automating CI/CD Workflow Generation: Automatically generate a series of CI/CD operations suitable for the task at hand to enhance productivity and improve the development process.

use willbe::*;

fn main() -> Result< (), wtools::error::for_app::Error >
{
  Ok( willbe::run()? )
}

To add to your project

cargo add willbe

Try out from the repository

git clone https://github.com/Wandalen/wTools
cd wTools
cargo run --package willbe

Modules

• action
  Describes functions that can be called from an interface.
• cargo
  Interaction module with the cargo utilities.
• channel
  Rust toolchain channel: stable/nightly.
• command
  Describes CLI commands.
• entity
  Entities of which spaces consists of.
• exposed
  Exposed namespace of the module.
• features
  Operation with features
• files
  Operate over files.
• git
  Git interaction module that enables seamless integration and management of version control workflows.
• graph
  Tools for working with dependencies graph.
• manifest
  To manipulate manifest data.
• orphan
  Orphan namespace of the module.
• package
  Offers capabilities for package management, facilitating the handling and organization of packages.
• packages
  Provides a set of functionalities for handling and manipulating packages.
• packed_crate
  Handles operations related to packed Rust crates
• path
  Work with paths.
• prelude
  Prelude to use essentials: use my_module::prelude::*.
• process
  Run external processes.
• protected
  Protected namespace of the module.
• query
  The parse function parses an input string into a HashMap where the keys are String and the values are of type Value.
• sha
  Make sha-1 hash for data.
• template
  Traits and structs for templates.
• test
  Operations with tests
• tool
  Genera-purpose tools which might be moved out one day.
• url
  Tools for parsing and extracting information from url.
• version
  Provides an opportunity to work with versions.
• workspace
  It features the ability to interact with workspaces, manage their participants, and other functionalities.
• wtools
  Micro wtools

Structs

• CrateDir
  Path to crate directory
• Manifest
  Hold manifest data.
• Workspace
  Stores information about current workspace.

Functions

• deploy_renew
  Create deploy from template.
• readme_header_renew
  Generate header. Generates header to main Readme.md file.
• run
  Takes the command line arguments and perform associated function(s). If no arguments are provided, the function identifies this as an ambiguous state and prompts the user with a help message, suggesting possible commands they might want to execute. It then terminates the program with an exit code of 1 to indicate an error due to the lack of input.
• test
  run tests in specified crate run tests in specified crate
• workflow_renew
  List packages.
• workflow_renew
  Generate workflows for modules in .github/workflows directory.
• workspace_renew
  List packages.
• workspace_renew
  Creates workspace template