https://github.com/teppeis/vinyl-ast

Parse-once and generate-once AST tool bridge for Gulp plugins
https://github.com/teppeis/vinyl-ast

Last synced: 3 months ago
JSON representation

Parse-once and generate-once AST tool bridge for Gulp plugins

• Host: GitHub
• URL: https://github.com/teppeis/vinyl-ast
• Owner: teppeis
• Created: 2014-11-01T06:13:33.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-06-15T21:01:57.000Z (over 7 years ago)
• Last Synced: 2024-10-13T15:14:50.888Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
vinyl-ast [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Dependency Status][deps-image]][deps-url]

====

> Parse-once and generate-once AST tool bridge for Gulp plugins.

Inspired by [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps).

Just PoC now.

## Usage

Just use Gulp and the plugins.

```javascript

var gulp = require('gulp');

var plugin1usingVinylAst = require('gulp-plugin1-using-vinyl-ast');

var plugin2usingVinylAst = require('gulp-plugin2-using-vinyl-ast');

var plugin3 = require('gulp-plugin3');

gulp.task('javascript', function() {

  gulp.src('src/**/*.js')

    // parse source to AST

    .pipe(plugin1usingVinylAst())

    // AST to AST (no conversion!)

    .pipe(plugin2usingVinylAst())

    // generate souce from AST

    .pipe(plugin3())

    .pipe(gulp.dest('dist'));

});

```

Because plugin1 and plugin2 support vinyl-ast,  

the source is parsed at the beginning of plugin1 at once and generated once internally.

Even if plugin3 doesn't know about vinyl-ast, no problem.  

vinyl-ast generate sources as a `file#contents` property for general gulp plugins.

## VS.

[aster](http://asterjs.github.io/aster/) is an AST-based code builder.  

To use it with Gulp, additional confugiration is needed.

vinyl-ast is primary designed for working with Gulp.  

Gulp users don't have to concern about such an AST.  

Only plugin developers need to do.

## For Gulp plugin developer

Check `file.ast` property, use it and set your result ast to it.

```javascript

var through = require('through2');

var vinylAst = require('vinyl-ast');

var myTransform = require('myTransform');

module.exports = function(options) {

  return through.obj(function(file, encoding, callback) {

    var resutl;

    if (file.ast) {

      // use parsed ast!

      result = myTransformFromAst(file.ast, options);

    } else {

      // convert vinyl file to vinyl-ast file

      vinylAst.apply(file);

      // do normal plugin logic

      result = myTransformFromSource(file.contents, options);

    }

    // set result AST to file.ast

    file.ast = result.ast

    this.push(file);

    callback();

  }

};

```

## Features

### Select AST parser

TBD

### Specify generator options

TBD

### Sourcemap

Use [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps).

TBD

## License

MIT License: Teppei Sato 

[npm-image]: https://img.shields.io/npm/v/vinyl-ast.svg

[npm-url]: https://npmjs.org/package/vinyl-ast

[travis-image]: https://travis-ci.org/teppeis/vinyl-ast.svg?branch=master

[travis-url]: https://travis-ci.org/teppeis/vinyl-ast

[deps-image]: https://david-dm.org/teppeis/vinyl-ast.svg

[deps-url]: https://david-dm.org/teppeis/vinyl-ast