refactor: remove special npm/yarn path in snyk-test

src/lib/plugins/index.ts

@@ -1,14 +1,13 @@
 import * as dockerPlugin from 'snyk-docker-plugin';
-import * as npmPlugin from './npm';
 import * as rubygemsPlugin from './rubygems';
 import * as mvnPlugin from 'snyk-mvn-plugin';
 import * as gradlePlugin from 'snyk-gradle-plugin';
 import * as sbtPlugin from 'snyk-sbt-plugin';
-import * as yarnPlugin from './yarn';
 import * as pythonPlugin from 'snyk-python-plugin';
 import * as goPlugin from 'snyk-go-plugin';
 import * as nugetPlugin from 'snyk-nuget-plugin';
 import * as phpPlugin from 'snyk-php-plugin';
+import * as nodejsPlugin from './nodejs-plugin';
 import * as types from './types';
 
 export function loadPlugin(packageManager: string, options: types.Options = {}): types.Plugin {
@@ -18,7 +17,7 @@ export function loadPlugin(packageManager: string, options: types.Options = {}):
 
   switch (packageManager) {
     case 'npm': {
-      return npmPlugin;
+      return nodejsPlugin;
     }
     case 'rubygems': {
       return rubygemsPlugin;
@@ -33,7 +32,7 @@ export function loadPlugin(packageManager: string, options: types.Options = {}):
       return sbtPlugin;
     }
     case 'yarn': {
-      return yarnPlugin;
+      return nodejsPlugin;
     }
     case 'pip': {
       return pythonPlugin;

src/lib/snyk-test/nodejs-plugin/README.md → src/lib/plugins/nodejs-plugin/README.md

@@ -2,6 +2,4 @@ This directory contains a logic for parsing Node.js projects (npm and Yarn).
 
 Historically, Node.js support was the first to be implemented in Snyk and thus it was built in.
 All other languages and platforms are supported via plugins.
-This code will also eventually move to a plugin.
-
-See also src/lib/plugins/npm/index.ts
+This code will also eventually move to a separate plugin repository.

src/lib/plugins/nodejs-plugin/index.ts

@@ -0,0 +1,19 @@
+import * as modulesParser from './npm-modules-parser';
+import * as lockParser from './npm-lock-parser';
+import * as types from '../types';
+
+export async function inspect(root: string, targetFile: string, options: types.Options = {}):
+Promise<types.InspectResult> {
+  const isLockFileBased = (targetFile.endsWith('package-lock.json') || targetFile.endsWith('yarn.lock'));
+
+  const getLockFileDeps = isLockFileBased && !options.traverseNodeModules;
+  return {
+    plugin: {
+      name: 'snyk-nodejs-lockfile-parser',
+      runtime: process.version,
+    },
+    package: getLockFileDeps ?
+      await lockParser.parse(root, targetFile, options) :
+      await modulesParser.parse(root, targetFile, options),
+  };
+}

src/lib/snyk-test/nodejs-plugin/npm-lock-parser.ts → src/lib/plugins/nodejs-plugin/npm-lock-parser.ts

@@ -7,8 +7,9 @@ import * as analytics from '../../analytics';
 import * as fs from 'fs';
 import * as lockFileParser from 'snyk-nodejs-lockfile-parser';
 import {PkgTree} from 'snyk-nodejs-lockfile-parser';
+import {Options} from '../types';
 
-export async function parse(root, targetFile, options): Promise<PkgTree> {
+export async function parse(root: string, targetFile: string, options: Options): Promise<PkgTree> {
   const lockFileFullPath = path.resolve(root, targetFile);
   if (!fs.existsSync(lockFileFullPath)) {
     throw new Error('Lockfile ' + targetFile + ' not found at location: ' +

src/lib/snyk-test/nodejs-plugin/npm-modules-parser.ts → src/lib/plugins/nodejs-plugin/npm-modules-parser.ts

@@ -4,8 +4,9 @@ import * as spinner from '../../spinner';
 import * as analytics from '../../analytics';
 import * as fs from 'then-fs';
 import {PkgTree} from 'snyk-nodejs-lockfile-parser';
+import {Options} from '../types';
 
-export async function parse(root, targetFile, options): Promise<PkgTree> {
+export async function parse(root: string, targetFile: string, options: Options): Promise<PkgTree> {
   const nodeModulesPath = path.join(
     path.dirname(path.resolve(root, targetFile)),
     'node_modules',
@@ -21,18 +22,18 @@ export async function parse(root, targetFile, options): Promise<PkgTree> {
     lockFile: false,
     targetFile,
   });
-  options.root = root;
+
   const resolveModuleSpinnerLabel = 'Analyzing npm dependencies for ' +
     path.dirname(path.resolve(root, targetFile));
   try {
     await spinner(resolveModuleSpinnerLabel);
     if (targetFile.endsWith('yarn.lock')) {
-      options.file = options.file.replace('yarn.lock', 'package.json');
+      options.file = options.file && options.file.replace('yarn.lock', 'package.json');
     }
 
     // package-lock.json falls back to package.json (used in wizard code)
     if (targetFile.endsWith('package-lock.json')) {
-      options.file = options.file.replace('package-lock.json', 'package.json');
+      options.file = options.file && options.file.replace('package-lock.json', 'package.json');
     }
     return snyk.modules(
       root, Object.assign({}, options, {noFromArrays: true}));

src/lib/plugins/types.ts

@@ -7,12 +7,14 @@ export interface InspectResult {
 }
 
 export interface Options {
+  file?: string;
   docker?: boolean;
   traverseNodeModules?: boolean;
   dev?: boolean;
   strictOutOfSync?: boolean | 'true' | 'false';
   multiDepRoots?: boolean;
   debug?: boolean;
+  packageManager?: string;
 }
 
 export interface Plugin {

src/lib/snyk-test/index.js

@@ -3,7 +3,6 @@ module.exports = test;
 var detect = require('../detect');
 var runTest = require('./run-test');
 var chalk = require('chalk');
-var nodejs = require('./nodejs');
 
 function test(root, options, callback) {
   if (typeof options === 'function') {
@@ -48,10 +47,9 @@ function executeTest(root, options) {
 
 function run(root, options) {
   var packageManager = options.packageManager;
-  if (['npm', 'yarn'].indexOf(packageManager) >= 0) {
-    return nodejs(packageManager, root, options).then((res) => [res]);
-  }
   if (!options.docker && [
+    'npm',
+    'yarn',
     'rubygems',
     'maven',
     'gradle',