https://github.com/maxleiko/grunt-templato

Overall project template management using Grunt
https://github.com/maxleiko/grunt-templato

Last synced: 7 days ago
JSON representation

Overall project template management using Grunt

• Host: GitHub
• URL: https://github.com/maxleiko/grunt-templato
• Owner: maxleiko
• License: mit
• Created: 2014-01-10T10:54:20.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2016-02-21T17:02:31.000Z (over 8 years ago)
• Last Synced: 2024-10-11T18:08:44.810Z (about 1 month ago)
• Language: JavaScript
• Size: 152 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# grunt-templato

> Overall project template management using Grunt

## Getting Started

This plugin requires Grunt `~0.4.2`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

npm install grunt-templato --save-dev

```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js

grunt.loadNpmTasks('grunt-templato');

```

## The "templato" task

### Overview

In your project's Gruntfile, add a section named `templato` to the data object passed into `grunt.initConfig()`.

```js

grunt.initConfig({

  templato: {

    // exemple config with a JSON file 

    jsonConfig: {

      files: {

        'dest/path': 'src/path' // if 'src/path' is a folder, then all files below will be processed recursively

                                // and folder tree structure will be kept in the dest/path folder

      },

      values: grunt.file.readJSON('your/config.json') // you can use an external config.json file

    },

    // another example without the external JSON file

    defaultConfig: {

      files: {

        'tmp/fixtures/myProject': 'test/fixtures/myProject'

      },

      values: { // or use in-file configurations =)

        fooTitle: 'My title',

        PORT: 8042,

        list: {

          one: 1,

          two: 'secondOne'

        },

        dummyLog: 'some fake log'

      }

    }

  }

});

```

### Options

TODO

### Usage Examples

Once you have set up a **src** & **dest** path, if you run the task `grunt templato` it will generate in your **dest** folder the same files pointed out by **src** but processed by the template engine.  

```js

  files: {

    'dest/path': 'src/path' // if 'src/path' is a folder, then all files below will be processed recursively

                            // and folder tree structure will be kept in the dest/path folder

  },

```

Meaning that you have access to all the **values** you have given to `templato` in your files (pointed by your **src** folder) through the use of `<%= VAR_NAME %>`

```html

    <%= fooTitle %>

    


        
<%= list.one %>

        
<%= list.two %>

    


```

or 

```java

public class Potato {

    private String PORT = "<%= PORT %>";

}

```

or

```js

var dummy = require('dummy');

console.log('index.js > <%= dummyLog %>');

```

#### Custom Options

TODO

## Contributing

## Release History

_10/01/2014 - v0.0.1_