chore(node): Add a link to the documentation for shrinkwrap

Signed-off-by: Frank Viernau <frank_viernau@epam.com>
oss-review-toolkit · Sep 17, 2024 · 705b62c · 705b62c
1 parent a960e4c
commit 705b62c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/plugins/package-managers/node/src/main/kotlin/utils/NpmDetection.kt b/plugins/package-managers/node/src/main/kotlin/utils/NpmDetection.kt
@@ -115,7 +115,10 @@ enum class NodePackageManager(
     val markerFileName: String? = null,
     val workspaceFileName: String = NodePackageManager.DEFINITION_FILE
 ) {
-    NPM("package-lock.json", markerFileName = "npm-shrinkwrap.json") {
+    NPM(
+        lockfileName = "package-lock.json",
+        markerFileName = "npm-shrinkwrap.json" // See https://docs.npmjs.com/cli/v6/configuring-npm/shrinkwrap-json.
+    ) {
         override fun hasLockfile(projectDir: File): Boolean =
             super.hasLockfile(projectDir) || hasNonEmptyFile(projectDir, markerFileName)
     },