shard.yml

Shards configuration file

Type object
File match shard.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/shard-yml/latest.json
Source https://raw.githubusercontent.com/crystal-lang/shards/master/docs/shard.yml.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Metadata for projects managed by Shards

Properties

name string required

The name of the project

maxLength=50pattern=^(?!.*__|.*--|.*crystal|[0-9_-])[a-z0-9_-]+(?<![_-])$
version string required

The version number of the project

pattern=^(?!.*\.\.|.*--)[0-9a-zA-Z.-]+$
authors string[]

A list of authors, along with their contact email

crystal string

A restriction to indicate what Crystal versions are supported

dependencies Record<string, object>

A list of required dependencies https://github.com/crystal-lang/shards/blob/master/docs/shard.yml.adoc#dependency-attributes

development_dependencies Record<string, object>

A list of dependencies required to work on the project, but not necessary to build and run the project https://github.com/crystal-lang/shards/blob/master/docs/shard.yml.adoc#dependency-attributes

description string

A single line description of the project

documentation string

The URL to a website providing the project's documentation for online browsing

executables string[]

A list of executables to be installed

homepage string

The URL of the project's homepage

libraries Record<string, string>

A list of shared libraries the shard tries to link to

license string

An SPDX license expression or an URL to a license file.

repository string

The URL of the project's canonical repository

scripts object

Script hooks to run

1 nested properties
postinstall string

Will be run whenever the dependency is installed or upgraded in a project that requires it

targets Record<string, object>

A list of targets to build