vfile

Types

• f9f3c8f Update @types/unist

Full Changelog: 6.0.0...6.0.1

Change

• 46dd635 Change to require Node.js 16
  migrate: update Node
• f72469b Change to use export map
  migrate: don’t use private APIs
• f4edd0d Change to replace Buffer with Uint8Array
  migrate: this will mostly work, but might break if you use weird ancient encodings
  by @wooorm in #85
• af5eada Update vfile-message
  migrate: if you used .position on messages, switch that to .place
  optionally use the nicer options parameter to pass your things

Misc

• 47eec44 Refactor to match current Node internals
• ab764ab Refactor docs
• bc0332c Change to use node: prefix
• 5d00341 Change to use global URL in types
• 6b8fdb4 4800e34 Refactor types
• c4b6c0d Refactor code-style
• f3c5753 Remove skipLibCheck from tsconfig.json
• 6a87fde Refactor package.json

Full Changelog: 5.3.7...6.0.0

Misc

• d10a468 Add improved docs
• 3a05718 Refactor code-style

Full Changelog: 5.3.6...5.3.7

• db8c841 Add support for passing VFileMessage to message in types

Full Changelog: 5.3.5...5.3.6

• 6c5a2f7 Refactor to remove buffer import in types
  by @remcohaszing in #82

Full Changelog: 5.3.4...5.3.5

• d96fc40 Fix ancient typescript

Full Changelog: 5.3.3...5.3.4

• 66189a4 Fix paths in types for nodenext
  by @Josh-Cena in #78
• 6375cbc Add improved docs
• 2024e2e Add list of well-known fields to readme

Full Changelog: 5.3.2...5.3.3

• 77e6bea Fix types to support instances of Node again

Full Changelog: 5.3.1...5.3.2

• 30ea9e0 Fix types to support any unist node

Full Changelog: https://github.com/vfile/vfile/compare/5.3.0...5.3.1

• c9ba3e1 Add Map type for semi-standard file.map

Full Changelog: https://github.com/vfile/vfile/compare/5.2.1...5.3.0

• 46f9bf2 Fix VFileValue Buffer type by @remcohaszing in https://github.com/vfile/vfile/pull/64

Full Changelog: https://github.com/vfile/vfile/compare/5.2.0...5.2.1

• f50069b Add VFileDataMap for augmenting data by @with-heart in https://github.com/vfile/vfile/pull/68

Full Changelog: https://github.com/vfile/vfile/compare/5.1.1...5.2.0

• be7b2c4 Add support for base64url buffer encoding in types by @JounQin in https://github.com/vfile/vfile/pull/66

Full Changelog: https://github.com/vfile/vfile/compare/5.1.0...5.1.1

• 7ee90f2 Add support for passing and setting file URLs
• f0fc56c Add strict to tsconfig.json
• edd7a21 Add well known map field

• b00128d Add well known result field

• f95280c Add well known stored field to types

• 9db5c88 Rename vfile.contents -> vfile.value
• 760b43b Change to use class note: this now requires new VFile() (instead of VFile()) and removes support for returning a given file immediately
• 53bea6d Remove separate core export
• 4632308 Add JSDoc based types
• 1262c60 Use ESM

• 91f1303 Add manual browser polyfills for path, process
• 5936f09 Refactor to improve bundle size
• e4a2c4d Refactor prose

• 2a9d315 Add direct data types

• 474d324 types: use browser compatible instead of node types

• 6cd6fb7 types: add vfile reporter type

Patches

• 504c0ea Update list of utilities
• 6f737ca Add vfile-reporter-junit to list of reporters
• 687e60f Refactor prose
• 417c5fc Update metadata

• 5c40df1 Add funding to package.json
• ba26c3c Update sponsors

• 3e5bc5e Add types
• 5cdd6cd Update vfile-message
• b17feb0 Update unist-util-stringify-position
• 825ecef Remove deprecated warn method

• baa3e91 Add vfile-glob to list of utilities
• 8c0b1af Update badges
• 7e1e6a6 Update logo

• 6d75ef5 Update is-buffer
• cc91022 Refactor code-style
• 559a579 Add Acknowledgments section to readme.md
• dd94bff Add Contribute section to readme.md
• 7d6e929 Add contributing.md
• 66e5a25 Add code-of-conduct.md
• 3c0cca9 Add vfile-reporter-folder-json to list of reporters
• 4ad500c Add vfile-message to list of utilities

• 079d425 Refactor to split core from message functionality
• 8def898 Externalise VMessage
• 1481d14 Add url to the list of custom message properties
• f31adc4 Add list of custom message properties
• 183ab71 Add support for passing source:ruleId to message
• f65510e Update logo
• f877a52 Refactor API description

• 96ade44 Add .info for informational messages

• 5d2b5d9 Remove unneeded dependencies

• 021d4b2 Track the repository migration
• a5b39a4 Add section on reporters

Highlights

• Remove some of the non-essentials currently in this project (hasFailed, namespace, move)
• Streamline path-manipulation (there’s now getter/setters for path, dirname, basename, stem, and extname)
• Add support for buffers as content
• Simplify messages: no quiet, remove old #message() and rename #warn() to #message()
• Standardise custom properties

API difference

The following diff shows in short the major API changes:

  `VFile.contents` // now also accepts buffers
- `VFile#directory`
+ `VFile.dirname`
- `VFile#filename`
+ `VFile.stem`
- `VFile#extension`
+ `VFile.extname`
- `VFile#basename()`
+ `VFile.basename`
- `VFile#filePath()`
+ `VFile.path`
- `VFile#quiet`
- `VFile#move(options)`
- `VFile#namespace(key)` // use `vfile.data` directly;
- `VFile#message(reason[, position[, ruleId]])`
- `VFile#warn(reason[, position[, ruleId]])`
+ `VFile#message(reason[, position[, ruleId]])`
  `VFile#fail(reason[, position[, ruleId]])`
- `VFile#hasFailed()`

🎉

• 77547fb Add support for passing ruleId to message()

• b45c780 Remove distribution files from source
• 849c3ad Remove support for bower

• c896cf9 Fix missing Error properties on VFileMessage

• 848aef7 Add extensive location information to messages
• 67d0112 Add history tracking