docs: package aliases #485
Closed
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
claudiahdz
added
Release 6.x
darcyclarke
suggested changes
Nov 15, 2019
| @@ -63,8 +64,7 @@ after packing it up into a tarball (b). | |||
| With the `--production` flag (or when the `NODE_ENV` environment variable | |||
| is set to `production`), npm will not install modules listed in | |||
| `devDependencies`. To install all modules listed in both `dependencies` | |||
| and `devDependencies` when `NODE_ENV` environment variable is set to `production`, | |||
| you can use `--production=false`. | |||
| and `devDependencies` when `NODE_ENV` environment variable is set to `production`, you can use `--production=false`. | |||
There was a problem hiding this comment.
@claudiahdz I think the reason there were line breaks here was to keep the text column count short in a shell output... not sure if removing them will effect that negatively so that command line docs would span the length of the terminal 🤔
| @@ -113,12 +109,22 @@ after packing it up into a tarball (b). | |||
|
|
|||
| npm install sax | |||
|
|
|||
| * `npm install <alias>@npm:<name>`: | |||
|
|
|||
| Install a package under a custom alias. Allows multiple versions of a same-name package side-by-side, more convenient import names for packages with otherwise long ones and using git forks replacements or forked npm packages as replacements. Aliasing works only on your project and does not rename packages in transitive dependencies. Aliases should follow the naming conventions stated in [`validate-npm-package-name`](https://www.npmjs.com/package/validate-npm-package-name#naming-rules). | |||
claudiahdz
force-pushed
the
docs/package-aliases
branch
from
4613d60
to
41feb13
Compare
ljharb
reviewed
Nov 15, 2019
| @@ -113,6 +114,19 @@ after packing it up into a tarball (b). | |||
|
|
|||
| npm install sax | |||
|
|
|||
| * `npm install <alias>@npm:<name>`: | |||
There was a problem hiding this comment.
with --save, would this install using the alias notation into package.json?
There was a problem hiding this comment.
Yes, for example doing npm install jquery1@npm:jquery@1 will look like this on package.json:
"dependencies": {
"jquery1": "npm:jquery@^1.12.4"
}
You can also use the alias for npm related tasks, ex: npm uninstall jquery1.
There was a problem hiding this comment.
Great! Should the docs be explicit about that?
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
claudiahdz
force-pushed
the
docs/package-aliases
branch
2 times, most recently
from
7ba97b0
to
7b17efb
Compare
claudiahdz
force-pushed
the
docs/package-aliases
branch
from
7b17efb
to
90805b9
Compare
darcyclarke
approved these changes
Nov 15, 2019
Merged
This was referenced Nov 27, 2019
This was referenced Dec 12, 2019
This was referenced Feb 25, 2020
This was referenced Mar 10, 2020
This was referenced Mar 19, 2020
This was referenced Mar 26, 2020
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.
Adds docs for package aliases.