coz-bud
Version:
bud for coz
122 lines (75 loc) • 3.23 kB
Markdown
coz-bud
==========
<!---
This file is generated by ape-tmpl. Do not update manually.
--->
<!-- Badge Start -->
<a name="badges"></a>
[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]
[bd_repo_url]: https://github.com/coz-labo/coz-bud
[bd_travis_url]: http://travis-ci.org/coz-labo/coz-bud
[bd_travis_shield_url]: http://img.shields.io/travis/coz-labo/coz-bud.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/coz-labo/coz-bud
[bd_travis_com_shield_url]: https://api.travis-ci.com/coz-labo/coz-bud.svg?token=
[bd_license_url]: https://github.com/coz-labo/coz-bud/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/coz-labo/coz-bud
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/coz-labo/coz-bud.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/coz-labo/coz-bud.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/coz-labo/coz-bud
[bd_gemnasium_shield_url]: https://gemnasium.com/coz-labo/coz-bud.svg
[bd_npm_url]: http://www.npmjs.org/package/coz-bud
[bd_npm_shield_url]: http://img.shields.io/npm/v/coz-bud.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
<!-- Badge End -->
<!-- Description Start -->
<a name="description"></a>
bud for coz
<!-- Description End -->
<!-- Sections Start -->
<a name="sections"></a>
<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->
<a name="section-doc-guides-02-usage-md"></a>
Usage
----
### Create a new bud.
```javascript
'use strict'
const bud = require('bud')
bud({})
```
<!-- Section from "doc/guides/02.Usage.md.hbs" End -->
<!-- Section from "doc/guides/03.Spec.md.hbs" Start -->
<a name="section-doc-guides-03-spec-md"></a>
Specification
-------------
## Supported Properties
List of properties configurable in bud files.
| Name | Type | Default | Description |
| ----- | ----- | ----- | ----- |
| `` | string|object | 'handlebars' | Template engine name or engine itself |
| `` | string | process.cwd() | Working directory path |
| `` | object | | Data which template render with |
| `` | boolean | false | Make parent directories if needed |
| `` | object | | Optional settings for template engine |
| `` | boolean | false | Should overwrite file when already exists, or not |
| `` | string|number | '644' | Permission of generated files. (eg., '444' for readonly files) |
| `` | string | | Destination file path. If not provided, guess from bud file path |
| `` | string|function | 'json' | Template file path or registered template name or template function |
<!-- Section from "doc/guides/03.Spec.md.hbs" End -->
<!-- Sections Start -->
<!-- LICENSE Start -->
<a name="license"></a>
License
-------
This software is released under the [MIT License](https://github.com/coz-labo/coz-bud/blob/master/LICENSE).
<!-- LICENSE End -->
<!-- Links Start -->
<a name="links"></a>
Links
------
+ [coz][coz_url]
[coz_url]: https://github.com/coz-labo/coz
<!-- Links End -->