Skip to content

Commit 9bd407e

Browse files
Maël Nisonarcanis
Maël Nison
authored andcommitted
Adds the rfc for removing yarn check
1 parent 835c327 commit 9bd407e

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

accepted/0000-remove-yarn-check.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
- Start Date: 30 Oct 2018
2+
- RFC PR: https://github.com/yarnpkg/rfcs/pull/106
3+
- Yarn Issue: n/a
4+
5+
# Remove `yarn check`
6+
7+
## 1. Motivation
8+
9+
Running `yarn install` should work out of the box. There's no reason for `yarn check` to exist from a user perspective - they should never have to run it, because installs must always be right.
10+
11+
Being not particularly useful, the `yarn check` command receives less attention and as a result it often yields wrong / confusing results. This leads users to believe that `yarn install` is broken when it's in fact `yarn check` (https://twitter.com/betaorbust/status/1055610508533878784).
12+
13+
## 2. Detailed Design
14+
15+
We'll remove the `yarn check` command in Yarn 2.0.
16+
17+
## 3. How Can We Teach This
18+
19+
This command will be marked as deprecated, and running it will exit with an error code and an error message explaining why it got removed.
20+
21+
## 4. Drawbacks
22+
23+
- The one use of `yarn check` is to provide debug information when installs aren't properly made. In practice it's never used this way, even by maintainers.
24+
25+
## 5. Alternatives
26+
27+
- We could fix `yarn check`. This would prove time consuming, of little value because of the reasons detailed above, and resources would be better spent on other worksites.

0 commit comments

Comments
 (0)