# to-file

> Convert a file path to a vinyl file.

Latest version **0.2.0** (published 2016-05-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install to-file
pnpm add to-file
yarn add to-file
bun add to-file
```

## 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.2.0 |
| Published | 2016-05-07 |
| First published | 2015-10-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | contents, file, read, vinyl |

## Links

- npm: https://www.npmjs.com/package/to-file
- Repository: https://github.com/jonschlinkert/to-file
- Issues: https://github.com/jonschlinkert/to-file/issues
- npm.io page: https://npm.io/package/to-file

## Dependencies (8)

- [vinyl](https://npm.io/package/vinyl.md) ^1.1.1
- [isobject](https://npm.io/package/isobject.md) ^2.1.0
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.1
- [glob-parent](https://npm.io/package/glob-parent.md) ^2.0.0
- [file-contents](https://npm.io/package/file-contents.md) ^0.2.4
- [is-valid-glob](https://npm.io/package/is-valid-glob.md) ^0.3.0
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
- [define-property](https://npm.io/package/define-property.md) ^0.2.5

## 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.2.0 (latest) — 2016-05-07
- 0.1.7 — 2016-02-13
- 0.1.5 — 2015-10-22
- 0.1.4 — 2015-10-16
- 0.1.3 — 2015-10-14
- 0.1.2 — 2015-10-09
- 0.1.1 — 2015-10-09
- 0.1.0 — 2015-10-09

## README

# to-file [![NPM version](https://img.shields.io/npm/v/to-file.svg?style=flat)](https://www.npmjs.com/package/to-file) [![NPM downloads](https://img.shields.io/npm/dm/to-file.svg?style=flat)](https://npmjs.org/package/to-file) [![Build Status](https://img.shields.io/travis/jonschlinkert/to-file.svg?style=flat)](https://travis-ci.org/jonschlinkert/to-file)

Convert a file path to a vinyl file.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install to-file --save
```

## Usage

```js
var toFile = require('to-file');
var glob = require('glob');

var files = glob.sync('**/*.js')
files = files.map(function(fp) {
  return toFile(fp);
});
```

**glob parent**

Optionally pass the original glob pattern as the second argument to populate `file.base` from the [glob-parent](https://github.com/es128/glob-parent).

```js
var files = glob.sync('**/*.js')
files = files.map(function(fp) {
  return toFile(fp, '**/*.js');
});
```

**options**

If an options object is passed as the second or third argument, the `cwd` and `base` properties will be used to update the file object, and the `options` object will be added as a property on the `file` object.

```js
var files = glob.sync('**/*.js')
files = files.map(function(fp) {
  return toFile(fp, '**/*.js');
});
```

## Related projects

You might also be interested in these projects:

* [to-template](https://www.npmjs.com/package/to-template): Convert a vinyl file object to a Template-compatible template object. | [homepage](https://github.com/jonschlinkert/to-template)
* [to-vinyl](https://www.npmjs.com/package/to-vinyl): Convert an object to a vinyl file object. Safely mixes additional properties onto the file… [more](https://www.npmjs.com/package/to-vinyl) | [homepage](https://github.com/jonschlinkert/to-vinyl)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/to-file/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/to-file/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 07, 2016._

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