Load local parameters from a yaml-file too.

This way complex nested data structures can be loaded to the templating engine.

Author: kivilahtio

hygen.io/docs/generators.md

@@ -113,6 +113,14 @@ to: app/emails/<%= name %>.html
 
 Try making the text variant yourself by editing `text.ejs.t`. Note: you want to put it in the correct place with `to:`.
 
+## Configuration file
+
+You can load complex data structures to the template engine from a configuration file.
+
+```
+$ hygen mailer new --configfile config.yaml
+```
+
 ## Interactive Prompt
 
 To create an interactive generator, add `prompt.js` file to the generator root directory.

src/__tests__/fixtures/templates/configfile/configfile.yaml

@@ -0,0 +1,7 @@
+---
+
+comparisons:
+  good: 1
+  better: 2
+  best: 3
+  bestest: 4

src/__tests__/params.spec.ts

@@ -1,5 +1,5 @@
 import path from 'path'
-import params from '../params'
+import {configfile, params } from '../params'
 
 const fixture = (...segments) =>
   path.join(__dirname, 'fixtures', 'templates', ...segments)
@@ -54,3 +54,17 @@ describe('params', () => {
     })
   })
 })
+
+describe('local parameters can be loaded from a yaml file', () => {
+  it('should resolve yaml file', () => {
+    const configContents = configfile(fixture("configfile","configfile.yaml"))
+    expect(configContents).toEqual({
+      comparisons: {
+        good: 1,
+        better: 2,
+        best: 3,
+        bestest: 4
+      }
+    })
+  })
+})

src/engine.ts

@@ -1,6 +1,6 @@
 import fs from 'fs-extra'
 import type { ActionResult, RunnerConfig } from './types'
-import params from './params'
+import { params, configfile } from './params'
 
 class ShowHelpError extends Error {
   constructor(message: string) {
@@ -23,8 +23,9 @@ Usage:
   hygen [option] GENERATOR ACTION [--name NAME] [data-options]
 
 Options:
-  -h, --help # Show this message and quit
-  --dry      # Perform a dry run.  Files will be generated but not saved.`)
+  -h, --help   # Show this message and quit
+  --dry        # Perform a dry run.  Files will be generated but not saved.
+  --configfile # Load this file as the local parameters for the template`)
     process.exit(0)
   }
 
@@ -39,6 +40,7 @@ Options:
 
   logger.log(`Loaded templates: ${templates.replace(`${cwd}/`, '')}`)
   if (!(await fs.exists(actionfolder))) {
+    console.log(actionfolder)
     throw new ShowHelpError(`I can't find action '${action}' for generator '${generator}'.
 
       You can try:
@@ -48,6 +50,9 @@ Options:
       Check out the quickstart for more: https://hygen.io/docs/quick-start
       `)
   }
+  if (args.configfile) {
+    config.localsDefaults = configfile(args.configfile)
+  }
 
   // lazy loading these dependencies gives a better feel once
   // a user is exploring hygen (not specifying what to execute)

src/params.ts

@@ -2,6 +2,7 @@ import path from 'path'
 import yargs from 'yargs-parser'
 import fs from 'fs-extra'
 import type { ParamsResult, RunnerConfig } from './types'
+import YAML from 'yaml'
 
 import prompt from './prompt'
 export const DEFAULT_ACTION = '_default'
@@ -44,7 +45,7 @@ const resolvePositionals = async (templates: string, args: string[]) => {
   return [generator, action, name]
 }
 
-const params = async (
+export const params = async (
   { templates, createPrompter }: RunnerConfig,
   externalArgv: string[],
 ): Promise<ParamsResult> => {
@@ -86,4 +87,7 @@ const params = async (
   return args
 }
 
-export default params
+export const configfile = (configfile: string) => {
+  const file = fs.readFileSync(configfile, 'utf8')
+  return YAML.parse(file)
+}

src/types.ts

@@ -52,4 +52,5 @@ export type ParamsResult = {
   actionfolder?: string
   name?: string
   dry?: boolean
+  configfile?: string
 } & object