@frctl/file

File

Virtual file format for use in Fractal's filesystem parser/compiler.

Extends Vinyl with a set of additional properties and methods.

const File = require('@frctl/file');

const file = new File({
    base: '/components',
    path: '/components/patterns/_04-button--large.hbs',
    contents: new Buffer('<button class="button button--large">{{ buttonText }}</button>')
});

console.log(file.hidden);    // true
console.log(file.position);  // 4
console.log(file.name);   // 'button--large'

file.name = 'button--grande';

console.log(file.path); // /components/patterns/_04-button--grande.hbs

Install

Installation using Yarn is recommended:

yarn add @frctl/file

Requirements

@frctl/file requires Node >= v6.0