https://github.com/rwhogg/gulp-flowcheck

A gulp plugin for Flow (DEPRECATED)
https://github.com/rwhogg/gulp-flowcheck

Last synced: about 2 months ago
JSON representation

A gulp plugin for Flow (DEPRECATED)

• Host: GitHub
• URL: https://github.com/rwhogg/gulp-flowcheck
• Owner: rwhogg
• License: bsd-3-clause
• Archived: true
• Created: 2016-02-15T23:16:48.000Z (almost 9 years ago)
• Default Branch: develop
• Last Pushed: 2016-12-28T04:42:14.000Z (almost 8 years ago)
• Last Synced: 2024-09-13T12:58:05.061Z (2 months ago)
• Language: JavaScript
• Homepage: https://rwhogg.github.io/gulp-flowcheck/modules/GulpFlow.html
• Size: 108 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Gulp-Flowcheck

A [gulp](https://gulpjs.com) plugin for [Flow](http://flowtype.org).

[![Build Status](https://travis-ci.org/rwhogg/gulp-flowcheck.svg?branch=master)](https://travis-ci.org/rwhogg/gulp-flowcheck)

[![Code Climate](https://codeclimate.com/github/rwhogg/gulp-flowcheck/badges/gpa.svg)](https://codeclimate.com/github/rwhogg/gulp-flowcheck)

## Installation

```bash

$ npm install --save-dev gulp-flowcheck;

```

## Usage

```js

var GulpFlow = require("gulp-flowcheck");

var gulpFlow = new GulpFlow();

gulp.task("flow", function()

{

    gulp.src("*.js")

        .pipe(gulpFlow.check())

        .pipe(gulpFlow.reporter());

});

```

The default reporter uses a JSON format. You'll probably find `GulpFlow.markdownReporter()` easier to read.

You can also try `GulpFlow.failReporter()`, which does exactly what you think it does.

### Automatically adding `@flow` headers

You can use [gulp-header](https://github.com/godaddy/gulp-header) to add the `@flow` headers to your source code

automatically:

```js

var header = require("gulp-header");

gulp.src("*.js")

    .pipe(header("/* @flow */"))

    .pipe(gulpFlow.check())

    ...

```