Skip to content

docs: remove package-lock option for npm ci #6468

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 18, 2023
Merged

docs: remove package-lock option for npm ci #6468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c28d246
remove package-lock option from npm ci
m4rch3n1ng May 18, 2023
7094fb8
update tests
m4rch3n1ng May 18, 2023
675e891
update npm help for package-lock option
m4rch3n1ng May 18, 2023
04c063c
fix smoke tests
m4rch3n1ng May 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion lib/commands/ci.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ class CI extends ArboristWorkspaceCmd {
'global-style',
'omit',
'strict-peer-deps',
'package-lock',
'foreground-scripts',
'ignore-scripts',
'audit',
Expand Down
2 changes: 0 additions & 2 deletions lib/utils/config/definitions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1495,8 +1495,6 @@ define('package-lock', {
If set to false, then ignore \`package-lock.json\` files when installing.
This will also prevent _writing_ \`package-lock.json\` if \`save\` is
true.

This configuration does not affect \`npm ci\`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The thinking here is that now that this isn't listed as a flag on npm ci the caveat isn't needed.

`,
flatten: (key, obj, flatOptions) => {
flatten(key, obj, flatOptions)
Expand Down
4 changes: 2 additions & 2 deletions smoke-tests/tap-snapshots/test/index.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ npm ERR!
npm ERR! Options:
npm ERR! [--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
npm ERR! [--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
npm ERR! [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
npm ERR! [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
npm ERR! [--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
npm ERR! [--no-bin-links] [--no-fund] [--dry-run]
npm ERR! [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
npm ERR! [-ws|--workspaces] [--include-workspace-root] [--install-links]
npm ERR!
Expand Down
12 changes: 4 additions & 8 deletions tap-snapshots/test/lib/docs.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,8 +969,6 @@ The package or packages to install for [\`npm exec\`](/commands/npm-exec)
If set to false, then ignore \`package-lock.json\` files when installing. This
will also prevent _writing_ \`package-lock.json\` if \`save\` is true.

This configuration does not affect \`npm ci\`.

#### \`package-lock-only\`

* Default: false
Expand Down Expand Up @@ -2215,8 +2213,8 @@ npm ci
Options:
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
[--no-bin-links] [--no-fund] [--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -2235,7 +2233,6 @@ aliases: clean-install, ic, install-clean, isntall-clean
#### \`global-style\`
#### \`omit\`
#### \`strict-peer-deps\`
#### \`package-lock\`
#### \`foreground-scripts\`
#### \`ignore-scripts\`
#### \`audit\`
Expand Down Expand Up @@ -2811,8 +2808,8 @@ npm install-ci-test
Options:
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
[--no-bin-links] [--no-fund] [--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]

Expand All @@ -2831,7 +2828,6 @@ aliases: cit, clean-install-test, sit
#### \`global-style\`
#### \`omit\`
#### \`strict-peer-deps\`
#### \`package-lock\`
#### \`foreground-scripts\`
#### \`ignore-scripts\`
#### \`audit\`
Expand Down