Crate axoproject

Shared code for gathering up information about a workspace, used by various axo.dev tools like cargo-dist and oranda.

The main entry point is get_workspaces.

Modules

• changelog
  Support for interpretting changelogs
• errors
  Errors!
• generic
  Support for generic projects with cargo-dist build instructions
• platforms
  Information about various supported platforms
• rust
  Support for Cargo-based Rust projects

Structs

• AutoIncludes
  Various files we might want to auto-include
• GithubRepo
  Represents a GitHub repository that we can query things about.
• PackageId
  An “opaque” identifier for a package.
• PackageIdx
  An id for a PackageInfo entry in a WorkspaceInfo.
• PackageInfo
  Computed info about a package
• WorkspaceInfo
  Info on the current workspace
• Workspaces
  Information about various kinds of workspaces

Enums

• Version
  A Version abstracted over project type
• WorkspaceKind
  Kind of workspace
• WorkspaceSearch
  Result of searching for a particular kind of workspace

Functions

• find_auto_includes
  Find auto-includeable files in a dir
• find_file
  Find a file with the given name, starting at the given dir and walking up to ancestor dirs, optionally clamped to a given ancestor dir
• get_workspaces
  Tries to find information about the workspace at start_dir, walking up ancestors as necessary until we reach clamp_to_dir (or run out of ancestors).
• merge_auto_includes
  Merge AutoIncluded files into PackageInfo, preferring already existing values over the AutoIncludes. The expected way to use this is: