feat: pass config file in CLI options

BREAKING CHANGE: wrong parameters in config files now throw errors

Author: msanguineti

__tests__/core.test.ts

@@ -18,15 +18,11 @@ describe('testing core functionalities', () => {
       expect(defaults.integration).toEqual(1)
     })
 
-    test('load default values if no config files - part I', () => {
-      const defaults = core.loadConfigFile()
-
-      expect(defaults.main).toMatch('master')
-      expect(defaults.usedev).not.toBeTruthy()
-      expect(defaults.integration).toEqual(1)
+    test('throw if no config file is found', () => {
+      expect(() => core.loadConfigFile()).toThrow(/^Cannot load/)
     })
 
-    test('load default values if no config files - part II', () => {
+    test('load default values if no default config files are found', () => {
       const defaults = core.loadConfigValues()
 
       expect(defaults.main).toMatch('master')
@@ -66,10 +62,7 @@ describe('testing core functionalities', () => {
       }`
       ).to(tempConfigFile)
 
-      const defaults = core.loadConfigFile(tempConfigFile)
-
-      expect(defaults).toBeDefined()
-      expect(defaults.development).toMatch('develop')
+      expect(() => core.loadConfigFile(tempConfigFile)).toThrow(/^development/)
     })
 
     test('write to (and load from) .js file', () => {
@@ -95,27 +88,35 @@ describe('testing core functionalities', () => {
     })
 
     test('config value for a branch name is invalid', () => {
-      core.writeConfigFile({
-        data: { development: 'akn//&&svn...#k/' }
-      })
+      expect(() =>
+        core.writeConfigFile({
+          data: { development: 'akn//&&svn...#k/' }
+        })
+      ).toThrow(/^development/)
     })
 
     test('config value usedev is invalid', () => {
-      core.writeConfigFile({
-        data: { usedev: 'true' }
-      })
+      expect(() =>
+        core.writeConfigFile({
+          data: { usedev: 'true' }
+        })
+      ).toThrow(/^usedev/)
     })
 
     test('config value push is invalid', () => {
-      core.writeConfigFile({
-        data: { push: 'maybe' }
-      })
+      expect(() =>
+        core.writeConfigFile({
+          data: { push: 'maybe' }
+        })
+      ).toThrow(/^push/)
     })
 
     test('config value integration is invalid', () => {
-      core.writeConfigFile({
-        data: { integration: 4 }
-      })
+      expect(() =>
+        core.writeConfigFile({
+          data: { integration: 4 }
+        })
+      ).toThrow(/^integration/)
     })
   })
 

src/cli.ts

@@ -31,9 +31,13 @@ const argv = yargs
   .command(new Feature())
   .command(new Release())
   .command(new Hotfix())
+  .option('c', {
+    alias: 'config',
+    type: 'string',
+    description: 'Config file to use'
+  })
   .help()
   .alias('h', 'help').argv
 
-if (argv._.length <= 0) {
+if (argv._.length <= 0)
   console.log(warning(`Try ${basename(process.argv[1])} --help`))
-}

src/cmds/feature.ts

@@ -18,5 +18,5 @@ export class Feature implements CommandModule {
     return yargs.command(new StartFeature()).command(new FinishFeature())
   }
 
-  public handler = (): void => {}
+  public handler = () => {}
 }

src/cmds/feature/finish.ts

@@ -9,7 +9,7 @@ import { spawnSync } from 'child_process'
 import { prompt } from 'inquirer'
 import { exec } from 'shelljs'
 import { Arguments, Argv, CommandModule } from 'yargs'
-import { isValidBranchName } from '../../core'
+import { isValidBranchName, loadConfigFile } from '../../core'
 
 export class FinishFeature implements CommandModule {
   public command: string = 'finish <featureBranch> [options]'
@@ -25,6 +25,8 @@ export class FinishFeature implements CommandModule {
   }
 
   public handler = (argv: Arguments) => {
+    if (argv.c) loadConfigFile(argv.c as string)
+
     const mergeInto = argv.usedev ? argv.development : argv.main
     if (isValidBranchName(mergeInto)) return handleFinish(argv, mergeInto)
   }

src/cmds/feature/start.ts

@@ -6,14 +6,16 @@
  */
 import { exec } from 'shelljs'
 import { Arguments, CommandModule } from 'yargs'
-import { isValidBranchName } from '../../core'
+import { isValidBranchName, loadConfigFile } from '../../core'
 
 export class StartFeature implements CommandModule {
   public command: string = 'start <featureBranch>'
 
   public describe: string = 'Start a new feature'
 
   public handler = (argv: Arguments) => {
+    if (argv.c) loadConfigFile(argv.c as string)
+
     const branchOff = argv.usedev ? argv.development : argv.main
 
     if (

src/cmds/hotfix/finish.ts

@@ -9,13 +9,16 @@ import { prompt } from 'inquirer'
 import { exec } from 'shelljs'
 import { Arguments, CommandModule } from 'yargs'
 import { info } from '../../utils/text'
+import { loadConfigFile } from '../../core'
 
 export class FinishHotfix implements CommandModule {
   public command: string = 'finish <hotfixName>'
 
   public describe: string = 'Finishes a hotfix.'
 
   public handler = (argv: Arguments): Promise<void> => {
+    if (argv.c) loadConfigFile(argv.c as string)
+
     return handleFinish(argv)
   }
 }

src/cmds/hotfix/start.ts

@@ -7,7 +7,7 @@
 
 import { exec } from 'shelljs'
 import { Arguments, CommandModule } from 'yargs'
-import { isValidBranchName } from '../../core'
+import { isValidBranchName, loadConfigFile } from '../../core'
 
 export class StartHotfix implements CommandModule {
   public command: string = 'start <hotfixName> <from>'
@@ -17,6 +17,8 @@ export class StartHotfix implements CommandModule {
   <from> should be a branch (e.g. develop), a tag (e.g. 2.3.0) or a commit (e.g. 9af345)`
 
   public handler = (argv: Arguments): void => {
+    if (argv.c) loadConfigFile(argv.c as string)
+
     if (
       isValidBranchName(argv.hotfixName) &&
       (argv.from ? isValidBranchName(argv.from) : true)

src/cmds/release/finish.ts

@@ -9,6 +9,7 @@ import { prompt } from 'inquirer'
 import { exec } from 'shelljs'
 import { Arguments, CommandModule } from 'yargs'
 import { info } from '../../utils/text'
+import { loadConfigFile } from '../../core'
 
 export class FinishRelease implements CommandModule {
   public command: string = 'finish <releaseName>'
@@ -21,6 +22,8 @@ export class FinishRelease implements CommandModule {
 }
 
 const handleFinish = async (argv: Arguments) => {
+  if (argv.c) loadConfigFile(argv.c as string)
+
   const mergeInto = argv.usedev ? argv.development : argv.main
 
   exec(`git checkout ${argv.release}/${argv.releaseName}`)

src/cmds/release/start.ts

@@ -7,7 +7,7 @@
 
 import { exec } from 'shelljs'
 import { Arguments, CommandModule } from 'yargs'
-import { isValidBranchName } from '../../core'
+import { isValidBranchName, loadConfigFile } from '../../core'
 
 export class StartRelease implements CommandModule {
   public command: string = 'start <releaseName> <from>'
@@ -17,6 +17,8 @@ export class StartRelease implements CommandModule {
   <from> should be a branch (e.g. develop) or a commit (e.g. 9af345)`
 
   public handler = (argv: Arguments): void => {
+    if (argv.c) loadConfigFile(argv.c as string)
+
     if (
       isValidBranchName(argv.releaseName) &&
       (argv.from ? isValidBranchName(argv.from) : true)

src/core.ts

@@ -50,19 +50,16 @@ export const getDefaultConfigValues = (): ConfigValues => {
  */
 export const loadConfigFile = (configFile?: string): ConfigValues => {
   if (!configFile || !test('-f', configFile)) {
-    return defaultConfigValues
+    throw new Error(`Cannot load configuration values from: ${configFile}`)
   }
 
   const configValues =
     getFileExt(configFile) === '.js'
       ? require(configFile)
       : JSON.parse(sed(/(\/\*[\w\W]+\*\/|(\/\/.*))/g, '', configFile))
 
-  if (sanityCheck(configValues)) {
-    return { ...defaultConfigValues, ...configValues }
-  } else {
-    return { ...defaultConfigValues }
-  }
+  sanityCheck(configValues)
+  return { ...defaultConfigValues, ...configValues }
 }
 
 /**
@@ -73,6 +70,8 @@ export const loadConfigFile = (configFile?: string): ConfigValues => {
 export const loadConfigValues = (): ConfigValues => {
   const configFile = findUp.sync(defaultConfigFileNames) || undefined
 
+  if (!configFile) return defaultConfigValues
+
   return loadConfigFile(configFile)
 }
 
@@ -92,7 +91,7 @@ export const writeConfigFile = ({
 }): boolean => {
   let toWrite: string
 
-  if (!sanityCheck(data)) return false
+  sanityCheck(data)
 
   switch (getFileExt(file)) {
     case '.js':
@@ -139,17 +138,23 @@ const sanityCheck = (configValues: ConfigValues): boolean => {
         case 'release':
         case 'feature':
           if (!isValidBranchName(element)) {
-            return false
+            throw new Error(
+              `${key} branch name is invalid. Value found: ${element}`
+            )
           }
           break
         case 'usedev':
           if (typeof element !== 'boolean') {
-            return false
+            throw new Error(
+              `${key} has to be either 'true' or 'false'. Value found: ${element}`
+            )
           }
           break
         case 'integration':
           if (typeof element !== 'number' || (element < 1 || element > 3)) {
-            return false
+            throw new Error(
+              `${key} has to be a number >=1 and <=3. Value found: ${element}`
+            )
           }
           break
         case 'interactive':
@@ -159,12 +164,16 @@ const sanityCheck = (configValues: ConfigValues): boolean => {
             typeof element !== 'string' ||
             !element.match(/(ask|always|never)/)
           ) {
-            return false
+            throw new Error(
+              `${key} has to be either 'ask', 'always' or 'never'. Value found: ${element}`
+            )
           }
           break
         case 'tags':
           if (typeof element !== 'boolean') {
-            return false
+            throw new Error(
+              `${key} has to be either 'true' or 'false'. Value found: ${element}`
+            )
           }
           break
       }
@@ -200,7 +209,7 @@ const defaultConfigFileName: string = 'gof.config.js'
 const defaultConfigFileNames: string[] = [
   defaultConfigFileName,
   '.gofrc.js',
-  '.gofrc.json'
+  '.gofrc'
 ]
 
 // const supportedExtensions = ['.js', '.json']

tsconfig.json

@@ -5,11 +5,13 @@
     // Search under node_modules for non-relative imports.
     "moduleResolution": "node",
     // Process & infer types from .js files.
-    "allowJs": true,
+    // "allowJs": true,
     // Don't emit; allow Babel to transform files.
     "noEmit": true,
     // Enable strictest settings like strictNullChecks & noImplicitAny.
     "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
     // Disallow features that require cross-file information for emit.
     // "isolatedModules": true,
     // Import non-ES modules as default imports.