// module/experimental/willbe/src/command/mod.rs
/// Define a private namespace for all its items.
mod private
{
use crate :: *;
use wca :: { Type, CommandsAggregator };
use wca ::aggregator ::CommandsAggregatorFormer;
///
/// Form CA commands grammar.
///
#[ allow( clippy ::too_many_lines ) ]
pub fn ca() -> CommandsAggregatorFormer
{
CommandsAggregator ::former()
.command( "publish" )
.hint( "publish the specified package to `crates.io`" )
.long_hint( "used to publish the specified local package, which is located in the provided directory path, to the `crates.io` crate registry." )
.subject()
.hint( "Provide path(s) to the package(s) that you want to publish.\n\t Each path should point to a directory that contains a `Cargo.toml` file.\n\t Paths should be separated by a comma." )
.kind( Type ::List( Type ::String.into(), ',' ) )
.optional( true )
.end()
.property( "channel" )
.hint( "Release channels for rust." )
.kind( Type ::String )
.optional( true )
.end()
.property( "dry" )
.hint( "Enables 'dry run'. Does not publish, only simulates. Default is `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "temp" )
.hint( "If flag is `true` all test will be running in temporary directories. Default `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
// .property( "verbosity" ).hint( "Setup level of verbosity." ).kind( Type ::String ).optional( true ).alias( "v" ).end()
.routine( command ::publish )
.end()
.command( "publish.diff" )
.hint( "Display the differences between a local and remote package versions." )
.long_hint( "Following this command, you will immediately get a comparison between the local and remote packages. It looks at each file, identifying those added, removed, or modified. A full report will then be generated where you can quickly and easily see the differences." )
.subject()
.hint( "Provide path to the package that you want to check.\n\t The path should point to a directory that contains a `Cargo.toml` file." )
.kind( Type ::Path )
.optional( true )
.end()
.property( "keep_archive" )
.hint( "Save remote package version to the specified path" )
.kind( Type ::Path )
.optional( true )
.end()
.routine( command ::publish_diff )
.end()
.command( "list" )
.hint( "list packages from a directory" )
.long_hint( "generates a list of packages based on the provided directory path. The directory must contain a `Cargo.toml` file." )
.subject()
.hint( "The command will generate a list of packages based on a path that must containing a `Cargo.toml` file. If no path is provided, the current directory is used." )
.kind( Type ::Path )
.optional( true )
.end()
.property( "format" )
.hint( "Adjusts the output format - 'topsort' for a topologically sorted list or 'tree' for a structure of independent crates trees. The default is `tree`." )
.kind( Type ::String )
.optional( true )
.end()
.property( "with_version" )
.hint( "`true` to include the versions of the packages in the output. Defaults to `false`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_path" )
.hint( "`true` to include the paths of the packages in the output. Defaults to `false`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_primary" )
.hint( "`true` to include primary packages in the output, `false` otherwise. Defaults to `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_dev" )
.hint( "`true` to include development packages in the output, `false` otherwise. Defaults to `false`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_build" )
.hint( "`true` to include build packages in the output, `false` otherwise. Defaults to `false`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_local" )
.hint( "`true` to include local packages in the output, `false` otherwise. Defaults to `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_remote" )
.hint( "`true` to include remote packages in the output, `false` otherwise. Defaults to `false`." )
.kind( Type ::Bool )
.optional( true )
.end()
.routine( command ::list )
.end()
.command( "readme.health.table.renew" )
.hint( "Generate a table for the root `readme.md`" )
.long_hint(
r#"Generates a data summary table for the `readme.md` file located in the root of the workspace.
To ensure the proper execution of the command, the following tags need to be specified in the readme.md file :
< !--{ generate.healthtable( './', with_branches: 1 ) } -- >
< !--{ generate.healthtable.end } -- >
After executing the command, the tags will not be modified.
Tags can contains params :
path: The relative path to the directory from workspace root, which crates will be taken. Default is './'.
with_branches: If set to 1, it will display the status of workflow execution on branches specified in branches under workspace.metadata in the Cargo.toml of your workspace. For example, branches = ["master", "alpha"]. Default is 1.
with_stability: If set to 1, a column indicating the stability of the module will be added. Information is taken from package.metadata of each module (package.metadata.stability = "stable"). By default, the module is considered experimental. Default is 1.
with_docs: If set to 1, adds a column with a link to the module's documentation. Default is 1.
with_gitpod: If set to 1, a column with a link to Gitpod will be added. Clicking on it will open and run an example named < module_name >_trivial. Default is 1."# )
.routine( command ::readme_health_table_renew )
.end()
.command( "test" )
.hint( "List crate features to run tests for each combination, aiming for full test coverage of the crate." )
.long_hint( "List crate features, different optimization level (Release & Debug) and toolchain (stable & nightly) to run tests for each combination. Сan be used for packages as well as workspaces. Supports parallel execution." )
.subject().hint( "A path to directories with packages. If no path is provided, the current directory is used." ).kind( Type ::Path ).optional( true ).end()
.property( "dry" ).hint( "Enables 'dry run'. Does not run tests, only simulates. Default is `true`." ).kind( Type ::Bool ).optional( true ).end()
.property( "temp" ).hint( "If flag is `true` all test will be running in temporary directories. Default `true`." ).kind( Type ::Bool ).optional( true ).end()
.property( "include" )
.hint( "A list of features to include in testing. Separate multiple features by comma. Default is empty." )
.kind( Type ::List( Type ::String.into(), ',' ) )
.optional( true )
.end()
.property( "exclude" )
.hint( "A list of features to exclude from testing. Separate multiple features by comma. Default is [full, default]." )
.kind( Type ::List( Type ::String.into(), ',' ) )
.optional( true )
.end()
.property( "with_stable" )
.hint( "Specifies whether or not to run tests on stable Rust version. Default is `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_nightly" )
.hint( "Specifies whether or not to run tests on nightly Rust version. Default is `false`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "concurrent" )
.hint( "Indicates how match test will be run at the same time. Default is `0` - which means the same number of cores." )
.kind( Type ::Number )
.optional( true )
.end()
.property( "power" )
.hint( "Defines the depth of feature combination testing. Default is `1`." )
.kind( Type ::Number )
.optional( true )
.end()
.property( "always")
.hint( "This features will be always present in feature's combinations. Default is empty.")
.kind( Type ::List( Type ::String.into(), ',' ) )
.optional( true )
.end()
.property( "with_all_features" )
.hint( "To powerset of features will be add one subset with all features. Default is `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_none_features" )
.hint( "To powerset of features will be add one empty subset. Default is `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_release" )
.hint( "Indicates whether or not tests will be run on the release optimization. Default is `false`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "with_debug" )
.hint( "Indicates whether or not tests will be run on the debug optimization. Default is `true`." )
.kind( Type ::Bool )
.optional( true )
.end()
.property( "variants_cap" )
.hint( "Regulates the number of possible combinations. Default is 1000.")
.kind( Type ::Number )
.optional( true )
.end()
.routine( command ::test )
.end()
.command( "cicd.renew" )
.hint( "generate a CI/CD for the workspace" )
.long_hint( "this command generates a development workflow for the entire workspace inferred from the current directory. The workflow outlines the build steps, dependencies, test processes, and more for all modules within the workspace." )
.routine( command ::cicd_renew )
.end()
.command( "workspace.renew" )
.hint( "Create workspace template" )
.long_hint( "Creates static files and directories.\nIn workspace`s Cargo.toml and module Cargo.toml you need to specify some fields, fill them before use this template." )
.property( "branches" )
.hint( "List of branches in your project, this parameter affects the branches that will be specified in Cargo.toml of workspace, which in turn will affect the operation of other commands." )
.kind( Type ::List( Type ::String.into(), ',' ) )
.optional( false )
.end()
.property( "repository_url" )
.hint( "Link to project repository, this parameter affects the repo_url will be specified in Cargo.toml of workspace, which in turn will affect the operation of other commands.." )
.kind( Type ::String )
.optional( false )
.end()
.routine( command ::workspace_renew )
.end()
.command( "deploy.renew" )
.hint( "Create deploy template" )
.long_hint( "Creates static files and directories.\nDeployment to different hosts is done via Makefile.\n\nUsage example: deploy.renew gcp_project_id: wtools" )
.property( "gcp_project_id" )
.hint( "Google Cloud Platform Project id for image deployment, terraform state bucket, and, if specified, GCE instance deployment." )
.kind( Type ::String )
.optional( false )
.end()
.property( "gcp_region" )
.hint( "Google Cloud Platform region location. Default: `europe-central2` (Warsaw)" )
.kind( Type ::String )
.optional( true )
.end()
.property( "gcp_artifact_repo_name" )
.hint( "Google Cloud Platform Artifact Repository to store docker image in. Will be generated from current directory name if unspecified." )
.kind( Type ::String )
.optional( true )
.end()
.property( "docker_image_name" )
.hint( "Docker image name to build and deploy. Will be generated from current directory name if unspecified." )
.kind( Type ::String )
.optional( true )
.end()
.routine( command ::deploy_renew )
.end()
.command( "readme.header.renew" )
.hint( "Generate header in workspace`s readme.md file")
.long_hint( "Generate header which contains a badge with the general status of workspace, a link to discord, an example in gitpod and documentation in workspace`s readme.md file.\n For use this command you need to specify: \n\n[workspace.metadata]\nmaster_branch = \"alpha\"\nworkspace_name = \"wtools\"\nrepo_url = \"https: //github.com/Wandalen/wTools\"\ndiscord_url = \"https: //discord.gg/123123\"\n\nin workspace's Cargo.toml.")
.routine( command ::readme_header_renew )
.end()
.command( "readme.modules.headers.renew" )
.hint( "Generates header for each workspace member." )
.long_hint( "Generates header for each workspace member which contains a badge with the status of crate, a link to discord, an example in gitpod and documentation in crate readme.md file.\nFor use this command you need to specify: \n\n[package]\nname = \"test_module\"\nrepository = \"https: //github.com/Username/ProjectName/tree/master/module/test_module\"\n...\n[package.metadata]\nstability = \"stable\" (Optional)\ndiscord_url = \"https: //discord.gg/1234567890\" (Optional)\n\nin module's Cargo.toml." )
.routine( command ::readme_modules_headers_renew )
.end()
.command( "readme.headers.renew" )
.hint( "Aggregation of two command: `readme.header.renew` and `readme.modules.headers.renew`.\n Generated headers in workspace members and in main readme.md file.")
.long_hint( "Generate header which contains a badge with the general status of workspace, a link to discord, an example in gitpod and documentation in workspace`s readme.md file.\n For use this command you need to specify: \n\n[workspace.metadata]\nmaster_branch = \"alpha\"\nworkspace_name = \"wtools\"\nrepo_url = \"https: //github.com/Wandalen/wTools\"\ndiscord_url = \"https: //discord.gg/123123\"\n\nin workspace's Cargo.toml.\n\nGenerates header for each workspace member which contains a badge with the status of crate, a link to discord, an example in gitpod and documentation in crate readme.md file.\nFor use this command you need to specify: \n\n[package]\nname = \"test_module\"\nrepository = \"https: //github.com/Username/ProjectName/tree/master/module/test_module\"\n...\n[package.metadata]\nstability = \"stable\" (Optional)\ndiscord_url = \"https: //discord.gg/1234567890\" (Optional)\n\nin module's Cargo.toml.")
.routine( command ::readme_headers_renew )
.end()
.command( "features" )
.hint( "Lists features of the package" )
.long_hint( "Lists features of the package located in a folder.\nWill list either separate package features or features for every package of a workspace")
.subject()
.hint( "Provide path to the package that you want to check.\n\t The path should point to a directory that contains a `Cargo.toml` file." )
.kind( Type ::Path )
.optional( true )
.end()
.property("with_features_deps")
.hint( "Display dependencies of features of the package" )
.kind( Type ::Bool )
.optional( true )
.end()
.routine( command ::features )
.end()
// Updated command definition
.command( "crate.doc" )
.hint( "Generate documentation for a crate in a single Markdown file." )
.long_hint( "Generates documentation for the specified crate and outputs it as a single Markdown file." )
.subject()
.hint( "Path to the crate directory. If not specified, uses the current directory." )
.kind( Type ::Path )
.optional( true )
.end()
.property( "output" ) // Added output property
.hint( "Path to the output Markdown file. Defaults to {crate_name}_doc.md in the crate directory." )
.kind( Type ::Path )
.optional( true )
.end()
.routine( command ::crate_doc )
.end()
}
}
crate ::mod_interface!
{
own use ca;
/// Generate documentation for a crate.
layer crate_doc;
/// List packages.
layer list;
/// Publish packages.
layer publish;
/// Used to compare local and published versions of a specific package.
layer publish_diff;
/// Combination of two commands `main_header` and `readme_modules_headers_renew`.
layer readme_headers_renew;
/// Generates health table in main readme.md file of workspace.
// aaa: for Petro: what a table??
// aaa: add more details to documentation
layer readme_health_table_renew;
/// Run all tests
layer test;
/// Generate workflow
layer cicd_renew;
/// Workspace new
layer workspace_renew;
/// Deploy new
layer deploy_renew;
/// Generate header in main readme.md
layer main_header;
/// Generate headers
layer readme_modules_headers_renew;
/// List features
layer features;
}