Merge pull request #5640 from snyk/fix/container-test-exclude-node-mo…

…dules fix: add container test doc info for --exclude-node-modules
snyk · Dec 20, 2024 · 2b913f3 · 2b913f3
2 parents 552b0fc + 2faf2d1
commit 2b913f3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/help/cli-commands/container-test.md b/help/cli-commands/container-test.md
@@ -116,6 +116,12 @@ Allow disabling scans for app vulnerabilities; in CLI versions 1.1090.0 (2023-01
 
 In earlier releases, cannot be used with `--app-vulns`.
 
+### `--exclude-node-modules`
+
+Allow disabling the scan of node_modules directories inside node.js container images; in CLI versions v1.1292.0 and higher, node_modules scanning is enabled by default.
+
+When the node_modules scan is disabled, snyk will report vulnerabilities for npm projects sourced from application file pairs: [package.json, package-lock.json], [package.json, yarn.lock].
+
 ### `--nested-jars-depth`
 
 When `app-vulns` is enabled, use the `--nested-jars-depth=n` option to set how many levels of nested jars Snyk is to unpack. Depth must be a number.

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -75,6 +75,7 @@ export interface Options {
   // Used with the Docker plugin only. Allows application scanning.
   'app-vulns'?: boolean;
   'exclude-app-vulns'?: boolean;
+  'exclude-node-modules'?: boolean;
   debug?: boolean;
   sarif?: boolean;
   'group-issues'?: boolean;