Struct axoproject::WorkspaceInfo

pub struct WorkspaceInfo {
    pub kind: WorkspaceKind,
    pub target_dir: Utf8PathBuf,
    pub workspace_dir: Utf8PathBuf,
    pub package_info: Vec<PackageInfo>,
    pub manifest_path: Utf8PathBuf,
    pub root_auto_includes: AutoIncludes,
    pub warnings: Vec<AxoprojectError>,
    pub cargo_metadata_table: Option<Value>,
    pub cargo_profiles: CargoProfiles,
}

Info on the current workspace

This can either be a cargo workspace or an npm workspace, the concepts are conflated to let users of axoproject handle things more uniformly.

Fields

kind: WorkspaceKind

The kinf of workspace this is (Rust or Javascript)

target_dir: Utf8PathBuf

The directory where build output will go (generally target/)

workspace_dir: Utf8PathBuf

The root directory of the workspace (where the root Cargo.toml is)

package_info: Vec<PackageInfo>

Computed info about the packages.

This notably includes finding readmes and licenses even if the user didn’t specify their location – something Cargo does but Guppy (and cargo-metadata) don’t.

manifest_path: Utf8PathBuf

Path to the root manifest of the workspace

This can be either a Cargo.toml or package.json. In either case this manifest may or may not represent a “real” package. Both systems have some notion of “virtual” manifest which exists only to list the actual packages in the workspace.

root_auto_includes: AutoIncludes

If the workspace root has some auto-includeable files, here they are!

This is currently what is use for top-level Announcement contents.

warnings: Vec<AxoprojectError>

Non-fatal issues that were encountered and should probably be reported

cargo_metadata_table: Option<Value>

Raw cargo [workspace.metadata] table

cargo_profiles: CargoProfiles

Any [profile.*] entries we found in the root Cargo.toml

Implementations

impl WorkspaceInfo

pub fn changelog_for_version( &self, version: &Version, ) -> Result<Option<ChangelogInfo>>

Get the changelog for a given version from the root workspace’s changelog

impl WorkspaceInfo

pub fn package(&self, idx: PackageIdx) -> &PackageInfo

Get a package

pub fn package_mut(&mut self, idx: PackageIdx) -> &mut PackageInfo

Get a mutable package

pub fn packages(&self) -> impl Iterator<Item = (PackageIdx, &PackageInfo)>

Iterate over packages

pub fn github_repo( &self, packages: Option<&[PackageIdx]>, ) -> Result<Option<GithubRepo>>

Returns a struct which contains the repository’s owner and name.

pub fn web_url(&self, packages: Option<&[PackageIdx]>) -> Result<Option<String>>

Returns a web version of the repository URL, converted from SSH if necessary, with .git suffix trimmed.

pub fn repository_url( &self, packages: Option<&[PackageIdx]>, ) -> Result<Option<String>>

Returns a consensus package URL for the given packages, if any exists