node-tiny-template

3.0.7 • Public • Published

node-tiny-template

forthebadge

Build Status

Node Tiny Template is a command line interface for generating templated; .html, .js, .css, and ... well, any file types you like. Intially developed to aid in the creation of standardised React components and directories but can be useful in many other projects.

Create your own templates so you and your development team always start off with the same base structure; component declaration, imports, exports etc.

After all, consistancy is the key!

Getting Started

Install and save as development dependency.

Install

npm i node-tiny-template --save-dev

Config

Before you run Tiny Template make sure you have created a default config file and saved it to the root of your project.

The default config must be named:

tiny-template.config.js

You can create as many config files as you like and store them wherever you want but you'll need to tell Tiny Template about them using the -c arg

tiny-template -c "path/to/custom-config.js"

"scripts"

To run Tiny Template you'll probably need to add it to your "scripts" in 'package.json'

"scripts"{
  "tiny-template""tiny-template"
}

Useage

A simple useage example would then look like this:

npm run -- tiny-template -d "new-component"

Config continued...

In order for Tiny Template to do it's thing the config file must contain the required objects and object keys. An example configuration could look like this.

Check examples/templates for example .hbs files. These are the templates that Tiny Template will use to create each defined file from the files array in config.

const path = require('path');
 
const paths = {
    templates: 'examples/templates'
};
 
const config = {
    directory: {
        format: 'paramCase',
        output: 'examples/components'
    },
    files: [
        {
            extension: 'js',
            format: 'camelCase',
            template: `${paths.templates}/components-js.hbs`
        },
        {
            name: 'styles',
            extension: 'css',
            format: 'paramCase',
            template: `${paths.templates}/components-css.hbs`
        }
    ],
    onComplete: options => {
        console.log(options);
    }
};
 
module.exports = config;
  • directory: Object; <required>

    • format: String; <required> camelCase | constantCase | paramCase | pascalCase | snakeCase | noCase | noFormat
    • output: String; <required>
  • files: Array; <required>

    • name: String; <optional>
    • extension: String; <required>
    • format: String; <required> camelCase | constantCase | paramCase | pascalCase | snakeCase | noCase | noFormat
    • template: String; <required>
  • onComplete: Function; <optional>

    • options: Object;

onComplete

onComplete can be used to trigger something else you'd like to do after the files have been created.

options returns a number of case formatted variants of the name and directory keys. These same keys are available for use with your handlebars templates. and you can access them like this {{{name.camelCase}}} or {{{directory.constandCase}}}

  • directory

    • unformatted
    • camelCase
    • constantCase
    • paramCase
    • pascalCase
    • snakeCase
    • noCase
  • name

    • unformatted
    • formatted
    • camelCase
    • constantCase
    • paramCase
    • pascalCase
    • snakeCase
    • noCase

Handlebars.helper "raw"

If you encounter any rendering problems when attempting to template something like the following...

        <SomeComponent
            prop={some.prop}
            propObject={{
                propA: some.propA,
                propB: some.propB
            }}
        />

...where Handlebars will misinterpret the use of "double-stash" {{ or "triple-stash" {{{ You can wrap the entire template in the {{{{raw}}}} ... {{{{/raw}}}} helper.

{{{{raw}}}}
        <SomeComponent
            prop={some.prop}
            propObject={{
                propA: some.propA,
                propB: some.propB
            }}
        />
{{{{/raw}}}}

... Happy templating!

License

MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Install

npm i node-tiny-template

DownloadsWeekly Downloads

4

Version

3.0.7

License

MIT

Unpacked Size

22.6 kB

Total Files

21

Last publish

Collaborators

  • bnwan
  • pauliescanlon