Skip to main content

Module utils

Module utils 

Source
Expand description

utility functions for xbp cli

provides utility modules for common operations includes version api integration and other helper functions

Re-exports§

pub use cargo_manifest::resolve_cargo_package_version;
pub use cargo_manifest::resolve_cargo_package_version_required;
pub use cargo_manifest::write_cargo_package_version;
pub use env_files::first_lookup_value;
pub use env_files::load_env_lookup;
pub use env_files::normalize_env_key;
pub use env_files::normalize_env_value;
pub use env_files::parse_env_content;
pub use env_files::parse_env_file;
pub use env_files::resolve_env_placeholders;
pub use env_files::strip_utf8_bom;
pub use env_files::to_env_references;
pub use env_files::CLOUDFLARE_ACCOUNT_ID_ENV_KEYS;
pub use node_toolchain::find_node_toolchain_root;
pub use node_toolchain::is_node_toolchain_command;
pub use node_toolchain::node_toolchain_wrapper_path;
pub use process_monitor_json::fix_cursor_process_monitor_json;
pub use process_monitor_json::fix_cursor_process_monitor_json_file;
pub use process_monitor_json::CursorProcessMonitorJsonFix;
pub use pnpm_package_json::migrate_package_json_pnpm_settings;
pub use pnpm_package_json::PnpmSettingsMigration;
pub use project_paths::collapse_project_path;
pub use project_paths::resolve_project_dir;
pub use project_paths::resolve_project_path;
pub use project_paths::resolve_service_root;
pub use version::fetch_version;
pub use version::increment_version;
pub use xbp_ignore::default_global_worktree_ignore_content;
pub use xbp_ignore::default_xbp_ignore_path;
pub use xbp_ignore::load_global_worktree_ignore_from_path;
pub use xbp_ignore::load_project_xbp_ignore;
pub use xbp_ignore::sync_global_worktree_ignore_file;
pub use xbp_ignore::xbp_ignore_file_candidates;
pub use xbp_ignore::XbpIgnoreSet;
pub use xbp_ignore::DEFAULT_DISCOVERY_SKIP_DIRS;
pub use xbp_ignore::DEFAULT_GLOBAL_WORKTREE_IGNORE_PATTERNS;
pub use xbp_ignore::DEFAULT_NOISE_DIR_NAMES;
pub use xbp_ignore::GLOBAL_WORKTREE_IGNORE_FILENAME;

Modules§

cargo_manifest
Cargo manifest helpers for workspace-aware version read/write.
env_files
node_toolchain
pnpm_package_json
Migrate deprecated package.json#pnpm settings for pnpm v11+.
process_monitor_json
project_paths
tray_runtime
Platform event pumping and tray icon loading for native system tray UIs.
version
version api utilities
xbp_ignore
Project-local ignore rules for XBP discovery, versioning, and worktree-watch.

Structs§

FoundXbpConfig
KnownXbpProject
ListeningPortOwnership
XbpConfigHealResult

Constants§

XBP_PROJECT_YAML_SCHEMA_DIRECTIVE
Comment directive understood by the YAML Language Server / VS Code YAML extension.
XBP_PROJECT_YAML_SCHEMA_URL
Canonical schema URL for project .xbp/xbp.yaml IntelliSense (yaml-language-server).

Functions§

cargo_command_exists
cargo_program
collapse_home_to_env
collect_known_xbp_projects
collect_listening_port_ownership
command_exists
default_project_yaml_config_path
detect_xbp_config_heal_opportunities
ensure_xbp_yaml_schema_directive
Ensure the yaml-language-server $schema comment is present at the top of a project config.
expand_home_in_string
find_existing_yaml_xbp_config
find_xbp_config_upwards
first_available_command
git_remote_url_from_metadata
heal_config_file
heal_project_xbp_config
maybe_auto_convert_legacy_xbp_json_to_yaml
open_path_with_editor
open_with_default_handler
parse_config_with_auto_heal
parse_github_repo_from_remote_url
preferred_pip_command
preferred_python_command
redact_remote_url_credentials
resolve_xbp_project_for_path
serialize_xbp_yaml
write_json_config_from_any_xbp_config