[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**vfile** is a small and browser friendly virtual file format that tracks
metadata about files (such as its `path` and `value`) and lint [messages][].
## Contents
* [unified](#unified)
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`VFile(options?)`](#vfileoptions)
* [`file.value`](#filevalue)
* [`file.cwd`](#filecwd)
* [`file.path`](#filepath)
* [`file.dirname`](#filedirname)
* [`file.basename`](#filebasename)
* [`file.extname`](#fileextname)
* [`file.stem`](#filestem)
* [`file.history`](#filehistory)
* [`file.messages`](#filemessages)
* [`file.data`](#filedata)
* [`VFile#toString(encoding?)`](#vfiletostringencoding)
* [`VFile#message(reason[, position][, origin])`](#vfilemessagereason-position-origin)
* [`VFile#info(reason[, position][, origin])`](#vfileinforeason-position-origin)
* [`VFile#fail(reason[, position][, origin])`](#vfilefailreason-position-origin)
* [Well-known fields](#well-known-fields)
* [List of utilities](#list-of-utilities)
* [Reporters](#reporters)
* [Types](#types)
* [Compatibility](#compatibility)
* [Contribute](#contribute)
* [Sponsor](#sponsor)
* [Acknowledgments](#acknowledgments)
* [License](#license)
## unified
**vfile** is part of the unified collective.
* for more about us, see [`unifiedjs.com`][site]
* for how the collective is governed, see [`unifiedjs/collective`][governance]
* for updates, see [@unifiedjs][twitter] on Twitter
## What is this?
This package provides a virtual file format.
It exposes an API to access the file value, path, metadata about the file, and
specifically supports attaching lint messages and errors to certain places in
these files.
## When should I use this?
The virtual file format is useful when dealing with the concept of files in
places where you might not be able to access the file system.
The message API is particularly useful when making things that check files (as
in, linting).
vfile is made for [unified][], which amongst other things checks files.
However, vfile can be used in other projects that deal with parsing,
transforming, and serializing data, to build linters, compilers, static site
generators, and other build tools.
This is different from the excellent [`vinyl`][vinyl] in that vfile has a
smaller API, a smaller size, and focuses on messages.
## Install
This package is [ESM only][esm].
In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with [npm][]:
```sh
npm install vfile
```
In Deno with [`esm.sh`][esmsh]:
```js
import {VFile} from 'https://esm.sh/vfile@5'
```
In browsers with [`esm.sh`][esmsh]:
```html
```
## Use
```js
import {VFile} from 'vfile'
const file = new VFile({
path: '~/example.txt',
value: 'Alpha *braavo* charlie.'
})
console.log(file.path) // => '~/example.txt'
console.log(file.dirname) // => '~'
file.extname = '.md'
console.log(file.basename) // => 'example.md'
file.basename = 'index.text'
console.log(file.history) // => ['~/example.txt', '~/example.md', '~/index.text']
file.message('Unexpected unknown word `braavo`, did you mean `bravo`?', {
line: 1,
column: 8
})
console.log(file.messages)
```
Yields:
```txt
[
[~/index.text:1:8: Unexpected unknown word `braavo`, did you mean `bravo`?] {
reason: 'Unexpected unknown word `braavo`, did you mean `bravo`?',
line: 1,
column: 8,
source: null,
ruleId: null,
position: {start: [Object], end: [Object]},
file: '~/index.text',
fatal: false
}
]
```
## API
This package exports the identifier `VFile`.
There is no default export.
### `VFile(options?)`
Create a new virtual file.
* if `options` is `string` or `Buffer`, it’s treated as `{value: options}`
* if `options` is a `URL`, it’s treated as `{path: options}`
* if `options` is a `VFile`, shallow copies its data over to the new file
All fields in `options` are set on the newly created `VFile`.
Path related fields are set in the following order (least specific to most
specific): `history`, `path`, `basename`, `stem`, `extname`, `dirname`.
It’s not possible to set either `dirname` or `extname` without setting either
`history`, `path`, `basename`, or `stem` as well.
###### Example
```js
new VFile()
new VFile('console.log("alpha");')
new VFile(Buffer.from('exit 1'))
new VFile({path: path.join('path', 'to', 'readme.md')})
new VFile({stem: 'readme', extname: '.md', dirname: path.join('path', 'to')})
new VFile({other: 'properties', are: 'copied', ov: {e: 'r'}})
```
### `file.value`
Raw value (`Buffer`, `string`, `null`).
### `file.cwd`
Base of `path` (`string`, default: `process.cwd()` or `'/'` in browsers).
### `file.path`
Get or set the full path (`string?`, example: `'~/index.min.js'`).
Cannot be nullified.
You can set a file URL (a `URL` object with a `file:` protocol) which will be
turned into a path with [`url.fileURLToPath`][file-url-to-path].
### `file.dirname`
Get or set the parent path (`string?`, example: `'~'`).
Cannot be set if there’s no `path` yet.
### `file.basename`
Get or set the basename (including extname) (`string?`, example: `'index.min.js'`).
Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'` on
windows).
Cannot be nullified (use `file.path = file.dirname` instead).
### `file.extname`
Get or set the extname (including dot) (`string?`, example: `'.js'`).
Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'` on
windows).
Cannot be set if there’s no `path` yet.
### `file.stem`
Get or set the stem (basename w/o extname) (`string?`, example: `'index.min'`).
Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'` on
windows).
Cannot be nullified.
### `file.history`
List of filepaths the file moved between (`Array`).
The first is the original path and the last is the current path.
### `file.messages`
List of messages associated with the file ([`Array`][message]).
### `file.data`
Place to store custom information (`Record`, default: `{}`).
It’s OK to store custom data directly on the file but moving it to `data` is
recommended.
### `VFile#toString(encoding?)`
Serialize the file.
When `value` is a [`Buffer`][buffer], `encoding` is a
[character encoding][encoding] to understand it as (`string`, default:
`'utf8'`).
###### Returns
Serialized file (`string`).
### `VFile#message(reason[, position][, origin])`
Constructs a new [`VFileMessage`][vmessage], where `fatal` is set to `false`,
and associates it with the file by adding it to [`file.messages`][messages]
and setting `message.file` to the current filepath.
###### Parameters
* `reason` (`string` or `Error`)
— human readable reason for the message, uses the stack and message of the
error if given
* `place` (`Node`, `Position`, or `Point`, optional)
— place where the message occurred in the file
* `origin` (`string?`, optional, example: `'my-npm-package:my-rule-name'`)
— computer readable reason for the message
###### Returns
Message ([`VFileMessage`][vmessage]).
### `VFile#info(reason[, position][, origin])`
Like [`VFile#message()`][message], but associates an informational message
where `fatal` is set to `null`.
###### Returns
Message ([`VFileMessage`][vmessage]).
### `VFile#fail(reason[, position][, origin])`
Like [`VFile#message()`][message], but associates a fatal message where `fatal`
is set to `true`, and then immediately throws it.
> 👉 **Note**: a fatal error means that a file is no longer processable.
###### Throws
Message ([`VFileMessage`][vmessage]).
### Well-known fields
The following fields are considered “non-standard”, but they are allowed, and
some utilities use them:
* `stored` (`boolean`)
— whether a file was saved to disk, used by reporters
* `result` (`unknown`)
— sometimes files have a non-string, compiled, representation, which can be
stored in the `result` field.
One example is when turning markdown into React nodes.
unified uses this field to store non-string results
* `map` (`Map`)
— sometimes files have a source map associated with them, this should be a
`Map` type, which is equivalent to the `RawSourceMap` type from the
`source-map` module
## List of utilities
* [`convert-vinyl-to-vfile`](https://github.com/dustinspecker/convert-vinyl-to-vfile)
— transform from [Vinyl][]
* [`to-vfile`](https://github.com/vfile/to-vfile)
— create a file from a filepath and read and write to the file system
* [`vfile-find-down`](https://github.com/vfile/vfile-find-down)
— find files by searching the file system downwards
* [`vfile-find-up`](https://github.com/vfile/vfile-find-up)
— find files by searching the file system upwards
* [`vfile-glob`](https://github.com/shinnn/vfile-glob)
— find files by glob patterns
* [`vfile-is`](https://github.com/vfile/vfile-is)
— check if a file passes a test
* [`vfile-location`](https://github.com/vfile/vfile-location)
— convert between positional and offset locations
* [`vfile-matter`](https://github.com/vfile/vfile-matter)
— parse the YAML front matter
* [`vfile-message`](https://github.com/vfile/vfile-message)
— create a file message
* [`vfile-messages-to-vscode-diagnostics`](https://github.com/shinnn/vfile-messages-to-vscode-diagnostics)
— transform file messages to VS Code diagnostics
* [`vfile-mkdirp`](https://github.com/vfile/vfile-mkdirp)
— make sure the directory of a file exists on the file system
* [`vfile-rename`](https://github.com/vfile/vfile-rename)
— rename the path parts of a file
* [`vfile-sort`](https://github.com/vfile/vfile-sort)
— sort messages by line/column
* [`vfile-statistics`](https://github.com/vfile/vfile-statistics)
— count messages per category: failures, warnings, etc
* [`vfile-to-eslint`](https://github.com/vfile/vfile-to-eslint)
— convert to ESLint formatter compatible output
> 👉 **Note**: see [unist][] for projects that work with nodes.
## Reporters
* [`vfile-reporter`][reporter]
— create a report
* [`vfile-reporter-json`](https://github.com/vfile/vfile-reporter-json)
— create a JSON report
* [`vfile-reporter-folder-json`](https://github.com/vfile/vfile-reporter-folder-json)
— create a JSON representation of vfiles
* [`vfile-reporter-pretty`](https://github.com/vfile/vfile-reporter-pretty)
— create a pretty report
* [`vfile-reporter-junit`](https://github.com/kellyselden/vfile-reporter-junit)
— create a jUnit report
* [`vfile-reporter-position`](https://github.com/Hocdoc/vfile-reporter-position)
— create a report with content excerpts
> 👉 **Note**: want to make your own reporter?
> Reporters *must* accept `Array` as their first argument, and return
> `string`.
> Reporters *may* accept other values too, in which case it’s suggested to stick
> to `vfile-reporter`s interface.
## Types
This package is fully typed with [TypeScript][].
It exports the following additional types:
* `BufferEncoding`
— thing that can be given as `x` in `file.toString(x)`
* `Compatible`
— everything that can be passed as `x` in `new VFile(x)`
* `Data`
— thing at `file.data`
* `DataMap`
— interface you can add things to, to type your extensions of `file.data`
* `Map`
— source map interface as supported at `file.map`
* `Options`
— the fields that can be passed as options to `new VFile(x)`
* `Reporter`
— a reporter
* `ReporterSettings`
— the fields that can be passed to a reporter
* `Value`
— valid value
* `VFile`
— class of `file` itself
`DataMap` can be augmented to include your extensions to it:
```ts
declare module 'vfile' {
interface DataMap {
// `file.data.name` is typed as `string`.
name: string
}
}
```
## Compatibility
Projects maintained by the unified collective are compatible with all maintained
versions of Node.js.
As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+.
Our projects sometimes work with older versions, but this is not guaranteed.
## Contribute
See [`contributing.md`][contributing] in [`vfile/.github`][health] for ways to
get started.
See [`support.md`][support] for ways to get help.
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## Sponsor
Support this effort and give back by sponsoring on [OpenCollective][collective]!
## Acknowledgments
The initial release of this project was authored by
[**@wooorm**](https://github.com/wooorm).
Thanks to [**@contra**](https://github.com/contra),
[**@phated**](https://github.com/phated), and others for their work on
[Vinyl][], which was a huge inspiration.
Thanks to
[**@brendo**](https://github.com/brendo),
[**@shinnn**](https://github.com/shinnn),
[**@KyleAMathews**](https://github.com/KyleAMathews),
[**@sindresorhus**](https://github.com/sindresorhus), and
[**@denysdovhan**](https://github.com/denysdovhan)
for contributing commits since!
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/vfile/vfile/workflows/main/badge.svg
[build]: https://github.com/vfile/vfile/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile.svg
[coverage]: https://codecov.io/github/vfile/vfile
[downloads-badge]: https://img.shields.io/npm/dm/vfile.svg
[downloads]: https://www.npmjs.com/package/vfile
[size-badge]: https://img.shields.io/bundlephobia/minzip/vfile.svg
[size]: https://bundlephobia.com/result?p=vfile
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/vfile/vfile/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[health]: https://github.com/vfile/.github
[contributing]: https://github.com/vfile/.github/blob/main/contributing.md
[support]: https://github.com/vfile/.github/blob/main/support.md
[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md
[license]: license
[author]: https://wooorm.com
[unified]: https://github.com/unifiedjs/unified
[vinyl]: https://github.com/gulpjs/vinyl
[site]: https://unifiedjs.com
[twitter]: https://twitter.com/unifiedjs
[unist]: https://github.com/syntax-tree/unist#list-of-utilities
[reporter]: https://github.com/vfile/vfile-reporter
[vmessage]: https://github.com/vfile/vfile-message
[messages]: #filemessages
[message]: #vfilemessagereason-position-origin
[encoding]: https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
[buffer]: https://nodejs.org/api/buffer.html
[file-url-to-path]: https://nodejs.org/api/url.html#url_url_fileurltopath_url
[governance]: https://github.com/unifiedjs/collective
