# node-stamp

> Generate scaffolding from mustache templates and YAML files using Node.js

Latest version **0.2.0** (published 2013-03-21) · 0 weekly downloads

## Install

```sh
npm install node-stamp
pnpm add node-stamp
yarn add node-stamp
bun add node-stamp
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2013-03-21 |
| First published | 2013-03-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.6.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Trevor Borg |
| Maintainers | tborg |
| Keywords | mustache, yaml, scaffolding, templating |

## Links

- npm: https://www.npmjs.com/package/node-stamp
- Repository: https://github.com/tborg/stamp
- Issues: https://github.com/tborg/stamp/issues
- npm.io page: https://npm.io/package/node-stamp

## Dependencies (3)

- [milk](https://npm.io/package/milk.md) v1.2.0
- [async](https://npm.io/package/async.md) ~0.2.3
- [libyaml](https://npm.io/package/libyaml.md) 0.2.2

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2013-03-21
- 0.1.3 — 2013-03-20
- 0.1.2 — 2013-03-20
- 0.1.1 — 2013-03-20
- 0.1.0 — 2013-03-20

## README

# stamp

Generate scaffolding from mustache templates and YAML files using Node.js

## Getting Started
Install the module with: `npm install stamp`

In Javascript:

```javascript
var stamp = require('stamp');
var data = {
	options: {
		baseTemplatePath: 'templates',
		baseOutPath: 'out',
//		whitelist: ['out/example1/example.js']
//		blacklist: ['out/example1/nested/example.js']
	},
	dirs: [
		{
			name: 'example1',
			files: [
				{
					template: 'example.js',
					data: { name: 'Trevor' }
				},
				{
					template: 'example.js',
					name: 'exampleAlt.js',
					data: { name: 'Stamp' }
				}
			],
			children: [
				{
					name: 'nested',
					files: [
						{
							template: 'example.js',
							data: {name: 'Nested'}
						}
					]
				}
			]
		}
	]
}
stamp(data);
```

From the Command Line:

```bash
node stamp.js path/to/yaml/config.yml
```

Where config.yml presents the same structure.

## Contributing

### TODO

- could use some unit tests

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
0.2.0  3/21/13 - optionally whitelist or blacklist based on relative filepath.
0.1.0: 3/20/13 - initial release.

## License
Copyright (c) 2013 Trevor Borg  
Licensed under the MIT license.

---
_Source: https://npm.io/package/node-stamp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._