docs(dlx): document version selection and multi-binary behavior - #7267
Open
vjymisal0 wants to merge 1 commit into
Open
docs(dlx): document version selection and multi-binary behavior#7267vjymisal0 wants to merge 1 commit into
vjymisal0 wants to merge 1 commit into
Conversation
Documents the four cases raised in the issue that were previously undocumented on https://yarnpkg.com/cli/dlx: - how to request a specific version of the package - how to run a differently-named binary from an installed package - what happens when the requested binary doesn't exist
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #7072
yarn dlx's usage text (which generates https://yarnpkg.com/cli/dlx) didn't document:command/-p,--package, e.g.yarn dlx eslint@8).2/3. How to run a binary other than the package's own name when a package exposes multiple binaries (pass the binary's name as
commandwhile the package itself is installed via-p,--package).executeWorkspaceAccessibleBinary).This adds two examples and a documentation paragraph covering all four, and a
.yarn/versionsrelease file (patch bump for@yarnpkg/plugin-dlxand its consumer@yarnpkg/cli;yarn version checkpasses).yarn eslint --max-warnings 0 packages/plugin-dlx/sources/commands/dlx.tsandyarn tsc -p . --noEmitboth pass locally.