Attempt to retrieve config from package.json if codehawk.json doesnt exist (#42)

Author: marcusedwardhaslam

src/codehawk.ts

@@ -1,4 +1,3 @@
-import * as fs from 'fs'
 import * as path from 'path'
 import slash from 'slash'
 import { getCoverage } from './coverage'
@@ -15,7 +14,7 @@ import {
   FullyAnalyzedFile,
   FullyAnalyzedDirectory
 } from './types'
-import { buildOptions } from './options'
+import { buildOptions, getConfiguration } from './options'
 import { formatResultsAsTable } from './cli-util'
 import { flattenEntireTree } from './util'
 
@@ -32,17 +31,7 @@ export { calculateComplexity }
 export const analyzeProject = (rawPath: string, isCliContext?: boolean): Results => {
   // When using CLI, execute from the cwd rather than a relative path
   const actualRoot = (isCliContext) ? cwd : rawPath;
-  const optionsPath = path.resolve(`${actualRoot}/codehawk.json`)
-
-  let projectOptionsFile = null
-  try {
-    projectOptionsFile = fs.readFileSync(optionsPath, 'utf8')
-  } catch (e) {
-    console.log(e)
-    throw new Error('Please ensure you have a codehawk.json file in your project root.')
-  }
-
-  const projectOptions = JSON.parse(projectOptionsFile)
+  const projectOptions = getConfiguration(actualRoot)
   const options = buildOptions(projectOptions)
   const dirPath = path.resolve(`${actualRoot}/`)
   const projectCoverage = getCoverage(dirPath)

src/consts/errors.ts

@@ -0,0 +1 @@
+export const NO_CONFIGURATION_FOUND = "Please ensure your configuration is inside a codehawk.json file in your project root, or in your package.json.";

src/options.ts

@@ -1,3 +1,10 @@
+import {
+  existsSync,
+  readFileSync,
+} from 'fs'
+import { resolve as pathResolve } from 'path'
+
+import { NO_CONFIGURATION_FOUND } from './consts/errors'
 import { CodehawkOptions, AllOptionKeys, AssembledOptions } from './types'
 
 const baseOptions: CodehawkOptions = {
@@ -56,4 +63,28 @@ export const buildOptions = (
   })
 
   return assembledOptions
-}
+}
+
+export const getConfiguration = (rootDirectory: string): AssembledOptions => {
+  try {
+    if (existsSync(pathResolve(`${rootDirectory}/codehawk.json`))) {
+      const configContents = readFileSync(
+        pathResolve(`${rootDirectory}/codehawk.json`),
+        "utf8",
+      );
+      return JSON.parse(configContents);
+    }
+    const packageConfig = readFileSync(
+      pathResolve(`${rootDirectory}/package.json`),
+      "utf-8",
+    );
+    const parsedPackageConfig = JSON.parse(packageConfig);
+    if ("codehawk" in parsedPackageConfig) {
+      return parsedPackageConfig.codehawk;
+    }
+  } catch (e) {
+    console.log(e);
+  }
+
+  throw new Error(NO_CONFIGURATION_FOUND);
+};

test/__mocks__/fs.js

@@ -0,0 +1,16 @@
+const fs = jest.createMockFromModule('fs');
+
+let fileFound = false;
+let readFileSyncData = null;
+
+function __codehawkConfigFound(found, params) {
+  fileFound = found;
+  readFileSyncData = params
+}
+
+fs.existsSync = () => fileFound;
+fs.readFileSync = () => JSON.stringify(readFileSyncData);
+
+fs.__codehawkConfigFound = __codehawkConfigFound
+
+module.exports = fs;

test/options.test.js

@@ -0,0 +1,47 @@
+const { getConfiguration } = require('../build/options')
+
+jest.mock('fs');
+
+describe('when attempting to get the configuration for codehawk', () => {
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
+  describe('and codehawk.json can be found', () => {
+    it('should use the configuration defined in codehawk.json', () => {
+      const mockCodehawkJson = {
+        thing: true,
+        good: 'yes',
+      }
+
+      require('fs').__codehawkConfigFound(true, mockCodehawkJson)
+
+      const config = getConfiguration('/home/')
+
+      expect(config).toEqual(mockCodehawkJson);
+    })
+  })
+
+  describe('and codehawk.json can not be found', () => {
+    it('should use the configuration defined in package.json', () => {
+      const mockCodehawkJson = {
+        boo: 'spooked',
+        happiness: 5,
+      }
+
+      require('fs').__codehawkConfigFound(false, {
+        codehawk: mockCodehawkJson,
+      })
+
+      const config = getConfiguration('/home/')
+
+      expect(config).toEqual(mockCodehawkJson)
+    })
+
+    it('should throw an error when package.json contains no codehawk config' , () => {
+      require('fs').__codehawkConfigFound(false, {})
+
+      expect(() => getConfiguration('/home/')).toThrow()
+    })
+  })
+});