# scrawl-package

> Generate package documentation using scrawl

Latest version **0.0.1** (published 2014-09-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install scrawl-package
pnpm add scrawl-package
yarn add scrawl-package
bun add scrawl-package
```

## 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 | 2014-09-06 |
| First published | 2014-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | RJ Zaworski |
| Maintainers | rjz |

## Links

- npm: https://www.npmjs.com/package/scrawl-package
- Repository: https://github.com/rjz/scrawl-package
- Issues: https://github.com/rjz/scrawl-package/issues
- npm.io page: https://npm.io/package/scrawl-package

## Dependencies (2)

- [glob](https://npm.io/package/glob.md) ~4.0.5
- [scrawl](https://npm.io/package/scrawl.md) ~0.0.5

## Recent versions

- 0.0.1 (latest) — 2014-09-06

## README

scrawl-package
===============================================================================

Parse package info and inline documentation into JSON using [scrawl][scrawl].

Usage
-------------------------------------------------------------------------------

    $ npm install --save-dev scrawl-package

Then, point it at files in the current directory:

    var info = require('scrawlProject')({
      match: [
        'index.js',
        'src/**/*.js'
      ]
    });

Options:

  * `match` - a string or array of strings with a glob pattern of files to be
      parsed

  * `dir` - the package directory (optional; defaults to current directory)

  * `transform` - a transformation function to apply to each scrawl comment
      (optional)

Testing
-------------------------------------------------------------------------------

    $ npm test

License
-------------------------------------------------------------------------------

MIT

[scrawl]: https://github.com/caolan/scrawl

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