# fast-project-prototype

> Small syntax to fastly create projects with lots of files from 1 file.

Latest version **1.0.1** (published 2019-11-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install fast-project-prototype
pnpm add fast-project-prototype
yarn add fast-project-prototype
bun add fast-project-prototype
```

Provides the command `fpp`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-11-05 |
| First published | 2019-11-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 50.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | allnulled |

## Links

- npm: https://www.npmjs.com/package/fast-project-prototype
- Repository: https://github.com/allnulled/fast-project-prototype
- Homepage: https://github.com/allnulled/fast-project-prototype#readme
- Issues: https://github.com/allnulled/fast-project-prototype/issues
- npm.io page: https://npm.io/package/fast-project-prototype

## Dependencies (3)

- [pegjs](https://npm.io/package/pegjs.md) ^0.10.0
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0

## Recent versions

- 1.0.1 (latest) — 2019-11-05
- 1.0.0 — 2019-11-03

## README

# fast-project-prototype

Small syntax to fastly create projects with lots of files from 1 file.

## Installation

`$ npm i -g fast-project-prototype`

## Usage

From CLI or API.

### API usage

```
const fpp = require("fast-project-prototype");

const source = `# Project:
# Filename:/hello/world.txt
Hello, world from FPP!
`;

fpp.parse(source); // This will generate /hello/world.txt
```

### CLI usage

`$ fpp myproject.fpp`

## Syntax

Start always with `# Project:` sentence, then append all the files or directories you want (you do not need to create the previous directories):

```
# Project:
# Filename: my/welcome/file.txt
This is content of my welcome file!
# Directory: my/folder
```

## Notes

The path of the output is always relative to the process.cwd + `fpp-results`.

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