Crate willbe

source ·
Expand description

§Module:: willbe

experimental rust-status docs.rs discord

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

§Purpose

  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.

§To install

cargo install willbe
will .

§Try out from the repository

git clone https://github.com/Wandalen/wTools
cd wTools/module/move/willbe
cargo install --path .
will .

Modules§

  • action
    Describes functions that can be called from an interface.
  • attr
    Attributes analyzys and manipulation.
  • attr_prop
    Attribute’s properties. Reuse them to define how to parse properties of an attribute.
  • bmap
    std::collections::BTreeMap macros
  • bset
    std::collections::BTreeSet macros
  • cargo
    Interaction module with the cargo utilities.
  • channel
    Rust toolchain channel: stable/nightly.
  • code
    Source code.
  • collection
    Function and structures to work with collections.
  • command
    Describes CLI commands.
  • components
    Type-based assigning.
  • container_kind
    Determine kind of a container.
  • ct
    Compile-time tools.
  • dependency
    Dependency of a package.
  • deque
    std::collections::VecDeque macros
  • derive
    Macro helpers around derive macro and structure syn::DeriveInput.
  • diag
    Macro helpers.
  • diff
    Compare two crate archives and create a difference report.
  • dlist
    Vec macros
  • entity
    Entities of which spaces consists of.
  • equation
    Attributes analyzys and manipulation.
  • error
    Errors handling.
  • exposed
    Exposed namespace of the module.
  • features
    Operation with features
  • files
    Paths and files.
  • generic_args
    This module provides utilities to handle and manipulate generic arguments using the syn crate. It includes traits and functions for transforming, merging, and managing generic parameters within procedural macros, enabling seamless syntactic analysis and code generation.
  • generic_params
    Functions and structures to handle and manipulate generic parameters using the syn crate. It’s designed to support macro-driven code generation by simplifying, merging, extracting, and decomposing syn::Generics.
  • git
    Git.
  • graph
    Tools for working with dependencies graph.
  • hmap
    std::collections::HashMap macros
  • hset
    std::collections::HashSet macros
  • http
    Http requests.
  • item
    This module provides various utilities and namespaces for working with syn::Item, specifically focusing on ensuring syntactical correctness and managing different visibility levels within the code. It includes functions to manipulate the structure of items, handle different kinds of fields, and provide a structured approach to organizing the codebase into different access levels.
  • item_struct
    Parse structures, like struct { a : i32 }.
  • iter
    Iterating things.
  • kw
    Keywords
  • llist
    std::collections::LinkedList macros
  • macros
    Work with paths.
  • manifest
    To manipulate manifest data.
  • name
    Tait to getn name of an Item.
  • optimization
    Rust build optimization: debug/release
  • orphan
    Orphan namespace of the module.
  • own
    Own namespace of the module.
  • package
    Offers capabilities for package management, facilitating the handling and organization of packages.
  • package_md_extension
    Md’s extension for workspace.
  • packages
    Provides a set of functionalities for handling and manipulating packages.
  • packed_crate
    Handles operations related to packed Rust crates
  • path
    Work with paths.
  • phantom
    Responsible for generating marker PhantomData fields to avoid the rule requiring the usage of all generic parameters in a struct. This is often necessary to ensure that Rust’s type system correctly tracks the ownership and lifetimes of these parameters without needing them to be explicitly used in the struct’s fields.
  • prelude
    Prelude to use essentials: use my_module::prelude::*.
  • proc_macro2
    github crates-io docs-rs
  • progress_bar
    Progress bar staff.
  • publish
    Publish.
  • punctuated
    Structures and functions for handling syn::punctuated::Punctuated collections.
  • quantifier
    Quantifiers like Pair and Many.
  • query
    The parse function parses an input string into a HashMap where the keys are String and the values are of type Value.
  • quote
    github crates-io docs-rs
  • repository
    Repository tools.
  • struct_like
    Parse structures, like struct { a : i32 }.
  • syn
    github crates-io docs-rs
  • table
    Facade for preatytable crate.
  • template
    Traits and structs for templates.
  • test
    Operations with tests
  • thiserror
    github crates-io docs-rs
  • tokens
    Attributes analyzys and manipulation.
  • tool
    Genera-purpose tools which might be moved out one day.
  • tree
    Tools for printing a tree
  • typ
    Advanced syntax elements.
  • typed
    Typed parsing.
  • 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.
  • workspace_graph
    Workspace’ graph.
  • workspace_md_extension
    Md’s extension for workspace.
  • workspace_package
    Packages of workspace.

