# ypkgfiles

> Yet another pkgfiles that generate pkg.files automatically

Latest version **1.6.0** (published 2018-07-11) · MIT license · 0 weekly downloads

## Install

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

Provides the commands `pkgfiles`, `ypkgfiles`.

## 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.6.0 |
| Published | 2018-07-11 |
| First published | 2017-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 5 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | popomore |
| Maintainers | popomore |

## Links

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

## Dependencies (5)

- [glob](https://npm.io/package/glob.md) ^7.1.1
- [debug](https://npm.io/package/debug.md) ^2.6.1
- [yargs](https://npm.io/package/yargs.md) ^7.0.1
- [is-type-of](https://npm.io/package/is-type-of.md) ^1.0.0
- [resolve-files](https://npm.io/package/resolve-files.md) ^1.0.0

## Recent versions

- 1.6.0 (latest) — 2018-07-11
- 1.5.0 — 2017-10-12
- 1.4.0 — 2017-04-14
- 1.3.1 — 2017-03-19
- 1.3.0 — 2017-03-07
- 1.2.0 — 2017-02-27
- 1.1.2 — 2017-02-27
- 1.1.1 — 2017-02-26
- 1.1.0 — 2017-02-26
- 1.0.1 — 2017-02-25
- 1.0.0 — 2017-02-25

## README

# ypkgfiles

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/ypkgfiles.svg?style=flat-square
[npm-url]: https://npmjs.org/package/ypkgfiles
[travis-image]: https://img.shields.io/travis/popomore/ypkgfiles.svg?style=flat-square
[travis-url]: https://travis-ci.org/popomore/ypkgfiles
[codecov-image]: https://codecov.io/gh/popomore/ypkgfiles/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/popomore/ypkgfiles
[david-image]: https://img.shields.io/david/popomore/ypkgfiles.svg?style=flat-square
[david-url]: https://david-dm.org/popomore/ypkgfiles
[snyk-image]: https://snyk.io/test/npm/ypkgfiles/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/ypkgfiles
[download-image]: https://img.shields.io/npm/dm/ypkgfiles.svg?style=flat-square
[download-url]: https://npmjs.org/package/ypkgfiles

Yet another pkgfiles that generate pkg.files automatically

## Why

Recommend [pkg.files] instead of `.npmignore` to choose which file should be included when npm publish. However, we will miss some files or directories when published, and should fix with another publishing.

Using ypkgfiles, it will generate pkg.files automatically with some configuration.

## Usage

```bash
$ npm install ypkgfiles
$ pkgfiles
```

Then `files` will be generated in `package.json`. ypkgfiles will lookup files from the main export.

If you want to publish some files that is not based on main export, such as `mz`

```js
require('mz/fs')
```

You can use `--entry fs.js` options to add to files automatically. If have more files, you can use glob `--entry *.js`.

## License

[MIT](LICENSE)

[pkg.files]: https://docs.npmjs.com/files/package.json#files

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