class ShardFile

• ShardFile
• Reference
• Object

Overview

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.

Included Modules

• YAML::Serializable

Defined in:

shard/shard_file.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

Instance Method Summary

• #authors : Array(String) | Nil
• #dependencies : YAML::Any | Nil

  Dependency maps (name -> source details)

• #description : String | Nil

  Optional fields

• #dev_dependency_names : Set(String)

  Returns the set of dependency names declared as development dependencies.

• #development_dependencies : YAML::Any | Nil
• #homepage : String | Nil
• #license : String | Nil
• #name : String

  The name of the project/shard.

• #repository : String | Nil
• #runtime_dependency_names : Set(String)

  Returns the set of dependency names declared as runtime dependencies.

• #targets : YAML::Any | Nil

  Build targets (name -> {main: ...}).

• #targets? : Bool

  True when the shard declares at least one build target.

• #version : String | Nil

  The version of the project/shard.

Constructor Detail

Instance Method Detail