How I can skip installing optional dependencies by 'npm ci'?

Question

How I can skip installing optional dependencies from package-lock.json by npm ci ?

Answer 1

You can use npm ci --no-optional . If npm still installs the optional package. Then try after removing package.lock.json and run the command again.

Answer 2

A bit late, but you can use npm ci --no-optional . I tested it. Make shure your npm version is a least 6.13.4 (maybe earlier version will work but I can't confirm).

Answer 3

In order to make npm ci --no-optional skip/ignore an optional pacakge, it's important to understand how npm intracts with package.json and pacakge-lock.json.

1. npm install --no-optional (is only effective if pacakge-lock.json doesn't exists otherwise it would ignore --no-optional)*
2. npm ci --no-optional is only effective if pakcage-lock.json was already created with npm install --no-optional **.

* This means if you want to make an already installed package an optional, you can would have to

1. Add it "optionalDependencies": either manulally or through npm install pacakge-name --save-optional
2. Delete the pacakge-lock.json.
3. then run rm -rf node_modules/
4. Lastly run npm install --no-optional
5. Add this point npm ci --no-optional isn't suppose to install it.

** TIP : you could debug if a certian package is assigned as optional by running npm ls package-name

Note : This one the reason why its recommended to keep trak pacakge-lock.json with git repo of the project.

Answer 4

It's not a proper solution, rather an ugly one, but it helped me out. It looks like npm ci --no-optional doesn't work and probably never worked. But at the same time flag --production works. And if we afford mutating package.json (eg in a docker container) then...

So I wrote a simple script that:

• reads package.json content
• Object.assign(cfg.dependencies, cfg.devDependencies)
• delete cfg.devDependencies
• overwrites the initial package.json

So finally we have:

• dependencies contains both normal & dev dependencies
• devDependencies section is empty
• optionalDependencies are intact

And when we run npm ci --production we got what we want - no optional dependencies (in my case cypress ). Due to the fact that all these steps are performed inside of a docker container we can mutate package.json .

But I'm not sure that it'll help you too.

Answer 5

I was facing this issue with CI workflow script and even "--no-optional" was not working

npm ci --no-optional

The above command only worked when I added the optional package as

"optionalDependencies": {
    "fsevents": "^2.3.2"
}

in the package.json file