Skip to content

Add --frozen and --without-development CLI flags #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/shards.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Exit status:
*init*::
Initializes a default _shard.yml_ in the current folder.

*install*::
*install* [--frozen] [--without-development] [--production]::
Resolves and installs dependencies into the _lib_ folder. If not already
present, generates a _shard.lock_ file from resolved dependencies, locking
version numbers or Git commits.
Expand All @@ -67,6 +67,12 @@ Reads and enforces locked versions and commits if a _shard.lock_ file is
present. The *install* command may fail if a locked version doesn't match
a requirement, but may succeed if a new dependency was added, as long as it
doesn't generate a conflict, thus generating a new _shard.lock_ file.
+
--
--frozen:: Strictly installs locked versions from _shard.lock_. Fails if _shard.lock_ is missing.
--without-development:: Does not install development dependencies.
--production:: same as _--frozen_ and _--without-development_
--

*list* [--tree]::
Lists the installed dependencies and their versions.
Expand Down Expand Up @@ -121,12 +127,6 @@ after a command.
--ignore-crystal-version::
Do not enforce crystal version restrictions on shards.

--production::
Runs in release mode. Development dependencies won’t
be installed and only locked dependencies will be installed. Commands
will fail if dependencies in _shard.yml_ and _shard.lock_ are out of
sync (used by *install*, *update*, *check* and *list* commands).

-q, --quiet::
Decreases the log verbosity, printing only warnings and errors.

Expand Down
29 changes: 18 additions & 11 deletions man/shards.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: shards
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\" Date: 2021-01-30
.\" Date: 2021-02-02
.\" Manual: Shards Manual
.\" Source: shards 0.13.0
.\" Language: English
.\"
.TH "SHARDS" "1" "2021-01-30" "shards 0.13.0" "Shards Manual"
.TH "SHARDS" "1" "2021-02-02" "shards 0.13.0" "Shards Manual"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -92,7 +92,7 @@ Dependencies are not satisfied.
Initializes a default \fIshard.yml\fP in the current folder.
.RE
.sp
\fBinstall\fP
\fBinstall\fP [\-\-frozen] [\-\-without\-development] [\-\-production]
.RS 4
Resolves and installs dependencies into the \fIlib\fP folder. If not already
present, generates a \fIshard.lock\fP file from resolved dependencies, locking
Expand All @@ -102,6 +102,21 @@ Reads and enforces locked versions and commits if a \fIshard.lock\fP file is
present. The \fBinstall\fP command may fail if a locked version doesn\(cqt match
a requirement, but may succeed if a new dependency was added, as long as it
doesn\(cqt generate a conflict, thus generating a new \fIshard.lock\fP file.
.sp
\-\-frozen
.RS 4
Strictly installs locked versions from \fIshard.lock\fP. Fails if \fIshard.lock\fP is missing.
.RE
.sp
\-\-without\-development
.RS 4
Does not install development dependencies.
.RE
.sp
\-\-production
.RS 4
same as \fI\-\-frozen\fP and \fI\-\-without\-development\fP
.RE
.RE
.sp
\fBlist\fP [\-\-tree]
Expand Down Expand Up @@ -178,14 +193,6 @@ Don\(cqt update remote repositories, use the local cache only.
Do not enforce crystal version restrictions on shards.
.RE
.sp
\-\-production
.RS 4
Runs in release mode. Development dependencies won’t
be installed and only locked dependencies will be installed. Commands
will fail if dependencies in \fIshard.yml\fP and \fIshard.lock\fP are out of
sync (used by \fBinstall\fP, \fBupdate\fP, \fBcheck\fP and \fBlist\fP commands).
.RE
.sp
\-q, \-\-quiet
.RS 4
Decreases the log verbosity, printing only warnings and errors.
Expand Down
Loading