Macros§

  • Token
    A type-macro that expands to the name of the Rust type representation of a given token.
  • bmap
    Creates a BTreeMap from a list of key-value pairs.
  • braced
    Parse a set of curly braces and expose their content to subsequent parsers.
  • bracketed
    Parse a set of square brackets and expose their content to subsequent parsers.
  • bset
    Creates a BTreeSet from a list of elements.
  • code_diagnostics_str
    Macro for diagnostics purpose to diagnose source code behind it and export it into a string.
  • code_print
    Macro for diagnostics purpose to print both syntax tree and source code behind it without syntax tree.
  • code_to_str
    Macro to export source code behind a syntax tree into a string.
  • custom_keyword
    Define a type that supports parsing and printing a given identifier as if it were a keyword.
  • custom_punctuation
    Define a type that supports parsing and printing a multi-character symbol as if it were a punctuation token.
  • debug_assert_id
    Macro asserts that two expressions are identical to each other. Unlike std::assert_eq it is removed from a release build.
  • debug_assert_identical
    Macro asserts that two expressions are identical to each other. Unlike std::assert_eq it is removed from a release build. Alias of debug_assert_id.
  • debug_assert_ni
    Macro asserts that two expressions are not identical to each other. Unlike std::assert_eq it is removed from a release build.
  • debug_assert_not_identical
    Macro asserts that two expressions are not identical to each other. Unlike std::assert_eq it is removed from a release build.
  • deque
    Creates a VecDeque from a list of elements.
  • dlist
    Creates a Vec from a list of elements.
  • err
    Macro to generate an error descriptor.
  • format_ident
    Formatting macro for constructing Idents.
  • hmap
    Creates a HashMap from a list of key-value pairs.
  • hset
    Creates a HashSet from a list of elements.
  • into_bmap
    Creates a BTreeMap from a list of key-value pairs.
  • into_bset
    Creates a BTreeSet from a list of elements.
  • into_dlist
    Creates a Vec from a list of elements.
  • into_hmap
    Creates a HashMap from a list of key-value pairs.
  • into_hset
    Creates a HashSet from a list of elements.
  • into_llist
    Creates a LinkedList from a llist of elements.
  • into_vec
    Creates a Vec from a list of elements.
  • into_vecd
    Creates a VecDeque from a list of elements.
  • llist
    Creates a LinkedList from a llist of elements.
  • mod_interface
    Protocol of modularity unifying interface of a module and introducing layers.
  • parenthesized
    Parse a set of parentheses and expose their content to subsequent parsers.
  • parse_macro_input
    Parse the input TokenStream of a macro, triggering a compile error if the tokens fail to parse.
  • parse_qt
    Quasi-quotation macro that accepts input like the quote! macro but uses type inference to figure out a return type for those tokens.
  • parse_qt_spanned
    This macro is parse_quote! + quote_spanned!.
  • parse_quote
    Quasi-quotation macro that accepts input like the quote! macro but uses type inference to figure out a return type for those tokens.
  • parse_quote_spanned
    This macro is parse_quote! + quote_spanned!.
  • qt
    The whole point.
  • quote
    The whole point.
  • quote_spanned
    Same as quote!, but applies a given span to all tokens originating within the macro invocation.
  • return_err
    Macro to return an Err( error ) generating error descriptor.
  • return_syn_err
    Macro to generate syn error either with span of a syntax tree element or with default one proc_macro2::Span::call_site().
  • syn_err
    Macro to generate syn error either with span of a syntax tree element or with default one proc_macro2::Span::call_site().
  • tree_diagnostics_str
    Macro for diagnostics purpose to export both syntax tree and source code behind it into a string.
  • tree_print
    Macro for diagnostics purpose to print both syntax tree and source code behind it with syntax tree.

