g-status

WebJar for g-status

License	MIT
GroupId	org.webjars.npm
ArtifactId	g-status
Last Version	2.0.2
Release Date	Nov 12, 2018
Type	jar
Description	g-status WebJar for g-status
Project URL	http://webjars.org
Source Code Management	https://github.com/luftywiranda13/g-status

Download g-status

Filename	Size
g-status-2.0.2.pom
g-status-2.0.2.jar	6 KB
g-status-2.0.2-sources.jar	22 bytes
g-status-2.0.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/g-status/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>g-status</artifactId>
    <version>2.0.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/g-status/
implementation 'org.webjars.npm:g-status:2.0.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/g-status/
implementation ("org.webjars.npm:g-status:2.0.2")

Apache Buildr

'org.webjars.npm:g-status:jar:2.0.2'

Apache Ivy

<dependency org="org.webjars.npm" name="g-status" rev="2.0.2">
  <artifact name="g-status" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='g-status', version='2.0.2')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "g-status" % "2.0.2"

Leiningen

[org.webjars.npm/g-status "2.0.2"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.npm : arrify	jar	[1.0.1,2)
org.webjars.npm : matcher	jar	[1.0.0,2)
org.webjars.npm : simple-git	jar	[1.85.0,2)

Project Modules

There are no modules declared in this project.

g-status

Get the change between index (or staging-area) and working directory of a git repository

Think of git status or git status --porcelain, but returns a ready-to-consume result.

Why

• Maintained
• Accepts simple wildcard matching patterns
• Promise API
• Ability to get specific results based on status codes
• Knows which files are partially/fully-staged

Installation

npm install g-status

Usage

$ git status --porcelain

A  .travis.yml  # fully-staged
MM index.js     # partially-staged
 M readme.md    # unstaged

const gStatus = require('g-status');

gStatus().then(res => {
  console.log(res);
  /*
    [
      { path: '.travis.yml', index: 'A', workingTree: ' ' },
      { path: 'index.js', index: 'M', workingTree: 'M' },
      { path: 'readme.md', index: ' ', workingTree: 'M' }
    ]
  */
});

gStatus({ path: ['!*.js', '!*.md'] }).then(res => {
  console.log(res);
  //=> [{ path: '.travis.yml', index: 'A', workingTree: ' ' }]
});

// Files marked as `Modified` or `Added` in the staging area,
gStatus({ index: 'MA' }).then(res => {
  console.log(res);
  /*
    [
      { path: '.travis.yml', index: 'A', workingTree: ' ' },
      { path: 'index.js', index: 'M', workingTree: 'M' },
    ]
  */
});

// Files that arenʼt changed in the working tree
gStatus({ workingTree: ' ' }).then(res => {
  console.log(res);
  //=> [{ path: '.travis.yml', index: 'A', workingTree: ' ' }]
});

// Files that are marked as `Modified` both in staging area and working tree
gStatus({ index: 'M', workingTree: 'M' }).then(res => {
  console.log(res);
  //=> [{ path: 'index.js', index: 'M', workingTree: 'M' }]
});

See the tests for more usage examples and expected matches.

API

gStatus([options])

Returns Promise<{ path: string, index: string, workingTree: string }[]>.

options

Type: Object

cwd

Type: string
Default: process.cwd()

Current working directory.

path

Type: string | string[]
Default: *

Use * to match zero or more characters. A pattern starting with ! will be negated.

index

Type: string
Default: *

String of git status codes of the index/staging-area, See Short Format.
One difference is that * will match all value here.

workingTree

Type: string
Default: *

String of git status codes of the working tree, See Short Format.
One difference is that * will match all value here.

Related

• simple-git – Simple git interface for Node.js
• staged-git-files – Abandoned, the latest commit was 3 years ago

License

MIT © Lufty Wiranda

Versions

Version
2.0.2 Nov 12, 2018