feat: load modelina configuration options from a config file

examples/get-config-from-file/README.md

@@ -0,0 +1,17 @@
+# Get config from file
+
+An example of using the `getConfigFromFile` function. We get the config from a file and pass it to a `TypescriptGenerator`
+
+## How to run this example
+
+Run this example using:
+
+```sh
+npm i && npm run start
+```
+
+If you are on Windows, use the `start:windows` script instead:
+
+```sh
+npm i && npm run start:windows
+```

examples/get-config-from-file/index.spec.ts

@@ -0,0 +1,13 @@
+const spy = jest.spyOn(global.console, 'log').mockImplementation(() => {
+  return;
+});
+
+describe('Should be able to render', () => {
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+  test('and should log expected output to console', () => {
+    expect(spy.mock.calls.length).toEqual(1);
+    expect(spy.mock.calls[0]).toMatchSnapshot();
+  });
+});

examples/get-config-from-file/index.ts

@@ -0,0 +1,29 @@
+import { FileHelpers, TypeScriptGenerator, TypeScriptOptions } from '../../src';
+
+const jsonSchemaDraft7 = {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    email: {
+      type: 'string',
+      format: 'email'
+    }
+  }
+};
+
+async function main() {
+  try {
+    const config: { config: TypeScriptOptions } =
+      await FileHelpers.getConfigFromFile('./modelina.config.alternate.js');
+    const tsGen = new TypeScriptGenerator(config.config);
+    const models = await tsGen.generate(jsonSchemaDraft7);
+    for (const model of models) {
+      console.log(model.result);
+    }
+  } catch (err) {
+    console.log(err);
+  }
+}
+
+main();

examples/get-config-from-file/modelina.config.alternate.js

@@ -0,0 +1,48 @@
+import {
+  TS_COMMON_PRESET,
+  IndentationTypes,
+  TypeScriptOptions
+} from '../../src';
+
+/** @type {TypeScriptOptions} */
+const config = {
+  enumType: 'union',
+  modelType: 'interface',
+  indentation: {
+    size: 10,
+    type: IndentationTypes.SPACES
+  },
+  mapType: 'record',
+  renderTypes: false,
+  moduleSystem: 'CJS',
+  constraints: {
+    modelName: (context) => {
+      return `Custom${context.modelName}`;
+    },
+    propertyKey: (context) => {
+      return `custom_prop_${context.objectPropertyModel.propertyName}`;
+    }
+  },
+  typeMapping: {
+    Any: (context) => {
+      // Always map AnyModel to number
+      return 'number';
+    }
+  },
+  presets: [
+    {
+      preset: TS_COMMON_PRESET,
+      options: {
+        example: true
+      }
+    },
+    {
+      preset: TS_COMMON_PRESET,
+      options: {
+        marshalling: true
+      }
+    }
+  ]
+};
+
+export { config };

examples/get-config-from-file/modelina.config.js

@@ -0,0 +1,48 @@
+import {
+  TS_COMMON_PRESET,
+  IndentationTypes,
+  TypeScriptOptions
+} from '../../src';
+
+/** @type {TypeScriptOptions} */
+const config = {
+  enumType: 'union',
+  modelType: 'class',
+  indentation: {
+    size: 10,
+    type: IndentationTypes.SPACES
+  },
+  mapType: 'record',
+  renderTypes: false,
+  moduleSystem: 'CJS',
+  constraints: {
+    modelName: (context) => {
+      return `Custom${context.modelName}`;
+    },
+    propertyKey: (context) => {
+      return `custom_prop_${context.objectPropertyModel.propertyName}`;
+    }
+  },
+  typeMapping: {
+    Any: (context) => {
+      // Always map AnyModel to number
+      return 'number';
+    }
+  },
+  presets: [
+    {
+      preset: TS_COMMON_PRESET,
+      options: {
+        example: true
+      }
+    },
+    {
+      preset: TS_COMMON_PRESET,
+      options: {
+        marshalling: true
+      }
+    }
+  ]
+};
+
+export { config };

examples/get-config-from-file/package.json

@@ -0,0 +1,10 @@
+{
+  "config" : { "example_name" : "get-config-from-file" },
+  "scripts": {
+    "install": "cd ../.. && npm i",
+    "start": "../../node_modules/.bin/ts-node --cwd ../../ ./examples/$npm_package_config_example_name/index.ts",
+    "start:windows": "..\\..\\node_modules\\.bin\\ts-node --cwd ..\\..\\ .\\examples\\%npm_package_config_example_name%\\index.ts",
+    "test": "../../node_modules/.bin/jest --config=../../jest.config.js ./examples/$npm_package_config_example_name/index.spec.ts",
+    "test:windows": "..\\..\\node_modules\\.bin\\jest --config=..\\..\\jest.config.js examples/%npm_package_config_example_name%/index.spec.ts"
+  }
+}

src/helpers/FileHelpers.ts

@@ -64,4 +64,18 @@ export class FileHelpers {
       }
     });
   }
+
+  static async getConfigFromFile(configPath: string): Promise<any> {
+    const configFilePath = path.resolve(configPath);
+    try {
+      await fs.stat(configFilePath);
+    } catch (err) {
+      throw new Error(
+        `No file exists on the specified location ${configFilePath}`
+      );
+    }
+
+    const configOptions = require(configFilePath);
+    return configOptions;
+  }
 }