Aster-src NPM | npm.io

aster-src

Source files reader for aster.

Usage

This module is part of aster and is available via aster.src.

You use it in build scripts whenever you want to get list of files for executing build pipeline:

var aster = require('aster');

aster.src([
  '**/*.js',
  '!node_modules/**'
])
.map(plugin1(optionsForPlugin1))
.map(plugin2(optionsForPlugin2))
// ...
.subscribe(aster.runner);

aster.src returns Rx.Observable which, in order, emits single inner observable collection of file ASTs wrapped with custom {type: 'File', program: ..., loc: {source: 'fileName.js'}} node.

API

src(patterns, options)

patterns

Type: String|String[]

List of patterns as array of strings or one comma-separated string.

options

Type: Object

glob module options (see https://github.com/isaacs/node-glob#options for details).

options.noglob

Type: Boolean Default: false

Set to true if you want patterns to be used as explicit list of files instead of globbing patterns (used by aster-watch).

options.parse

Type: Function|Boolean|Object Default: true

If preconfigured parser (i.e., require('aster-parse-js')({loc: false})) or custom function (files) { ... } is passed, it will be used as is.
If boolean is passed:
- true means files should be parsed with parser associated with file extension (see aster-parse).
- false means files should not be parsed and so they are pushed as {path: string, contents: string} object.
If object is passed, it will be used as parsing options.