Back to home

create-lift-module/

basic

Version: Unknown

Last Updated: Unknown

Basic Lift Template

Use this template to generate new basic Lift module templates.

Required

Variable	Data Type	Info
`type`	`string`	The name of the Lift folder type
`pkg`	`string`	The name of the package
`description`	`string`	description of command

Usage

In the folder, you have the following files:

File	Does
`README.md`	Info on this template starter. Will generate nothing.
`[name].md.ejs-template`	Will output `[name].md.ejs` for use.
`[name].ts.ejs-template`	Will output `[name].ts.ejs` for use.
`[pkg].ts.ejs`	Will output `[pkg].ts` to demo template generation.
`README.md.ejs`	Will output `README.md` to demo template generation.
`index.ts.ejs`	Will output `index.ts` to demo template generation.

Module files

1# <%= _.upperFirst(type) %> - <%= _.upperFirst(pkg) %>
2
3Use this template to <%= description %>
4
5## Required
6
7TODO: Update this section
8
9| **Variable** | **Data Type** | **Info**                         |
10| ------------ | ------------- | -------------------------------- |
11| `type`       | `string`      | The name of the Lift folder type |
12| `pkg`        | `string`      | The name of the package          |

1# Example scaffold for <%= name %>
2
3## Table
4
5Fields 		| Value
6---			| ---
7name 		| <%= name %>
8age 		| <%= age %>

1/**
2 * <%= _.camelCase(name) %> helper function.
3 * 
4 * @returns {void} undefined response
5 */
6export const <%= _.camelCase(name) %> = (): void => {
7    console.log(`Ready for <%= _.camelCase(name) %>`)
8}

1/**
2 * <%= type %> <%= pkg %> helper function.
3 * 
4 * @returns {void} undefined response
5 */
6export const <%= _.camelCase(`${type} ${pkg}`) %> = (): void => {
7    console.log(`Ready for <%= type %> <%= pkg %>`)
8}

1import { <%= _.camelCase(`${type} ${pkg}`) %> } from './<%= pkg %>'
2
3<%= _.camelCase(`${type} ${pkg}`) %>()

Install

Lift generate

Repository

https://github.com/okeeffed/pkg-lift-create-lift-module

Sections

Required

Usage

Module files