Skip to content
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

[DOCS] Missing flags of npm install and npm ci #5232

Closed
2 tasks done
PatrikTrefil opened this issue Jul 28, 2022 · 4 comments · Fixed by #6831
Closed
2 tasks done

[DOCS] Missing flags of npm install and npm ci #5232

PatrikTrefil opened this issue Jul 28, 2022 · 4 comments · Fixed by #6831
Assignees
Labels
Documentation documentation related issue Priority 2 secondary priority issue

Comments

@PatrikTrefil
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

This is a CLI Docs Problem, not another kind of Docs Problem.

  • This is a CLI Docs Problem.

Description of Problem

Documentation for npm install and npm ci does not include the --include, --only, --no-optional flags in version 8.x.

Potential Solution

Include --include, --only, --no-optional flags in the documentation.

Affected URL

No response

@PatrikTrefil PatrikTrefil added Documentation documentation related issue Needs Triage needs review for next steps labels Jul 28, 2022
@wraithgar
Copy link
Member

only and optional are deprecated flags and should not be included. include is the inverse of omit and probably should be included.

@wraithgar wraithgar added Priority 2 secondary priority issue and removed Needs Triage needs review for next steps labels Jul 28, 2022
@s100
Copy link
Contributor

s100 commented Dec 20, 2022

Since it might take a little while to show up in the official documentation, could someone in this issue give an informal explanation of how --include works?

@AKayy2020
Copy link

Historical jeans

@siemhesda siemhesda self-assigned this Sep 21, 2023
@siemhesda
Copy link
Contributor

Since it might take a little while to show up in the official documentation, could someone in this issue give an informal explanation of how --include works?

The --include option allows for defining which types of dependancies to install.

It is the inverse of --omit=<type>.

Dependency types specified i --include won't be omitted, regardless of the order in which omit/include are specified.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation documentation related issue Priority 2 secondary priority issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants