dirent

dirent

Virtual file class. Extends the native fs.Dirent class with methods to simplify path handling. Similar to Vinyl, but lightweight.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm (requires Node.js >=10):

$ npm install --save dirent

Credit

This library is very heavily based on Vinyl. Thank you to the gulp.js team for the inspiration and great ideas behind vinyl. This work is based on that.

Comparison to Vinyl

The API for path handling is close enough that you can use Vinyl's docs as a reference. There are only a couple of minor differences:

• Streams are not supported on file.contents by default. See how to add stream support.
• Dirent extends Node's native fs.Dirent class.
• You can pass a string or object as the first argument, and optionally a file type as the second argument.

Usage

const Dirent = require('dirent');

// Pass a file path as a string, or an object with properties to add to the dirent
// The following examples are equivalent. When the path is a string, it will
// be converted to an object and set on the dirent.path property.
console.log(new Dirent('some/file/path.txt'));
//=> <Dirent "some/file/path.txt">
console.log(new Dirent({ path: 'some/file/path.txt' }));
//=> <Dirent "some/file/path.txt">

// assuming __filename is /jonschlinkert/dev/dirent/index.js
const file = new Dirent(__filename);
console.log(file.dirname); //=> /Users/jonschlinkert/dev//dirent
console.log(file.basename); //=> example.js
console.log(file.stem); //=> example
console.log(file.extname); //=> .js

How to add stream support

Stream support is added using the cloneable-readable library (this is the same library used by Vinyl). To add support for streams, do the following:

const clonable = require('cloneable-readable');
const Dirent = require('dirent');
const File = Dirent.create(cloneable);

const file = new File({ path: 'foo.js' });

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Contributors

Commits	Contributor
13	jonschlinkert
2	doowb

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2021, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on April 18, 2021.