JSPM

parse-git-status

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

Parse the output of `git status --porcelain -z`

Package Exports

  • parse-git-status

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 (parse-git-status) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

parse-git-status Build Status

Parse the output of git status --porcelain -z

Install

$ npm install --save parse-git-status

Usage

const parseGitStatus = require('parse-git-status');
const execa = require('execa');

execa('git', ['status', '--porcelain'])
    .then(({stdout}) => {
        console.log(parseGitStatus(stdout));
    });

API

parseGitStatus(gitStatus)

Parses gitStatus and returns an array of StatusObjects.

gitStatus

Type: string

The output of the command git status --porcelain.

--

StatusObject

Each status object in the array has the following format:

let statusObj = {
  x: 'A', // status code character
  y: 'A', // status code character
  to: 'bar.js', // the destination path (or just the path if not renamed)
  from: 'foo.js', // the source path if a rename (null otherwise)
}

See https://git-scm.com/docs/git-status for a list of available status codes and what each status code means.

parseGitStatus.describeCode(code)

Returns a descriptive name for each of the status codes.

parseGitStatus.describeCode('M')
// => "modified"
parseGitStatus.describeCode('A')
// => "added"

code

Type: string of length one (a single character)

Legal values are M, A, D, R, C, U, !, ? and (space character).

See https://git-scm.com/docs/git-status for more details.

License

MIT © James Talmage