CLIS-78 Adds method to scan folder from dependency scanner and updates README.md

Author: isasmendiagus

Diff for: README.md

@@ -26,6 +26,7 @@ On the other hand, if you need to install the module in your own Node.js project
 Running the bare command will list the available sub-commands:
 
 ```Usage: scanoss-js [options] [command]
+Usage: scanoss-js [options] [command]
 
 The SCANOSS JS package provides a simple, easy to consume module for interacting with SCANOSS APIs/Engine.
 
@@ -35,17 +36,19 @@ Options:
 
 Commands:
   scan [options] <source>  Scan a folder/file
+  dep [options] <source>   Scan for dependencies
+  wfp [options] <source>   Generates fingerprints for a folder/file
   help [command]           display help for command
 ```
 
 From there it is possible to scan a source code folder:
 
 `scanoss-js scan -o scan-output.json <source-folder>`
 
-## Package Usage
+## SDK Usage
+The SDK provides a simple way to interact with the Scanoss APIs from your JS code. Here are two examples for performing code scanning and dependency scanning
 
-The Scanoss package can be used programmatically as a standard Node module.
-A simple example that scans two files and writes the result in the project folder is shown below:
+### Code Scanning 
 
 ```typescript
 // Import as ES6
@@ -77,10 +80,8 @@ const scannerInput = {
 scanner.scan([scannerInput]);
 ```
 
-### Events
-
-The module provides a set of events that can be used to trigger actions.
-Some events are shown in the example above.
+The scanner object provides a set of events that can be used to trigger custom actions. 
+These events are listed in the table above and were previously mentioned.
 
 | Event Name          | Description                         |
 | ------------------- | ----------------------------------- |
@@ -89,10 +90,27 @@ Some events are shown in the example above.
 | DISPATCHER_NEW_DATA | New data received but not persisted |
 | RESULTS_APPENDED    | Results added to scan report file   |
 
-# Build and publish the module
 
-In order to build and publish the package is a requisite to have installed `yarn`. For more information https://yarnpkg.com/getting-started/install
+### Dependency Scanning
+```typescript
+import { DependencyScanner, DependencyScannerCfg } from "scanoss";
+
+const main = async () => {
+
+    const dependencyScanner = new DependencyScanner();
+
+    //Scan a full folder
+    const results = await dependencyScanner.scanFolder("./node_modules")
+
+    //Scan specific files
+    //const results = await dependencyScanner.scan(["./package.json", "package-lock.json"])
+
+}
+
+main();
+```
+# Build and test the module
 
-- `yarn install` will install the dependencies.
-- `yarn build` will build the module.
-- `yarn publish` will publish the module.
+- `npm install` will install the dependencies.
+- `npm run build` will build the module.
+- `npm run test` will publish the module.

Diff for: package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "scanoss",
-  "version": "0.8.8",
+  "version": "0.9.0",
   "description": "The SCANOSS JS package provides a simple, easy to consume module for interacting with SCANOSS APIs/Engine.",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",

Diff for: package.json

@@ -5,6 +5,8 @@ import { LocalDependencies } from "./LocalDependency/LocalDependency";
 import { DependencyScannerCfg } from "./DependencyScannerCfg";
 import { IDependencyResponse } from "./DependencyTypes";
 import { PackageURL } from "packageurl-js";
+import fs from 'fs';
+import { Tree } from '../tree/Tree';
 
 export class DependencyScanner {
 
@@ -29,6 +31,13 @@ export class DependencyScanner {
     this.localDependency = new LocalDependencies();
   }
 
+  public async scanFolder(path: string) {
+    if (!(await fs.promises.lstat(path)).isDirectory()) throw new Error("Specified path is not a directory");
+    const tree = new Tree(path)
+    tree.build();
+    return await this.scan(tree.getFileList())
+  }
+
 
   public async scan(files: Array<string>): Promise<IDependencyResponse> {
     let localDependencies = await this.localDependency.search(files);

Diff for: src/sdk/Dependencies/DependencyScanner.ts

@@ -14,8 +14,8 @@ export default class File extends Node {
     return null;
   }
 
-  public getFiles(f: Filter): Array<string> {
-    if (!f || !f.evaluate(this)) return [];
+  public getFiles(f?: Filter): Array<string> {
+    if (f && !f.evaluate(this)) return [];
     return [this.getPath()];
   }
 

Diff for: src/sdk/tree/File.ts

@@ -42,7 +42,7 @@ export default class Folder extends Node {
   }
 
   public getFiles(f?: Filter): Array<string> {
-    if (!f || !f.evaluate(this)) return [];
+    if (f && !f.evaluate(this)) return [];
 
     const files: Array<string> = [];
     this.children.forEach((child) => {

Diff for: src/sdk/tree/Folder.ts

@@ -17,7 +17,7 @@ export default abstract class Node {
 
   public abstract getNode(path: string): Node;
 
-  public abstract getFiles(f: Filter): Array<string>;
+  public abstract getFiles(f?: Filter): Array<string>;
 
   public getName(): string {
     return this.label;