staged-git-files

WebJar for staged-git-files

License	BSD 2-Clause
Categories	Git Development Tools Version Controls
GroupId	org.webjars.npm
ArtifactId	staged-git-files
Last Version	1.1.1
Release Date	Nov 12, 2018
Type	jar
Description	staged-git-files WebJar for staged-git-files
Project URL	http://webjars.org
Source Code Management	https://github.com/mcwhittemore/staged-git-files

Download staged-git-files

Filename	Size
staged-git-files-1.1.1.pom
staged-git-files-1.1.1.jar	10 KB
staged-git-files-1.1.1-sources.jar	22 bytes
staged-git-files-1.1.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/staged-git-files/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>staged-git-files</artifactId>
    <version>1.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/staged-git-files/
implementation 'org.webjars.npm:staged-git-files:1.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/staged-git-files/
implementation ("org.webjars.npm:staged-git-files:1.1.1")

Apache Buildr

'org.webjars.npm:staged-git-files:jar:1.1.1'

Apache Ivy

<dependency org="org.webjars.npm" name="staged-git-files" rev="1.1.1">
  <artifact name="staged-git-files" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='staged-git-files', version='1.1.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "staged-git-files" % "1.1.1"

Leiningen

[org.webjars.npm/staged-git-files "1.1.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Staged Git Files

This module returns an array of staged files and their status acording to git.

Usage

npm install staged-git-files

var sgf = require("staged-git-files");
sgf(function(err, results){
	//WHAT EVER YOU SO PLEASE
});

Example Results

[
	{
		"filename": "package.json",
		"status": "Added"
	},
	{
		"filename": "readme.md",
		"status": "Modified"
	},
	{
		"filename": "index.js",
		"status": "Renamed"
	}
]

Usage as a cli

$ sgf
Added package.json
Modified readme.md
Renamed index.js

API

sgf(filter, callback)

Get a list of staged git files

• filter: string of git status codes. No spaces
• callback:
  • err: the error
  • results: file object array.

If you omit a callback sgf will return a promise. How to use with async/await:

async function main () {
	const stagedFiles = await sgf();
}

main();

sgf.getHead(callback)

Get head that will be used in the diff to ID which files are waiting to be staged.

• callback
  • err: the error
  • head: the git commit id which is aliased to head.

sgf.readFile(filename, [options], callback)

This is a proxy for fs.readFile with one change. The filename will be relative to the sgf.cwd

sgf.debug

Boolean that flips logging on and off. By default this is false. If true, all git commands will be console logged.

sgf.includeContent

If true, include content will add a content or err param to the file object.

• Default Value: false
• Content Param: the content of the file staged
• Err Param: the error message received while trying to read the file.

sgf.cwd

The current working directory. AKA: where the .git folder you care about is.

Default Value: is equal to process.cwd() of your app.g

Statuses

SGF-Status (git status code)

• Added (A)
• Copied (C)
• Deleted (D)
• Modified (M)
• Renamed (R)
• Type-Change (T) [i.e. regular file, symlink, submodule, etc.]
• Unmerged (U)
• Unknown (X)

Versions

Version
1.1.1 Nov 12, 2018