class

ShardFile

Inherits YAML::Serializable / Reference / Object

Represents the structure of a shard.yml file. This class is used to parse the main project's metadata such as its name and version.

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
Source
new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)
Source

Instance methods

authors
Source
dependencies

Dependency maps (name -> source details)

Source
description

Optional fields

Source
dev_dependency_names

Returns the set of dependency names declared as development dependencies.

Source
development_dependencies
Source
homepage
Source
license
Source
name

The name of the project/shard.

Source
repository
Source
runtime_dependency_names

Returns the set of dependency names declared as runtime dependencies.

Source
targets

Build targets (name -> {main: ...}). Their presence is what distinguishes an application shard from a library one.

Source
targets?

True when the shard declares at least one build target.

Source
version

The version of the project/shard. Optional because a shard.yml may omit it (e.g. an application that is never published), in which case it stays nil and the generated component simply carries no version — which is what CycloneDX means by an unknown version.

Source