Structs§

Enums§

  • DependencyKind
    Dependencies can come in three kinds
  • Diff
    A type returned by the diff_with function.
  • Either
    The enum Either with variants Left and Right is a general purpose sum type with two cases.
  • EitherOrBoth
    Value that either holds a single A or B, or both.
  • FoldWhile
    An enum used for controlling the execution of fold_while.
  • MinMaxResult
    MinMaxResult is an enum returned by minmax.
  • Package
    Represents different types of packages in a Cargo workspace.
  • PathError
    PathError enum represents errors when creating a CrateDir object.
  • Position
    The first component of the value yielded by WithPosition. Indicates the position of this element in the iterator results.
  • WorkspaceInitError
    Represents errors related to workspace operations.

Traits§

  • AsCode
    A trait for converting an object to its code representation.
  • AsMuchAsPossibleNoDelimiter
    Marker saying how to parse several elements of such type in a row.
  • Assign
    Provides a generic interface for setting a component of a certain type on an object.
  • AssignWithType
    The AssignWithType trait provides a mechanism to set a component on an object, utilizing the type information explicitly. This trait extends the functionality of Assign by allowing implementers to specify the component’s type at the method call site, enhancing expressiveness in code that manipulates object states.
  • AttributeComponent
    Trait for components of a structure aggregating attributes that can be constructed from a meta attribute.
  • AttributePropertyComponent
    Trait for properties of an attribute component that can be identified by a keyword.
  • BTreeMapExt
    Provides an extension method for hash maps to facilitate the use of the builder pattern.
  • BTreeSetExt
    Provides an extension method for binary tree sets to facilitate the use of the builder pattern.
  • BinaryHeapExt
    Provides an extension method for binary heaps to facilitate the use of the builder pattern.
  • CodeItems
    A trait for retrieving an iterator over items of a source file.
  • Collection
    Represents a collection by defining the types of entries and values it handles.
  • CollectionAdd
    Provides functionality to add individual entries to a collection.
  • CollectionAssign
    Defines the capability to replace all entries in a collection with a new set of entries.
  • CollectionValToEntry
    Provides a mechanism for transforming a value back into a collection-specific entry format.
  • EntityToDefinition
    Maps a type of entity to its corresponding former definition. This trait provides a linkage between the entity and its definition, allowing the formation logic to understand what definition to apply during the formation process.
  • EntityToDefinitionTypes
    Provides a mapping between a type of entity and its associated formation type definitions.
  • EntityToFormer
    Maps a type of entity to its corresponding former. This trait binds an entity type to a specific former, facilitating the use of custom formers in complex formation scenarios.
  • EntityToStorage
    Maps a type of entity to its storage type. This trait defines what storage structure is used to hold the interim state of an entity during its formation.
  • Entries
    A trait that defines a method for retrieving an iterator over entries.
  • EntryToVal
    Facilitates the conversion of collection entries to their corresponding value representations.
  • ErrWith
    This trait allows adding extra context or information to an error, creating a tuple of the additional context and the original error. This is particularly useful for error handling when you want to include more details in the error without losing the original error value.
  • ErrorTrait
    Error is a trait representing the basic expectations for error values, i.e., values of type E in Result<T, E>.
  • FormerBegin
    A trait for initiating a structured subforming process with contextual and intermediary storage linkage.
  • FormerDefinition
    Expands on FormerDefinitionTypes by incorporating an ending mechanism for the formation process. This trait connects the formation types with a specific endpoint, defining how the formation process concludes, including any necessary transformations or validations.
  • FormerDefinitionTypes
    Defines the fundamental components involved in the formation of an entity. This trait specifies the types of storage, the formed entity, and the context used during the formation process.
  • FormerMutator
    Provides a mechanism for mutating the context and storage just before the forming process is completed.
  • FormingEnd
    Defines a handler for the end of a subforming process, enabling the return of the original context.
  • HashMapExt
    Provides an extension method for hash maps to facilitate the use of the builder pattern.
  • HashSetExt
    Provides an extension method for HashSet to facilitate the use of the builder pattern.
  • IntoInterval
    Convert it into canonical interval.
  • IterExt
    Extension of iterator.
  • IterTrait
    Trait that encapsulates a clonable iterator with specific characteristics, tailored for use with the syn crate.
  • IterableInterval
    Interval adapter. Interface to interval-like structures.
  • Itertools
    An Iterator blanket implementation that provides extra adaptors and methods.
  • LinkedListExt
    Provides an extension method for lists to facilitate the use of the builder pattern.
  • Name
    Trait to get name of an syntax element.
  • NonIterableInterval
    Interval adapter. Interface to interval-like structures.
  • OptionExt
    Extension trait to provide a method for setting a component on an Option<Self> if the Option is currently None. If the Option is Some, the method will delegate to the Assign trait’s assign method.
  • PeekingNext
    An iterator that allows peeking at an element before deciding to accept it.
  • Sources
    A trait that defines a method for retrieving an iterator over source files.
  • Spanned
    A trait that can provide the Span of the complete contents of a syntax tree node.
  • Storage
    Defines the storage interface for entities being constructed using a forming pattern.
  • StoragePreform
    Provides a mechanism to finalize the forming process by converting storage into its final formed state.
  • TransitiveTryFrom
    A trait to perform a transitive try_from conversion.
  • TransitiveTryInto
    A trait to perform a transitive try_into conversion.
  • ValToEntry
    Facilitates the conversion of values back into entries for specific collection types.
  • VecDequeExt
    Provides an extension method for vector deques to facilitate the use of the builder pattern.
  • VecExt
    Provides an extension method for vectors to facilitate the use of the builder pattern.
  • _IterTrait
    Trait that encapsulates an iterator with specific characteristics and implemetning CloneDyn.

