Template Generator

This project is intended to unify boilerplate code between team members and make the setup process for starting a new component shorter and less tedious.

Installation

python -m pip install TemplateCreator

Usage

python -m TemplateCreator --template shared-component --folder-name my-example

or use the short syntax

python -m TemplateCreator -t shared-component -n my-example

Components with name constructed of multiple words should be separated by '-' this will result in camel cased class name (MyExampleComponent)

Template options

--template shared-component

--template class_component

--template function_component

--template ts-function-component

--template ts-connected-component

--template state

--template ts-state

shared-component

creates 4 files:

• my-component.component.jsx
• my-component.styles.js
• my-component.readme.md
• my-component.test.jsx

class-component / function-component / ts-function-component / ts-connected-component

creates 2 files:

• my-component.component.jsx (.tsx)
• my-component.styles.scss (.tsx)

state

creates 3 files:

• my-state.reducer.js
• my-state.state.js
• my-state.actions.js

ts-state

creates 3 files:

• my-state.reducer.ts
• my-state.state.ts
• my-state.actions.ts

Add A New Template

1. Add a new template file (follow jinja2 convention) to templates folder (for example: my-new-template.jsx)

2. In template_options.py add TemplateInfo(name='my-new-template', file_name=f'{folder_name}.custom.jsx'). The name attribute should be the same as the template file name (without the extension)

3. Update template_options.py get_batch_templates_dictionary method with a key (passed in as --template parameter) and a value of list of TemplateInfo to create

Deploy new version

1. Create the version file

    python setup.py sdist

2. Deploy the newly created version

    python -m twine upload dist/TemplateCreator-${new_version}.tar.gz