staged-git-files

Staged Git Files

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

Usage

Download

npm install sgf

In Code

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"
	}
]

Statuses

SFG-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)

Change Log

0.0.1

• The mvp

Similar packages

Other packages similar to staged-git-files

simple-git

The 'simple-git' package is a lightweight interface for running Git commands in any Node.js application. It provides a more comprehensive set of Git functionalities compared to 'staged-git-files', including committing, pushing, and pulling changes, as well as retrieving the status of the repository.

isomorphic-git

The 'isomorphic-git' package is a pure JavaScript implementation of Git that works in both Node.js and browser environments. It offers a wide range of Git functionalities, including cloning repositories, committing changes, and managing branches. It is more versatile than 'staged-git-files' but also more complex to use.

nodegit

The 'nodegit' package is a native Node.js binding to the libgit2 library, providing a full suite of Git functionalities. It allows for more advanced Git operations, such as merging branches and handling submodules, making it more powerful but also more complex than 'staged-git-files'.