Giter VIP home page Giter VIP logo

changed-git-files's Introduction

Changed Git Files

This module returns an array of changed files and their status according to git.

Credit

This repository is almost complete copy of @mcwhittemore staged-git-files repo. https://github.com/mcwhittemore/staged-git-files

The only difference is, that this command also returns files, that was modified, but not added to commit.

Usage

Download

npm install changed-git-files

In Code

var cgf = require("changed-git-files");
cgf(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"
	}
]

API

cgf(filter, callback)

Get a list of changed git files

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

cgf.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.

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

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

cgf.debug

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

cgf.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 changed
  • Err Param: the error message received while trying to read the file.

cgf.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

CGF-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.2

  • cgf.includeContent added. Now it is possible to also get the file content

0.0.1

  • The mvp

changed-git-files's People

Stargazers

Valentin Semirulnik avatar

Watchers

James Cloos avatar Tony G. avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.