style(help): Minor tweaks to npm advanced page for QA feedback on
@@ -11,7 +11,7 @@ ${solution_name} has the following npm detectors:
The npm package lock is the preferred npm detector and runs when it finds a [package-lock.json](https://docs.npmjs.com/configuring-npm/package-lock-json.html) generated by npm.
-npm automatically generates the package-lock.json after an "npm install" which should be run prior to scanning.
+npm automatically generates the package-lock.json after an *npm install* which should be run prior to scanning.
This is the most accurate way ${solution_name} supports npm as lock file contains resolved versions and all transitives.
@@ -25,13 +25,14 @@ It is the same as a package-lock.json but is a publishable lockfile. ${solution_
The npm CLI detector requires a package.json and an npm executable.
-It executes "npm -ls json" and parses the dependencies reported by the npm CLI.
+It executes *npm -ls json*, and verifies that it succeeded by ensuring that no messages were written to
+stderr, and that the exit code was 0. If both conditions are met, it parses the output for dependencies.
-It requires that the Npm command succeeds - does not write to ERR and returns exit code 0.
+If *npm -ls json* does write messages to stderr (for example, lint messages) that you would like
+${solution_name} to ignore, you can silence errors by adding the --silent npm argument to the npm
+command using ${solution_name} property --detect.npm.arguments.
-If your npm command does not, you can silence the errors by adding the --silent npm argument using --detect.npm.arguments.
-
-This detector is only invoked if the other detectors are not invoked and generating lockfiles for the other detectors should be preferred.
+This detector is only invoked if the other npm detectors are not invoked, and generating lockfiles for the other detectors should be preferred.
## npm package JSON
@@ -39,6 +40,6 @@ The npm CLI detector is the fallback when in Build mode. When in buildless the f
This is the least accurate of the npm detectors.
-It requires and parses a "package.json".
+It requires and parses a package.json file.
It does not find transitives and only reports the wild-card version present in the file.
\ No newline at end of file
