Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (coz) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

coz

Flexible generator, which makes your project clean and maintainable.

// Define rendering rule.
module.exports = {
    path: 'have-a-nice-day.txt', // File path to write
    tmpl: '.have-a-nice-day.txt.hbs', // Template file
    force: true, // Overwrite each time
    mode: '444',  // As readyonly file
    data: require('./my-datasource.json') // Data to render
}

Save this as .my-first-bud.bud , then running

$ coz render ".my-first-bud.bud"

will do the magic.

About coz
Getting started
Specifications
- Bud File Specification
Links
- Website
- Tutorials
- Documents
- Reports
License
About this project
- Author
- Donation

About coz

What's This?

The basic idea of coz is that creating files from files.

Writing a meta file called .bud file.
Running coz render command.
Files will be generated!

What For?

Automation. Generating files makes your project clean and maintainable.

You can define a single datasource and distribute it in various forms.

For example,

Generate Javascript and Python entity from database definition.
Generate package.json and bower.json sharing same meta data.
Generate Web API document and Swift client entity from json schema objects.
Generate empty test case files from project files.

Why This?

Lightweight and fast
- coz does nothing bud file templating, it's very fast.
Unopinionated and flexible
- coz could be used to any kind of strings files.
- Bunch of options to manipulate files.
- Could be used by CLI or programmatically.
Simple and extensible
- coz provides ways to customize, like registering your own template engine.

Getting started

Requirements

node.js>=0.10.3

Installation

coz is available as an NPM package.

# Install coz as a global module.
$ npm install coz -g

Or you can install it without -g option and use Programmatic API. For more details, see tutorial section "01 - Installing coz".

Quickstart

.who-likes-what.txt.bud (bud file)

As you see, .bud file is actuary a JavaScript file and could be exported a Node.js module.

Save this file as .who-likes-what.txt.bud and then, run:

# Render the bud file
$ coz render ".who-likes-what.txt.bud"

This will generate a file named who-likes-what.txt.

For more details, see tutorial section "02 - Rendering bud files".

### Programmatic API

coz provides programmatic API which enables you to execute coz commands from Node.js program.

For more details, see tutorial section "04 - Using programmatic API".

Specifications

Bud File Specification

A bud contains file meta data like witch template to use, where to render it, what permission to give, and so on.

You can specify bud data by writing .bud file, which is actually a javascript file and could be written in Node.js format.

module.exports = {
    path: 'my_file.txt',
    tmpl: '.my_file.txt.hbs',
    data: require('./.my_data')
}

And bud could be an array like:

module.exports = [
    {path: 'my_file.txt', /*...*/},
    {path: 'my_other_file.txt', /*...*/},
]

Or an async function.

module.exports = function(callback){
    myAsync(function(data){
        var error = null;
        callback(err, data);
    });
}

For more details, see tutorial section "03 - Mastering coz bud".

Supported Properties

List of properties configurable in bud files.

Name	Type	Default	Description
`engine`	string\|object	'handlebars'	Template engine name or engine itself
`cwd`	string	process.cwd()	Working directory path
`data`	object		Data which template render with
`mkdirp`	boolean	false	Make parent directories if needed
`setup`	object		Optional settings for template engine
`force`	boolean	false	Should overwrite file when already exists, or not
`mode`	string\|number	'644'	Permission of generated files. (eg., '444' for readonly files)
`path`	string		Destination file path. If not provided, guess from bud file path
`tmpl`	string\|function	'json'	Template file path or registered template name or template function

License

This software is released under the MIT License.

About this project

Author

Taka Okunishi

Donation

Support this project and others by okunishinishi via gratipay.

coz