Shards: Unify shard names

Created on 11 Jan 2020  路  5Comments  路  Source: crystal-lang/shards

It's a bit of an annoyance keeping up with all the names for shards - the yml file is shard, the command for installing shards is shards and to create a shard using crystal init you have to type lib. Would be more uniform if they were all called the same thing.

Most helpful comment

I think it's quite simple to tell apart:

  • Shards is the program
  • shard.yml is a shard's configuration file

The argument to crystal init isn't even related to that. lib just means your shard is supposed to be a library in contrast to an application. Both generate a shard.yml.

All 5 comments

FWIW shards init is also a thing that just initializes a new shard.yml; crystal init is used to scaffold a whole Crystal project.

It's just confusing - that's shard, that's shards, that's lib, they all mean the same thing though

Yes, but the point I was trying to make is crystal init is outside the scope of this repo, and arguably should be its own thing. Regardless there are only like 3 things here, hardly anything that is worth changing.

EDIT: See some comments in https://github.com/crystal-lang/crystal/issues/8532

I think it's quite simple to tell apart:

  • Shards is the program
  • shard.yml is a shard's configuration file

The argument to crystal init isn't even related to that. lib just means your shard is supposed to be a library in contrast to an application. Both generate a shard.yml.

I guess you have a point

Was this page helpful?
0 / 5 - 0 ratings

Related issues

straight-shoota picture straight-shoota  路  6Comments

bcardiff picture bcardiff  路  8Comments

pyrsmk picture pyrsmk  路  4Comments

mamantoha picture mamantoha  路  7Comments

Blacksmoke16 picture Blacksmoke16  路  8Comments