# puffs

> puff

Latest version **0.0.2** (published 2019-07-31) · ISC license · 0 weekly downloads

## Install

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

## 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.2 |
| Published | 2019-07-31 |
| First published | 2019-07-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 242.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | elcarim5efil |

## Links

- npm: https://www.npmjs.com/package/puffs
- Repository: https://github.com/elcarim5efil/puff
- Homepage: https://github.com/elcarim5efil/puff#readme
- Issues: https://github.com/elcarim5efil/puff/issues
- npm.io page: https://npm.io/package/puffs

## Dependencies (3)

- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [precinct](https://npm.io/package/precinct.md) ^6.1.2
- [vue-template-compiler](https://npm.io/package/vue-template-compiler.md) ^2.6.10

## Recent versions

- 0.0.2 (latest) — 2019-07-31
- 0.0.1 — 2019-07-29

## README

<p align="center">
  <a href="https://codecov.io/gh/elcarim5efil/puff">
    <img src="https://img.shields.io/npm/v/puffs.svg?style=for-the-badge" />
  </a>

  <a href="https://travis-ci.org/elcarim5efil/puff">
    <img src="https://img.shields.io/travis/elcarim5efil/puff.svg?branch=master&style=for-the-badge">
  </a>

  <a href="https://codecov.io/gh/elcarim5efil/puff">
    <img src="https://img.shields.io/codecov/c/github/elcarim5efil/puff.svg?style=for-the-badge" />
  </a>
</p>

# puff

A package for ananysis file dependencies. Using [precinct](https://github.com/dependents/node-precinct) to do the file parsing jobs.

support:

- .js, .ts (as precinct does)
- .less, .sass
- .vue

## usage

```bash
npm i puffs
```

```javascript
import { resolve } form 'path';
import { parse } from 'puffs';

const result = await parse(path.resolve('/path/to/file.vue'));
```

## api

### prase

parse the file path and its file dependencies.

returns: 

- maxDepth, max dependencies depth
- flattenDependencyFilePaths, all file paths including the entry file itself
- entry, dependencies tree from the entry
- externals, externals node_module dependencies

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