# simple-boilerplate

> A simple, configurable, template based boilerplate project generator

Latest version **0.0.1** (published 2012-10-24) · 0 weekly downloads

## Install

```sh
npm install simple-boilerplate
pnpm add simple-boilerplate
yarn add simple-boilerplate
bun add simple-boilerplate
```

## 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.0.1 |
| Published | 2012-10-24 |
| First published | 2012-10-24 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.12 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Peter Halliday |
| Maintainers | pghalliday |

## Links

- npm: https://www.npmjs.com/package/simple-boilerplate
- Repository: https://github.com/pghalliday/simple-boilerplate
- Homepage: https://github.com/pghalliday/simple-boilerplate.git
- Issues: https://github.com/pghalliday/simple-boilerplate/issues
- npm.io page: https://npm.io/package/simple-boilerplate

## Dependencies (2)

- [fs-extra](https://npm.io/package/fs-extra.md) ~0.3.1
- [checklist](https://npm.io/package/checklist.md) 0.0.5

## Recent versions

- 0.0.1 (latest) — 2012-10-24

## README

simple-boilerplate
=========

A simple, configurable, template based boilerplate project generator

## Features

- should copy the template files to the given folder
- should make replacements in the files and file names it copies
- should fail gracefully on errors

## Installation

```
npm install boilerplate
```

## API

```javascript
var Boilerplate = require('simple-boilerplate');

var REPLACEMENTS = [{
  what: 'A_FIELD',
  with: 'some text'
}, {
  what: 'ANOTHER_FIELD',
  with: 'some other text'
}];

var boilerplate = new Boilerplate(TEMPLATE_DIRECTORY);
boilerplate.generate(TARGET_DIRECTORY, REPLACEMENTS, function(error) {
  if (error) {
    // a problem occurred generating the boiler plate
  } else {
    // the boiler plate project will have been generated in TARGET_DIRECTORY,
    // copying the contents of the TEMPLATE_DIRECTORY and making the specified
    // replacements both in file names and within the file contents
  }
});
```

## Roadmap

- None at this time

## Contributing
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.sh`` or ``.\grunt.bat``.

## Release History
_(Nothing yet)_

## License
Copyright (c) 2012 Peter Halliday  
Licensed under the MIT license.

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