# puke

> scaffolds a folder structure from a jsonish description

Latest version **1.0.0** (published 2019-02-12) · MIT license · 22 weekly downloads

## Install

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

## 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.0 |
| Published | 2019-02-12 |
| First published | 2015-09-28 |
| Weekly downloads | 22 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | serapath |
| Keywords | scaffold, json, boilerplate, generator |

## Links

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

## Dependencies (1)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-02-12
- 0.1.0 — 2015-09-28

## README

# puke
scaffolds a folder structure from a jsonish description

# example
`npm install puke`
```js
const puke = require('puke')

const name = 'module-foobar'
// in current directory (=== process.cwd())
const foldername = name

puke(foldername, scaffold(name))
// => creates in ./<foldername>/* the directory structure
//    specified in the `scaffold` function below

function scaffold (name) {
  return {
    "node_modules": {
      "level-callerid": {
        "index.js": `

        `,
        "package.json": `

        `
      }
    },
    [`source-${name}`]: {
      "node_modules": {
        "d": {
          "d.js": `

          `,
          "package.json": `

          `
        },
        "e": {
          "node_modules": {
            "d": {
              "d.js": `

              `,
              "package.json": `

              `
            }
          },
          "e.js": `

          `,
          "f.js": `

          `,
          "package.json": `

          `
        }
      },
      "index.js": `

      `
    },
    "a.js": `
    `,
    "b.js": `

    `,
    "c.js": `

    `,
    "package.json": `

    `
  }
}
```

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