# scaffs

> A simple language agnostic scaffolder

Latest version **0.5.2** (published 2017-05-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install scaffs
pnpm add scaffs
yarn add scaffs
bun add scaffs
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.2 |
| Published | 2017-05-13 |
| First published | 2017-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=5.0.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Lenny Urbanowski |
| Maintainers | itslennysfault, scaffs |

## Links

- npm: https://www.npmjs.com/package/scaffs
- Repository: https://github.com/itslenny/scaffs
- Homepage: https://github.com/itslenny/scaffs#readme
- Issues: https://github.com/itslenny/scaffs/issues
- npm.io page: https://npm.io/package/scaffs

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^2.1.2
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.3
- [detect-indent](https://npm.io/package/detect-indent.md) ^5.0.0

## Recent versions

- 0.5.2 (latest) — 2017-05-13
- 0.5.1 — 2017-05-12
- 0.5.0 — 2017-05-01
- 0.4.0 — 2017-05-01
- 0.3.2 — 2017-04-25
- 0.3.1 — 2017-04-25
- 0.2.2 — 2017-04-25
- 0.2.1 — 2017-04-25
- 0.3.0 — 2017-04-24
- 0.2.0 — 2017-04-24
- 0.0.7 — 2017-04-23
- 0.0.6 — 2017-04-23
- 0.0.4 — 2017-04-23
- 0.0.2 — 2017-04-07
- 0.0.1 — 2017-04-07

## README

# ![Scaffs](https://raw.githubusercontent.com/itslenny/scaffs/master/docs/images/Logo_Full_64.png)

[![Npm Version](https://img.shields.io/npm/v/scaffs.svg?style=flat)](https://www.npmjs.com/package/scaffs)
[![Npm Downloads](https://img.shields.io/npm/dm/scaffs.svg?style=flat)](https://www.npmjs.com/package/scaffs)
[![Build Status](https://travis-ci.org/itslenny/scaffs.svg?branch=master)](https://travis-ci.org/itslenny/scaffs)
[![Build status](https://ci.appveyor.com/api/projects/status/olwnfccy11bt7a0i?svg=true)](https://ci.appveyor.com/project/itslenny/scaffs)

This is the scaffs library for using scaffs programmatically.

If you'd like to use scaffs from the commandline look at [scaffs-cli](https://www.npmjs.com/package/scaffs-cli)
This is the cli scaffs utility.

## Install

```
npm i --save scaffs
```

## Programmatic usage

> Details coming soon

## Additional resources

* [Scaffs library / programmatic usage](https://github.com/itslenny/scaffs) | [npm](https://www.npmjs.com/package/scaffs)
* [Scaffs cli / command line usage](https://github.com/itslenny/scaffs-cli) | [npm](https://www.npmjs.com/package/scaffs-cli)
* [Scaffs vs code plugin](https://github.com/itslenny/scaffs-vscode) | [vs code marketplace](https://marketplace.visualstudio.com/items?itemName=itslennysfault.scaffs-vscode)
* [@scaffs registry](https://github.com/itslenny/scaffs-registry) | [npm](https://www.npmjs.com/~scaffs)
* [Using scaffs config](https://github.com/itslenny/scaffs/tree/master/docs/md/config.md)
* [Creating scaffs](https://github.com/itslenny/scaffs/tree/master/docs/md/create.md)

## Contributing

* [Contributing to Scaffs](CONTRIBUTING.md)
* Contributing a Scaff

## TODO

* Add comments
* Add more tests
* Programmatic usage documentation
* Create scaff scaff
* Create test-project scaff
* Refactor to Async/Await
* Add "flat" option that doesn't create the root directory

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