porcelainjs
v0.0.8
Published
A utility class that makes parsing `git status --porcelain` fun.
Downloads
3
Maintainers
Readme
Use case
One use case (the one that inspired this package) is a Node.js script that performs very specific code modifications on predefined files. I wanted a simple way to check that certain files did not have unsaved/unstaged changes before letting the script run.
Import
CommonJS
const Porcelain = require('porcelainjs').Porcelain;
ESM
import { Porcelain } from 'porcelainjs';
Usage
const gitStatusChecker = new Porcelain();
const isModified = gitStatusChecker.isFileModified('src/myFile'); // Must use absolute path from your git repo root.
API
interface IPorcelain {
// `filename` is an absolute path from your git repo root.
isFileInStatus(filename: string): boolean;
isFileUntracked(filename: string): boolean;
// `filename` is an absolute path from your git repo root.
// `gitLocation` is an optional parameter allowing you to limit your search to either the working tree or index.
isModified(filename: string, gitLocation?: 'index' | 'working tree'): boolean;
isFileTypeChanged(filename: string, gitLocation?: 'index' | 'working tree'): boolean;
isAdded(filename: string, gitLocation?: 'index' | 'working tree'): boolean;
isDeleted(filename: string, gitLocation?: 'index' | 'working tree'): boolean;
isRenamed(filename: string, gitLocation?: 'index' | 'working tree'): boolean;
isCopied(filename: string, gitLocation?: 'index' | 'working tree'): boolean;
isUpdatedButUnmerged(filename: string, gitLocation?: 'index' | 'working tree'): boolean;
// Turn your `git status` into the data structure of your choice with filename -> git status code mappings
// see https://git-scm.com/docs/git-status#_short_format for documentation on git status formats
get getHashTable(): Record<string, 'M' | 'T' | 'A' | 'D' | 'R' | 'C' | 'U' | '??' | ' '>;
get getMap(): Map<string, 'M' | 'T' | 'A' | 'D' | 'R' | 'C' | 'U' | '??' | ' '>;
get getSet(): Set<string>;
}