Document link: dependency type (#793)
#969
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for yarnpkg ready! Built with commit 8c967b5 |
|
This is nice! I've been trying to fix yarnpkg/yarn#2165 and found this is actually the best fix. Documenting this is very helpful |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds minimal documentation of the
link:dependency type. The corresponding RFC is 0000-link-dependency-type which has been merged in this PR: yarnpkg/rfcs#34. The original implementation has been merged to yarn two years ago: yarnpkg/yarn#3359.The comment by @Haroenv on #793 suggested to put the documentation to https://github.com/yarnpkg/website/blob/master/lang/en/docs/package-json.md, but since there's no existing documentation of other dependency types like
file:on that page, I decided to go the minimal route and just update the documentation ofyarn addwhich already has several examples. I can update package-json docs in this or followup PR if we'd like to have this information in that page too.