Finished commenting code

lib/index.js

@@ -38,6 +38,10 @@ function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, a
 
 const logger = _bunyan2.default.createLogger({ name: 'Index' });
 
+/**
+ * Creates a request for the report
+ * @param {Object} body body of the request
+ */
 const getRequest = body => {
  return new Request('http://35.234.151.254/report', {
  headers: {
@@ -73,7 +77,7 @@ function generateReport(policyData, pkg, dependencies, error) {
  const report = new _report_model.Report(reportOptions);
  report.insertDependencies(dependencies);
 
- _fileManager2.default.writeBuildFile('report.json', JSON.stringify(report));
+ (0, _fileManager2.default)('report.json', JSON.stringify(report));
  logger.info('Generated report');
 
  return report;

lib/utils/file-manager.js

@@ -1,39 +1,32 @@
 'use strict';
 
-const fs = require('fs');
+Object.defineProperty(exports, "__esModule", {
+ value: true
+});
+exports.default = writeBuildFile;
 
+var _fs = require('fs');
+
+var _fs2 = _interopRequireDefault(_fs);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Writes into a file asynchronously
+ * @param {String} fileName the name of the file to write to
+ * @param {String} fileData the data to be written
+ */
 function writeBuildFile(fileName, fileData) {
- fs.stat('./build', (err, stats) => {
+ _fs2.default.stat('./build', (err, stats) => {
  if (err) {
- fs.mkdir('./build', err => {
+ _fs2.default.mkdir('./build', err => {
  if (err) {
  throw new Error(err);
  }
- fs.writeFileSync(`./build/${fileName}`, fileData);
+ _fs2.default.writeFileSync(`./build/${fileName}`, fileData);
  });
  } else {
- fs.writeFileSync(`./build/${fileName}`, fileData);
- }
- });
-}
-
-function readFile(filePath, cb) {
- fs.stat(filePath, (err, stats) => {
- if (err) {
- return cb(err);
- }
- if (stats.isFile) {
- fs.readFile(filePath, 'utf-8', (err, data) => {
- if (err) {
- return cb(err);
- }
- return cb(null, data);
- });
+ _fs2.default.writeFileSync(`./build/${fileName}`, fileData);
  }
  });
-}
-
-module.exports = {
- writeBuildFile,
- readFile
-};
+}

lib/utils/vulnerabilities.js

@@ -28,6 +28,11 @@ function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, a
 
 const logger = _bunyan2.default.createLogger({ name: 'Fetch-Vulnerabilities' });
 
+/**
+ * Creates a request to fetch vulnerabilites
+ * @param {Object} body body of the request
+ * @param {Number} cacheTime time for the cache in the proxy
+ */
 const getRequest = (body, cacheTime) => {
  return new Request('http://35.234.151.254/npm/dependency/vulnerabilities', {
  headers: {

package.json

@@ -11,7 +11,7 @@
  "debug": "node ./bin/npm-dependency-analyzer | bunyan",
  "clean": "rimraf build/ && rimraf lib/",
  "prebuild": "npm install && npm run clean",
- "build": "npm run lint && babel src -d lib",
+ "build": "npm run lint && babel src -d lib && npm test",
  "lint": "standard src/ --fix",
  "test": "jest | bunyan"
  },

src/index.js

@@ -7,11 +7,15 @@ import getVulnerabilities from './utils/vulnerabilities'
 import getDependencies from './utils/dependencies'
 import getLicenses from './utils/licenses'
 import {Report} from './report_model'
-import fileManager from './utils/file-manager'
+import writeFile from './utils/file-manager'
 import {catchifyPromise} from './utils/utility-functions'
 
 const logger = bunyan.createLogger({name: 'Index'})
 
+/**
+ * Creates a request for the report
+ * @param {Object} body body of the request
+ */
 const getRequest = body => {
  return new Request('http://35.234.151.254/report', {
  headers: {
@@ -47,7 +51,7 @@ function generateReport (policyData, pkg, dependencies, error) {
  const report = new Report(reportOptions)
  report.insertDependencies(dependencies)
 
- fileManager.writeBuildFile('report.json', JSON.stringify(report))
+ writeFile('report.json', JSON.stringify(report))
  logger.info('Generated report')
 
  return report

src/utils/file-manager.js

@@ -1,8 +1,13 @@
 'use strict'
 
-const fs = require('fs')
+import fs from 'fs'
 
-function writeBuildFile (fileName, fileData) {
+/**
+ * Writes into a file asynchronously
+ * @param {String} fileName the name of the file to write to
+ * @param {String} fileData the data to be written
+ */
+export default function writeBuildFile (fileName, fileData) {
  fs.stat('./build', (err, stats) => {
  if (err) {
  fs.mkdir('./build', err => {
@@ -16,24 +21,3 @@ function writeBuildFile (fileName, fileData) {
  }
  })
 }
-
-function readFile (filePath, cb) {
- fs.stat(filePath, (err, stats) => {
- if (err) {
- return cb(err)
- }
- if (stats.isFile) {
- fs.readFile(filePath, 'utf-8', (err, data) => {
- if (err) {
- return cb(err)
- }
- return cb(null, data)
- })
- }
- })
-}
-
-module.exports = {
- writeBuildFile,
- readFile
-}

src/utils/vulnerabilities.js

@@ -10,6 +10,11 @@ import RequestBody from '../oss-fetch-body'
 
 const logger = bunyan.createLogger({name: 'Fetch-Vulnerabilities'})
 
+/**
+ * Creates a request to fetch vulnerabilites
+ * @param {Object} body body of the request
+ * @param {Number} cacheTime time for the cache in the proxy
+ */
 const getRequest = (body, cacheTime) => {
  return new Request('http://35.234.151.254/npm/dependency/vulnerabilities', {
  headers: {