1.0.0 • Published 10 years ago

gitstat v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
10 years ago

gitstat - stream git status

The gitstat Node module streams paths of changed files tracked by a local Git repository.

Build Status

Usage

Read orginal output of the underlying git status -uno -z file by file:

var gitstat = require('gitstat'), status

status = gitstat('.')
status.on('readable', function () {
  var chunk
  while ((chunk = status.read()) !== null) {
    console.log('%s', chunk)
  }
})

Pipe filenames of added and/or modified files:

var gitstat = require('gitstat')

gitstat('.', 'AM')
  .pipe(process.stdout)

Types

repo()

A path to a local git repository.

mode()

Optionally configure which filenames should be emitted by passing Git statuses ("M|A|D|R|C|U") as String of undefined length. For example:

gitstat('.', 'AM')

This would return a readable stream that emits filenames of all added and/or modified files.

With the default mode (undefined), not filenames, but the original output of git status -uno -z is emitted file by file. For details please refer to man git-status.

Exports

gitstat(repo(), mode())

This function returns a Readable stream. On the first read this stream executes git status -uno -z and begins emitting paths according to mode. Untracked files are ignored.

Installation

NPM

License

MIT License

1.0.0

10 years ago

0.0.5

11 years ago

0.0.4

11 years ago

0.0.3

11 years ago

0.0.2

11 years ago

0.0.1

11 years ago

0.0.0

11 years ago