feat: 🎸 configuration path

add config option to support custom configuration path

✅ Closes: #67

Author: nivekcode

README.md

@@ -80,7 +80,12 @@ you want to convert all SVG file in your current folder to TypeScript constants.
 ### Configuration in package.json or .rc file
 
 When you start using `svg-to-ts` in bigger projects, configuration may get more sophisticated. At this point command line
-arguments are hard to read. Therefore `svg-to-ts` allows you to configure it either over package.json or over a `.svg-to-tsrc` file.
+arguments are hard to read. Therefore `svg-to-ts` allows you to configure it either over `package.json` or over a `.svg-to-tsrc` file.
+
+Those files can be written in `json`, `yaml`, `yml`, `js` (CommonJS module). By default `svg-to-ts` will search up
+the directory tree for a `svg-to-ts` propert in the `package.json`, a `.svg-to-tsrc` file. However, if you are working
+in a monorepo or want to have multiple configs, you can use the `--config` property to specify a path your configuration.
+For example `svg-to-ts --config ./myconfig.json`.
 
 #### Configure svg-to-ts over package.json
 
@@ -275,7 +280,7 @@ supports code splitting which is especially usefull in scenarios where you are u
 [Here's a step by step guide on how to create an icon library that is optimized for tree shaking](https://medium.com/angular-in-depth/how-to-create-a-fully-tree-shakable-icon-library-in-angular-c5488cf9cd76)
 
 ![fully tree shakable](https://raw.githubusercontent.com/kreuzerk/svg-to-ts/master/assets/fully-treeshakable.png)
-Often, having the SVGs in a single file is enough. However if you are in a more complex environment with bigger business
+Often, having the SVGs in a single file is enough. However, if you are in a more complex environment with bigger business
 applications, you may want to make the icons even more tree shakable.
 
 In Angular, for example, having all icons in a single file shakes out the icons that are not used. However, icons always

src/bin/svg-to-ts.ts

@@ -7,7 +7,7 @@ import {
   ConstantsConversionOptions
 } from '../lib/options/conversion-options';
 import { info, printLogo } from '../lib/helpers/log-helper';
-import { setupCommander } from '../lib/options/args-collector';
+import { setupCommander } from '../lib/options/command-line-collector';
 import { convertToSingleObject } from '../lib/converters/object.converter';
 import { convertToConstants } from '../lib/converters/constants.converter';
 import { convertToFiles } from '../lib/converters/files.converter';

src/lib/options/args-collector.ts renamed to src/lib/options/command-line-collector.ts

@@ -17,6 +17,7 @@ export const setupCommander = () => {
   const collect = (value, previous) => previous.concat([value]);
   commander
     .version(packgeJSON.version)
+    .option('--config <string>', 'path to the configuration file')
     .option('-c --conversionType <ConversionType>', 'conversion type (object, constants, files)')
     .option('--objectName <string>', 'name of the exported object')
     .option('-t --typeName <string>', 'name of the generated enumeration type', DEFAULT_OPTIONS.typeName)
@@ -79,7 +80,9 @@ const toBoolean = (str: string, defaultValue: boolean): boolean => {
   return result;
 };
 
-export const collectArgumentOptions = async (): Promise<
+export const getConfigPath = (): string | undefined => commander.config;
+
+export const collectCommandLineOptions = async (): Promise<
   ConstantsConversionOptions | FileConversionOptions | ObjectConversionOptions
 > => {
   if (!commander.conversionType) {

src/lib/options/config-collector.ts

@@ -12,12 +12,14 @@ import * as packgeJSON from '../../../package.json';
 import { error, info } from '../helpers/log-helper';
 import { getSvgoConfig } from '../helpers/svg-optimization';
 import { Delimiter } from '../generators/code-snippet-generators';
+import { getConfigPath } from './command-line-collector';
 
 export const collectConfigurationOptions = async (): Promise<
   ConstantsConversionOptions | FileConversionOptions | ObjectConversionOptions | null
 > => {
   const explorerSync = cosmiconfigSync(packgeJSON.name);
-  const cosmiConfigResult = explorerSync.search();
+  const configPath = getConfigPath();
+  const cosmiConfigResult = configPath ? explorerSync.load(configPath) : explorerSync.search();
   cosmiConfigResult ? info(`Configuration found under: ${cosmiConfigResult.filepath}`) : info('No config found');
   return cosmiConfigResult ? await mergeWithDefaults(cosmiConfigResult.config) : null;
 };

src/lib/options/conversion-options.ts

@@ -1,5 +1,5 @@
 import { collectConfigurationOptions } from './config-collector';
-import { collectArgumentOptions } from './args-collector';
+import { collectCommandLineOptions } from './command-line-collector';
 
 import { info } from '../helpers/log-helper';
 import { Delimiter } from '../generators/code-snippet-generators';
@@ -60,5 +60,5 @@ export const getOptions = async (): Promise<
   info(
     'No configuration found in package.json nor rc file - checking for arguments and applying defaults (see --help)'
   );
-  return collectArgumentOptions();
+  return collectCommandLineOptions();
 };