plexiform

Plexiform

v1.1.0

In this document
Introduction
Not a module
Getting started
Contribute
Version history

Introduction

Plexiform is a rudimentary code generator.

It doesn't know any language, nor does it know how to reverse-engineer anything. It's really just a simple formalisation of JavaScript template literals, to expose a basic templating system.

But that's still incredibly useful, as it takes the effort and risk out of any repetitious task.

Perfect the code elsewhere, then use this to churn out more code than you could bear to hand-crank!

Not a module

Please note that this is not actually a usable Node module. It is a Node script for running in the shell.

I have published it to npm to make it easier to find.

I apologise if this is 'not the done thing' - please forgive a first-timer :)

Getting started

• npm install -g plexiform
• OR clone the repo
• Define a JSON config file to represent whatever it is you are building. No special format required - but your templates will be entirely driven from this.
• Turn your perfect code files into templates.
• Write a build script which applies your templates to your config - e.g. iterates over config collections and saves the output.
• Clear any existing output files clear (Win), ./clear (Mac)
• Execute the build build builds\_boilerplate configs\_boilerplate (Win), ./build builds/_boilerplate configs/_boilerplate (Mac)
• OR (if npm install -g) plexiform builds/_boilerplate configs/_boilerplate (Any)

See the included boilerplate example to get you started

Contribute

• Please use this, and improve it.
• Contact me [e-mail].
• Write a tutorial.
• Visit the website (not yet built) for latest information.

Version history

Date	Version	Author	Details
2017-08-03	v0.0.0	Raith	Initiated
2017-08-04	v0.0.1	Raith	Named and stabilised
2017-08-24	v0.1.1	Raith	Updates
2017-08-28	v1.0.0	Raith	Published to npm
2017-08-28	v1.1.0	Raith	Fixed paths so can run as 'plexiform' bin in shell