# template-gen

> A flexible template generator for any project

Latest version **2.1.0** (published 2018-03-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install template-gen
pnpm add template-gen
yarn add template-gen
bun add template-gen
```

Provides the command `tg`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2018-03-18 |
| First published | 2018-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 6 |
| Unpacked size | 45.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | w3tec.ch |
| Maintainers | dweber019 |
| Keywords | template, generator |

## Links

- npm: https://www.npmjs.com/package/template-gen
- Repository: https://github.com/w3tecch/template-gen
- Issues: https://github.com/w3tecch/template-gen/issues
- npm.io page: https://npm.io/package/template-gen

## Dependencies (6)

- [glob](https://npm.io/package/glob.md) ^7.1.2
- [chalk](https://npm.io/package/chalk.md) ^2.3.2
- [figlet](https://npm.io/package/figlet.md) ^1.2.0
- [prompts](https://npm.io/package/prompts.md) ^0.1.8
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [mustache](https://npm.io/package/mustache.md) ^2.3.0

## Recent versions

- 2.1.0 (latest) — 2018-03-18
- 2.0.0 — 2018-03-18
- 1.5.0 — 2018-03-17
- 1.4.0 — 2018-03-17
- 1.3.0 — 2018-03-17
- 1.2.0 — 2018-03-17

## README

<p align="center">
  <img src="./w3tec-logo.png" alt="w3tec" width="400" />
</p>

<h1 align="center">Template Generator</h1>

<p align="center">
  <a href="https://david-dm.org/w3tecch/template-gen">
    <img src="https://david-dm.org/w3tecch/template-gen/status.svg?style=flat" alt="dependency" />
  </a>
  <a href="https://travis-ci.org/w3tecch/template-gen">
    <img src="https://travis-ci.org/w3tecch/template-gen.svg?branch=master" alt="travis" />
  </a>
  <a href="https://ci.appveyor.com/project/dweber019/template-gen/branch/master">
    <img src="https://ci.appveyor.com/api/projects/status/757wmb09thw1bhr4/branch/master?svg=true&passingText=Windows%20passing&pendingText=Windows%20pending&failingText=Windows%20failing" alt="appveyor" />
  </a>
</p>

<p align="center">
  <b>A delightful way to have a flexible template generator for all sorts of templates</b></br>
  Heavily inspired by <a href="https://github.com/angular/angular-cli/wiki/generate">Angular CLI</a> and the <a href="http://aurelia.io/docs/build-systems/aurelia-cli#generators">Aurelia CLI</a>.<br>
  <sub>Made with ❤️ by <a href="https://github.com/w3tecch">w3tech</a>, <a href="https://www.linkedin.com/in/david-weber-6a0819b7/">David Weber</a> and <a href="https://github.com/w3tecch/template-gen/graphs/contributors">contributors</a></sub>
</p>

<br />

## ❯ Why

It's tedious to always copy & past the same file or file content over and over again. In addition the content has be clean up over and over because mostly we need a clean version of the content. This module can be used as a cli or integrated into any node based project.

## ❯ Table of Contents

- [Installation](#-installation)
- [Getting Started](#-getting-started)
- [RC configuration](#-rc-configuration)

## ❯ Installation

### As global CLI
You can install this module globally by
```shell
npm install -g template-gen
```

Have a look at [RC configuration](#-RC-configuration) how you can setup a template path.

### As project dependency
Add this module to your project dependencies
```shell
npm install template-gen --save-dev
```

then add the following entry to your npm scripts
```json
{
    "tg": "tg -d ./templates"
}
```

## ❯ Getting Started

### Setup a template file

First you need to create a template folder. We recommend to use `templates` as name as this module will look for this folder automatically.
```shell
mkdir templates
```
> Alternatively you can pass the template path with parameter as shown in the installation instructions.

<br>

Next we need a template file. Create a file (e.g. `controller.js`) within the `templates` folder with the following content
```javascript
module.exports = {
    name: 'Controller',
    description: 'Creating a controller',
    target: 'controllers',
    wrapFolder: params => `${params.controller.toLowerCase()}`,
    parameters: [
        {
            type: 'text',
            name: 'controller',
            message: 'Whats the controller name?'
        },
        {
            type: 'confirm',
            name: 'haveConstructor',
            message: 'With a constructor?'
        }
    ],
    files: [
        {
            template: params => {
                return `export default class ${params.controller} {
    someAttribute = '';` +
                    (params.haveConstructor ? `

    constructor () {

    }` : '') +
                    `
}
`;
            },
            fileName: params => `${params.controller}Controller.ts`
        },
        {
            template: () => '<template></template>',
            fileName: params => `${params.controller}Controller.html`
        }
    ]
}
```
> Don't forget to create the `controllers` folder

<br>

| Attribute      | Description |
| -------------- | ----------- |
| name           | The name to enter or select in the CLI |
| description    | Will be shown after you selected the name in the CLI |
| target         | The target directory from the root where the file will be created in |
| wrapFolder     | Should be undefined or a function which returns the parent folder name |
| parameters     | The CLI prompts to ask the user, you can use this [prompts](https://github.com/terkelg/prompts) options |
| files.template | The content of the generated file |
| files.fileName | The file name of the generated file |

> The parameters attribute can be a object or an array of [prompts](https://github.com/terkelg/prompts) options.

### Usage
With the above example setup you can now run
```shell
npm run tg
```

Then you will be asked for the template parameters and finally create the file.

### Use Parameters
If you have template like the above with name `Controller` and prompt `controller` then you could use this to execute without prompts
```shell
npm run tg -- Controller --controller User --haveConstructor true
```

Or just if you just like to create a controller with prompts
```shell
npm run tg Controller
```

## ❯ RC configuration
In you project root you can create a file named `.tgrc` to configure you template path
```shell
{
    "path": "./templates"
}
```


## ❯ Related Projects

- [aurelia-typescript-boilerplate](https://github.com/w3tecch/aurelia-typescript-boilerplate) - An Aurelia starter kit with TypeScript
- [express-typescript-boilerplate](https://github.com/w3tecch/express-typescript-boilerplate) - An express starter kit with TypeScript

## ❯ License

[MIT](/LICENSE)

---
_Source: https://npm.io/package/template-gen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._