# forge-struct

> Scaffold a project

Latest version **0.0.4** (published 2018-03-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install forge-struct
pnpm add forge-struct
yarn add forge-struct
bun add forge-struct
```

Provides the command `forge`.

## 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.4 |
| Published | 2018-03-29 |
| First published | 2015-10-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Karlito40 |
| Maintainers | karlito40 |
| Keywords | forge, structure, project, folder, file, maker |

## Links

- npm: https://www.npmjs.com/package/forge-struct
- Repository: https://github.com/karlito40/forge
- Homepage: https://github.com/karlito40/forge#readme
- Issues: https://github.com/karlito40/forge/issues
- npm.io page: https://npm.io/package/forge-struct

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.0.4 (latest) — 2018-03-29
- 0.0.3 — 2015-10-29
- 0.0.2 — 2015-10-28
- 0.0.1 — 2015-10-28

## README

Asynchronous project generator

## Example from node

```
const Forge = require('forge-struct');

Forge.create([
  '/from_an_absolute_path/foo/subfoo/file_a.js',
  './from_a_relative_pathfoo/subfoo/file_b.js',
  '../../dir/file_b.js',
  'foo/subfoo/subsubfoo/file_c.js',
  'sample.js',
  'another_dir/empty_dir',
  {path: 'file_with_text.js', content: 'Hello !'} // Initialize a file with some content
])
.then(() => {
  console.log('Project generate');
});

```

## Example from command line

```
npm install forge-struct -g
```

#### Explicit creation
```
forge foo/subfoo/file_a.js foo/subfoo/file_b.js foo/subfoo/subsubfoo/file_c.js sample.js another_dir/empty_dir
```

#### Implicit file creation
```
forge -f structure.json
```

With structure.json as follow
```
[
  "foo/subfoo/file_a.js",
  "foo/subfoo/file_b.js",
  "sample.js"
]
```

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