Functions§

  • cicd_renew
    List packages.
  • cicd_renew
    Generate workflows for modules in .github/workflows directory.
  • indentation
    Adds indentation and optional prefix/postfix to each line of the given string.
  • is
    Check is string a keyword.
  • report_format
    Formats a debugging report for code transformation processes, detailing both the original and generated code for easy comparison and review.
  • report_print
    Prints a debugging report for a pair of token streams to the standard output.
  • 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
  • workspace_renew
    List packages.
  • workspace_renew
    Creates workspace template

Type Aliases§

  • BTreeMapFormer
    Provides a streamlined builder interface for constructing hash map-like collections.
  • BTreeSetFormer
    Provides a streamlined builder interface for constructing binary tree set-like collections.
  • BinaryHeapFormer
    Provides a streamlined builder interface for constructing binary heap-like collections.
  • BoxedIter
    Type alias for boxed _IterTrait trait objects.
  • HashMapFormer
    Provides a streamlined builder interface for constructing hash map-like collections.
  • HashSetFormer
    Provides a concise alias for CollectionFormer configured specifically for HashSet-like collections.
  • LinkedListFormer
    Provides a streamlined builder interface for constructing list-like collections.
  • ParseStream
    Input to a Syn parser function.
  • ResultWithReport
    A type alias for a Result that contains an error which is a tuple of a report and an original error.
  • VecDequeFormer
    Provides a streamlined builder interface for constructing vector deque-like collections.
  • VectorFormer
    Provides a streamlined builder interface for constructing vector-like collections.

Derive Macros§

  • Assign
    Derives the Assign trait for struct fields, allowing each field to be set with a value that can be converted into the field’s type.
  • Former
    Derive macro for generating a Former struct, applying a Builder Pattern to the annotated struct.