feat: Add support for 'npm-shrinkwrap.json' #747
Conversation
| wantResultMetric: stats.FileRequiredResultOK, | ||
| }, | ||
| { | ||
| name: "npm-shrinkwrap.json as path segment", |
There was a problem hiding this comment.
Can you also add tests for extraction working properly with some example npm.shrinkwrap.json files? See packagelockjson-v1_test.go. You can create a similar file called shrinkwrap_test.go
There was a problem hiding this comment.
I wonder how useful this is considering that the files are identical and only the name changes.
There was a problem hiding this comment.
It might be helpful if we can support this behavior but for the moment, I don't see a clean way to do so.
If both package-lock.json and npm-shrinkwrap.json are present in the root of a project, npm-shrinkwrap.json will take precedence and package-lock.json will be ignored.
There was a problem hiding this comment.
Now that the precedence behavior was added let's add a test for it too
extractor/filesystem/language/javascript/packagelockjson/packagelockjson.go
Outdated
Show resolved
Hide resolved
| // If both package-lock.json and npm-shrinkwrap.json are present in the root of a project, | ||
| // npm-shrinkwrap.json will take precedence and package-lock.json will be ignored. | ||
| if filepath.Base(input.Path) == "package-lock.json" { | ||
| npmShrinkwrapPath := strings.TrimSuffix(input.Path, "package-lock.json") + "npm-shrinkwrap.json" |
There was a problem hiding this comment.
Let's use path.Dir instead of strings.TrimSuffix - https://pkg.go.dev/path#Dir
| wantResultMetric: stats.FileRequiredResultOK, | ||
| }, | ||
| { | ||
| name: "npm-shrinkwrap.json as path segment", |
There was a problem hiding this comment.
Now that the precedence behavior was added let's add a test for it too
What does this MR do ?
This PR adds support for
npm-shrinkwrap.json.Related issues
#697
Other usefull links
https://docs.npmjs.com/cli/v6/configuring-npm/shrinkwrap-json