JSPM

pull-fs-meta

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q17359F
  • License MIT

File system functions with a separated metadata system.

Package Exports

  • pull-fs-meta

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pull-fs-meta) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

pull-fs-meta NPM version Build Status experimental

File system functions with a separated metadata system.

var pull = require('pull-stream')
var pug = require('pull-pug') // An example module
var fs = require('pull-fs-meta')() // Init pull-fs-meta

pull(
  // Reading pulls the file's contents as a string
  // and stashes the file's metadata on the `fs` object
  fs.read('app/**/*.pug'),

  // Use String -> String compiler
  pug(),

  // Change the file extensions before writing
  fs.files({ ext: 'html' }),

  // Write to an output folder.
  fs.write('output')
)

Modules like pull-vinyl or vinyl-fs (used in gulp) are based on top of the Vinyl object, which centralizes the metadata and contents in one location in the stream. This isn't really appealing to things like compilers who only deal with data... So you end up needing to create wrapper libraries like gulp-pug, gulp-sass, etc.

This module separates file structure from contents:

  1. Contents are streamed as strings so you can compile them easily with String -> String tools.
  2. Metadata is changed with fs.files({ ...options }), like extnames, clearing, etc.

Installation

$ npm install --save pull-fs-meta

API

fsm(options) -> fs

Initialize the pull-fs-meta module. This is the main export

  • options (Object): Options to initialize with
  • meta (Array): Optional meta to load beforehand

Easily done like this:

var fs = require('pull-fs-meta')({ meta: [] })
// Or
var fs = require('pull-fs-meta')()

fs.read(pattern, [options])

Read files' contents from the file system as a String. It works as a source pull stream.

  • pattern: A glob pattern resolved by pull-glob
  • options get passed to fs.files (with clear: true by default).
pull(
  fs.read('foo/**/*.js'),
  // ... transform contents
)

fs.write(directory)

Write contents to the file system under a base directory, to their metadata paths.

  • directory (String): A path where you want to output the files.
pull(
  fs.read('foo/**/*.js'),
  // ... transform contents
  // then write to `out` directory:
  fs.write('out')
)

fs.files(options)

Change your files' metadata.

  • options (Object): Options to apply on your metadata.
  • clear (Boolean): Clear the metadata.
  • ext (String): Change the file's extnames.
pull(
  fs.read('app/**/*.coffee'),
  // ... transform contents
  // update metadata:
  fs.files({ ext: '.js' })
  // write:
  fs.write('out')
)

"Meta" and "Metadata"

"Meta" is private array created from fms(), it contains "metadata".

The "metedata" are also arrays. They contain info much like Vinyl has; although, minus the content as that gets streamed.

License

MIT © Jamen Marz