@universal-packages/template-populator

Template Populator

For that well known thing that some libraries do to initialize a project by populating a directory with a boilerplate of files with your project name all over the place, that what this does, exactly the part where the template files are transferred and processed.

Install

npm install @universal-packages/template-populator

Global methods

populateTemplates(fromLocation: string, toLocation: string, [options])

Reads deeply into a template directory structure and reconstructs it in another location processing the template files

import { populateTemplates } from '@universal-packages/template-populator'

async function test() {
  await populateTemplates('./templates', 'project/directory')
}

test()

Lets say ./templates looks like this in disk:

templates
  |- app
    |- App.js.template
    |- models
      |- User.js.template
  |- config
    |- db.json.template
    |- secrets
      |- api.yaml.template

We will end up with something like

project/directory
  |- app
    |- App.js
    |- models
      |- User.js
  |- config
    |- db.json
    |- secrets
      |- api.yaml

Options

• override boolean If the file already exists in the destination location, should it be override or should it be let alone

• replacementVariables string[] Provide variables to be replaced in the template files with the format {{ variable }}

  export class {{ className }} extends {{ classExtension }} {
    ...
  }
  

• templateExtension string By default .template files are going to be the ones being mapped, but you can change which extension should be used.

transferTemplateFile(fromLocation: string, toLocation: string, [options])

Reads the specified template file replace any variables in it and save it to the destination location. So basically handles just one file.

import { transferTemplateFile } from '@universal-packages/template-populator'

async function test() {
  await transferTemplateFile('./templates/App.js.template', 'project/directory/App.js')
}

Options

• override boolean If the file already exists in the destination location, should i be override or should it be let alone

• replacementVariables string[] Provide variables to be replaced in the template files with the format {{ variable }}

  export class {{ className }} extends {{ classExtension }} {
    ...
  }
  

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

• Code of Conduct
• Contributing Guide

License

MIT licensed.