Merge pull request #28 from treatwell/add-config-flag-to-override-def…

…ault-location

feat: add option to override default config file location

src/commands/add.ts

@@ -1,27 +1,36 @@
-import cli from 'cli-ux';
-import { Command } from '@oclif/command';
-import kleur from 'kleur';
+import { Command, flags } from '@oclif/command';
 
 import { MasterFile } from '../models';
 import { MasterFileAlreadyExistsError } from '../errors';
+import cli from 'cli-ux';
+import kleur from 'kleur';
 
 export default class Add extends Command {
   static description = 'create and push a new master language file';
 
   static args = [{ name: 'masterFile' }];
 
+  static flags = {
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
+  };
+
   static usage = '$ wti add locales/en/translation.json';
 
   async run() {
     const {
       args: { masterFile },
+      flags: { configPath }
     } = this.parse(Add);
 
     if (masterFile) {
       cli.action.start(`Adding ${masterFile} as a master file...`);
 
       try {
-        await MasterFile.create(masterFile);
+        await MasterFile.create(masterFile, configPath);
 
         cli.action.stop();
 

src/commands/addLocale.ts

@@ -1,26 +1,35 @@
-import cli from 'cli-ux';
-import { Command } from '@oclif/command';
-import kleur from 'kleur';
+import { Command, flags } from '@oclif/command';
 
 import { Locale } from '../models';
+import cli from 'cli-ux';
+import kleur from 'kleur';
 
 export default class AddLocale extends Command {
   static description = 'add a new locale to the project';
 
   static args = [{ name: 'locale' }];
 
+  static flags = {
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
+  };
+
   static usage = '$ wti addLocale fr';
 
   async run() {
     const {
       args: { locale },
+      flags: { configPath }
     } = this.parse(AddLocale);
 
     if (locale) {
       cli.action.start(`Adding ${locale} as a locale...`);
 
       try {
-        await new Locale(locale).create();
+        await new Locale(locale).create(configPath);
 
         cli.action.stop(
           `${kleur.green('[SUCCESS]')} Locale ${locale} is being added`

src/commands/init.ts

@@ -1,22 +1,31 @@
-import cli from 'cli-ux';
-import { Command } from '@oclif/command';
+import { Command, flags } from '@oclif/command';
+import { getConfig, initialConfig, updateConfig } from '../helpers';
 
 import { ConfigNotFoundError } from '../errors';
-import { getConfig, updateConfig, initialConfig } from '../helpers';
+import cli from 'cli-ux';
 
 export default class Init extends Command {
   static description = 'configure the project to sync with';
 
+  static flags = {
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
+  };
+
   async run() {
+    const { flags: { configPath } } = this.parse(Init);
     let config = initialConfig;
 
     try {
       // get config object
-      config = await getConfig();
+      config = await getConfig(configPath);
     } catch (err) {
       // if it doesn't exist, create an empty one
       if (err instanceof ConfigNotFoundError) {
-        await updateConfig(config);
+        await updateConfig(config, configPath);
       }
     } finally {
       // if apiKey is set, ask if it's ok to override it
@@ -39,7 +48,7 @@ export default class Init extends Command {
         project: {
           apiKey,
         },
-      });
+      }, configPath);
 
       cli.action.stop();
     }

src/commands/pull.ts

@@ -1,14 +1,23 @@
-import { Command } from '@oclif/command';
-import kleur from 'kleur';
-import Listr from 'listr';
+import { Command, flags } from '@oclif/command';
+import { MasterFile, Project } from '../models';
 
-import { Project, MasterFile } from '../models';
+import Listr from 'listr';
+import kleur from 'kleur';
 
 export default class Pull extends Command {
   static description = 'pull target language file(s)';
 
+  static flags = {
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
+  };
+
   async run() {
-    const { projectFiles } = await Project.init();
+    const { flags: { configPath } } = this.parse(Pull);
+    const { projectFiles } = await Project.init(configPath);
 
     let masterFile = projectFiles.filter(
         (file) => file.master_project_file_id === null
@@ -20,7 +29,7 @@ export default class Pull extends Command {
         (acc, current) =>
           acc.concat({
             title: `Pulling ${current.name}`,
-            task: async () => await new MasterFile(masterFileId).show(current),
+            task: async () => await new MasterFile(masterFileId).show(current, configPath),
           }),
         [] as Listr.ListrTask<Listr.ListrContext>[]
       )

src/commands/push.ts

@@ -1,7 +1,7 @@
-import cli from 'cli-ux';
 import { Command, flags } from '@oclif/command';
+import { MasterFile, Project } from '../models';
 
-import { Project, MasterFile } from '../models';
+import cli from 'cli-ux';
 
 export default class Push extends Command {
   static description = 'push master language file';
@@ -22,11 +22,16 @@ export default class Push extends Command {
       // may be reversed with --no-ignore-missing to obsolete missing strings
       allowNo: true,
     }),
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
   };
 
   async run() {
-    const { projectFiles } = await Project.init();
-    const { flags } = this.parse(Push);
+    const { flags : { configPath, ...flags } } = this.parse(Push);
+    const { projectFiles } = await Project.init(configPath);
 
     let masterFile = projectFiles.filter(
       (file) => file.master_project_file_id === null
@@ -37,7 +42,8 @@ export default class Push extends Command {
     await new MasterFile(masterFile.id).update(
       masterFile.name,
       masterFile.locale_code,
-      flags
+      flags,
+      configPath
     );
 
     cli.action.stop(

src/commands/rm.ts

@@ -1,19 +1,28 @@
+import { Command, flags } from '@oclif/command';
+import { MasterFile, Project } from '../models';
+
 import cli from 'cli-ux';
-import { Command } from '@oclif/command';
 import kleur from 'kleur';
 
-import { MasterFile, Project } from '../models';
-
 export default class Rm extends Command {
   static description = 'delete a master language file from a project';
 
   static args = [{ name: 'masterFile' }];
 
+  static flags = {
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
+  };
+
   static usage = '$ wti rm locales/en/translation.json';
 
   async run() {
     const {
       args: { masterFile },
+      flags: { configPath }
     } = this.parse(Rm);
 
     // TODO: inquirer to list master language files
@@ -24,7 +33,7 @@ export default class Rm extends Command {
 
       if (remove) {
         cli.action.start(`Removing ${masterFile}..`);
-        const { projectMasterFiles } = await Project.init();
+        const { projectMasterFiles } = await Project.init(configPath);
 
         const masterFileResult = projectMasterFiles.find(
           (file) => file.name === masterFile
@@ -41,7 +50,7 @@ export default class Rm extends Command {
           process.exit(1);
         }
 
-        await new MasterFile(masterFileResult.id).remove();
+        await new MasterFile(masterFileResult.id).remove(configPath);
 
         cli.action.stop();
       }

src/commands/rmLocale.ts

@@ -1,26 +1,35 @@
-import cli from 'cli-ux';
-import { Command } from '@oclif/command';
-import kleur from 'kleur';
+import { Command, flags } from '@oclif/command';
 
 import { Locale } from '../models';
+import cli from 'cli-ux';
+import kleur from 'kleur';
 
 export default class RmLocale extends Command {
   static description = 'delete a locale from a project';
 
   static args = [{ name: 'locale' }];
 
+  static flags = {
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
+  };
+
   static usage = '$ wti rmLocale fr';
 
   async run() {
     const {
       args: { locale },
+      flags: { configPath }
     } = this.parse(RmLocale);
 
     if (locale) {
       cli.action.start(`Removing ${locale} as a locale...`);
 
       try {
-        await new Locale(locale).remove();
+        await new Locale(locale).remove(configPath);
 
         cli.action.stop(
           `${kleur.green('[SUCCESS]')} Locale ${locale} is being removed`

src/commands/status.ts

@@ -1,19 +1,28 @@
-import cli from 'cli-ux';
-import { Command } from '@oclif/command';
-import kleur from 'kleur';
+import { Command, flags } from '@oclif/command';
 
 import { Status as StatusModel } from '../models';
+import cli from 'cli-ux';
+import kleur from 'kleur';
 
 export default class Status extends Command {
   static description = 'fetch and display project statistics';
 
+  static flags = {
+    configPath: flags.string({
+      name: 'configPath',
+      required: false,
+      description: 'Path to wti-config.json file. If not provided, default to git root directory.'
+    })
+  };
+
   static usage = '$ wti status';
 
   async run() {
     cli.action.start(`Loading statistics...`);
+    const { flags: { configPath } } = this.parse(Status);
 
     try {
-      const stats = await new StatusModel().fetch();
+      const stats = await new StatusModel().fetch(configPath);
       cli.action.stop();
 
       const locales = Object.keys(stats);

src/helpers/config.ts

@@ -1,13 +1,13 @@
-import fs from 'fs';
-import path from 'path';
-import gitRootDir from 'git-root-dir';
-
 import {
   ConfigNotFoundError,
-  NotGitDirectoryError,
   ConfigUpdateError,
+  NotGitDirectoryError,
 } from '../errors';
 
+import fs from 'fs';
+import gitRootDir from 'git-root-dir';
+import path from 'path';
+
 interface Config {
   project: {
     apiKey: string;
@@ -22,24 +22,30 @@ export const initialConfig: Config = {
 
 /**
  * Return the path of the config file
+ *
+ * @param pathParam path to the config file if defined in the command. Overrides the default git root dir
  */
-export const getConfigPath = async () => {
+export const getConfigPath = async (pathParam?: string) => {
+  if (pathParam) {
+    return path.join(process.cwd(), pathParam);
+  }
+
   const rootDir = await gitRootDir(process.cwd());
 
   if (rootDir) {
-    const configFilePath = path.join(rootDir, CONFIG_NAME);
-
-    return Promise.resolve(configFilePath);
+    return path.join(rootDir, CONFIG_NAME);
   }
 
   throw new NotGitDirectoryError();
 };
 
 /**
  * Return the config as a JSON object
+ *
+ * @param pathParam path to the config file if defined in the command. Overrides the default git root dir
  */
-export const getConfig = async () => {
-  const configPath = await getConfigPath();
+export const getConfig = async (pathParam?: string) => {
+  const configPath = await getConfigPath(pathParam);
 
   if (fs.existsSync(configPath)) {
     return (await require(configPath)) as Config;
@@ -52,9 +58,10 @@ export const getConfig = async () => {
  * Update the config object
  *
  * @param newConfig new config object to write to file
+ * @param pathParam path to the config file if defined in the command. Overrides the default git root dir
  */
-export const updateConfig = async (newConfig: Config) => {
-  const configPath = await getConfigPath();
+export const updateConfig = async (newConfig: Config, pathParam?: string) => {
+  const configPath = await getConfigPath(pathParam);
 
   fs.writeFile(configPath, JSON.stringify(newConfig, null, 2), (err) => {
     if (err) throw new ConfigUpdateError(String(err));