Documentation for Simbo's Packages
    Preparing search index...

    Module @simbo/git-changes - v1.0.3

    Git Changes

    📦 @simbo/git-changes

    A library to read, parse and provide Git changes information for a local repository.

    Install @simbo/git-changes from the npm registry:

    npm i [-D] @simbo/git-changes
    
    import { getGitChanges } from '@simbo/git-changes';

    // get a map of changed files in the repository located at /path/to/repo
    const changes = await getGitChanges('/path/to/repo');

    For a complete API reference, see the documentation.

    MIT © Simon Lepel

    Enumerations

    GitChangeStatus

    Interfaces

    GitChangeBase
    GitChangeStaged
    GitChangeUnstaged
    GitChangeWithOriginPath

    Type Aliases

    GitChange
    GitChangeStagedStatus
    GitChangeStatusAdded
    GitChangeStatusCommon
    GitChangeStatusUntracked
    GitChangeStatusWithOriginPath
    GitChangeUnstagedStatus

    Variables

    ENTRY_PATH_INDEX
    ENTRY_SEPARATOR
    ENTRY_STATUS_INDEX
    ENTRY_STATUS_LENGTH
    KNOWN_GIT_CHANGE_STATUSES

    Functions

    getGitChanges
    parseGitChangeStatus
    parseGitStatusOutput