nodejs git json

It is based on nodegit v0.28.0-alpha.22

Nodejs-git-json is a NPM module library that can output json from local git repository. (not remote git repository)

* nodejs-git-json v1.0.14 using Nodegit v0.28.0-alpha.1
* nodejs-git-json v1.1.0 using Nodegit v0.28.0-alpha.22
* nodejs-git-json v1.6.0 using Nodegit v0.28.0-alpha.24
* nodejs-git-json v1.14.2 using Nodegit v0.28.0-alpha.28

Prerequisites

NodeJS >= v18.6.0

Installation

``shell


It takes a while to download and build nodegit when installing!

npm

`

Commands

`typescript
// Alias
git_log_short(path: string = './', config: Config = CONFIG): Promise // Fast
git_log(path: string = './', config: Config = CONFIG): Promise // Slow
git_status(path: string = './', config: Config = CONFIG): Promise
git_reference(path: string = './', config: Config = CONFIG): Promise
git_users(path: string = './', config: Config = CONFIG): Promise // Middle
git_configs(path: string = './', config: Config = CONFIG): Promise
git_stash(path: string = './', config: Config = CONFIG): Promise

// Helpers
git_log_commit(path: string = './', sha: string, config: Config = CONFIG): Promise
git_log_pagination(path: string = './', gitLogPagination: GitLogPagination, config: Config = CONFIG): Promise
git_log_dates(path: string = './', gitLogDates: GitLogDates, config: Config = CONFIG): Promise
git_log_file(path: string = './', filePath: string, config: Config = CONFIG): Promise
git_log_folder(path: string = './', folderPath: string, gitLogPagination: GitLogPagination, config: Config = CONFIG): Promise
git_log_feature_branch_commits(path: string = './', config: Config = CONFIG): Promise
git_log_feature_branch_users_commits(path: string = './', config: Config = CONFIG): Promise
git_log_filter(path: string = './', filter: GitlogFilter, config: Confing = CONFIG): Promise

// Repo
git_repo_commits_count(path: string = './', config: Config = CONFIG): Promise
git_repo_users_commit_count(path: string = './', config: Config = CONFIG): Promise
git_repo_files_count(path: string = './', config: Config = CONFIG): Promise
git_repo_files(path: string = './', config: Config = CONFIG): Promise
git_repo_statistics(path: string = './', config: Config = CONFIG): Promise
git_repo_grep(path: string = './', pattern: string, pathspec?: string, config: Config = CONFIG): Promise
git_repo_files_size(path: string = './', config: Config = CONFIG): Promise
git_repo_unpack(path: string = './', config: Config = CONFIG): Promise
git_repo_ancestors(path: string = './', config: Config = CONFIG): Promise

// Info
git_users_refs(path: string = './', config: Config = CONFIG): Promise

// @path string - Relative or absolute path for folder where git repository exist

// @sha string - commit sha

// @config Object - Config for std out in console
// @stdOut boolean - Output print to the terminal or command prompt the data
// @stdPrgOut boolean - Output print to the terminal or command prompt the progress

// @gitLogPagination - Pagination commits
// @commitsPerPage number - Total Commits
// @currentPage number - Start check point

// @gitLogDates - Between Dates
// @sinceDate: DateFormat - Start date
// @untilDate: DateFormat - End date

// @filePath - relative file path

// @folderPath - relative folder path

// @pattern - search word

// @pathspec - file example "*.ts"

// @GitlogFilter
// added
// modified
// deleted:
// renamed:
// copied:
// typeChanged
// unmerged
// unknown

`

Usage

`typescript
// main.ts

import {
git_log_short, // Fast
git_log, // Slow
git_status,
git_reference,
git_users, // Fast
git_configs,
git_stash,
git_log_commit,
git_log_pagination,
git_log_dates,
git_log_file,
git_log_folder,
git_log_feature_branch_commits,
git_log_feature_branch_users_commits,
git_log_filter
git_repo_commits_count,
git_repo_users_commit_count,
git_repo_files_count,
git_repo_files,
git_repo_statistics,
git_repo_grep,
git_repo_files_size
git_repo_unpack,
git_repo_ancestors,
git_users_refs,
} from 'nodejs-git-json';

(async () => {
const log_short = await git_log_short('./my-path/git/git-nodejs-git-json/');
const log = await git_log('/my-path/git/git-nodejs-git-json/');
const status = await git_status('/my-path/git/git-nodejs-git-json/');
const reference = await git_reference('/my-path/git/git-nodejs-git-json/');
const users = await git_users('/my-path/git/git-nodejs-git-json/');
const configs = await git_configs('/my-path/git/git-nodejs-git-json/');
const stashes = await git_stash('/my-path/git/git-nodejs-git-json/');
const log_commit = await git_log_commit('/my-path/git/git-nodejs-git-json/', '4d50c3453db88189b979aec14d041a023b23b360');
const log_pagination = await git_log_pagination('/my-path/git/git-nodejs-git-json/', { currentPage: 1, commitsPerPage: 20 });
const log_dates = await git_log_dates('/my-path/git/git-nodejs-git-json/', { sinceDate: '2024-02-29', untilDate: '2023-02-28'});
const log_file = await git_log_file('/my-path/git/git-nodejs-git-json/', './index.ts');
const log_folder = await git_log_folder('./my-path/git/git-nodejs-git-json/', './build', { currentPage: 1, commitsPerPage: 10})
const log_feature_branch_commits = await git_log_feature_branch_commits('./', { stdOut: true });
const log_feature_branch_users_commits = await git_log_feature_branch_users_commits('./my-path/git/git-nodejs-git-json/', { stdOut: true });
const log_filter = await git_log_filter('./my-path/git/git-nodejs-git-json/', 'modified');
const repo_commits_count = await git_repo_commits_count('./my-path/git/git-nodejs-git-json/')
const repo_users_commit_count = await git_repo_users_commit_count('./my-path/git/git-nodejs-git-json/');
const repo_files_count = await git_repo_files_count('./my-path/git/git-nodejs-git-json/');
const repo_files = await git_repo_files('./my-path/git/git-nodejs-git-json/');
const repo_statistics = await git_repo_statistics('./my-path/git/git-nodejs-git-json/');
const repo_grep = await git_repo_grep('./my-path/git/git-nodejs-git-json/', 'Statistics', '*.js', {stdOut: true});
const repo_files_size = await git_repo_files_size('./');
const repo_unpack = await git_repo_unpack('./', {stdOut: true});
const repo_ancestors = await git_repo_ancestors('./',{ stdOut: true});
const user_refs = await git_users_refs('./', { stdOut: true });

// log json object equal to "git log --shortstat"
console.log(log_short);

// log json object equal to "git log"
console.log(log);

// log json object equal to "git status"
console.log(status);

// log json object equal to "git tag" "git branch -r"
console.log(reference);

// log json object equal to "git shortlog --summary --numbered --email"
console.log(users);

// log json object equal to "git config --list --show-scope --show-origin"
console.log(configs);

// log json object equal to "git stash list"
console.log(stashes);

// log json object equal to "git log -p "
console.log(log_commit);

// log json object equal to git log ??
console.log(log_pagination);

// log json object equal to git --no-pager log --since="2024-01-20 00:00:00" --until="2024-01-24 24:00:00" --format=%H
console.log(log_dates);

// log json object equal to "git log "
console.log(log_file);

// log json object equal to "git log -- "
console.log(log_folder);

// log json object equal git log --diff-filiter --pretty=format:%H --name-only
console.log(log_filter)

// log number of commits equal to "git rev-list --count HEAD"
console.log(repo_commits_count);

// log json object equal to "git --no-pager shortlog -s -n"
console.log(repo_users_commit_count);

// log json object equal to "git ls-files | wc -l"
console.log(repo_files_count);

// log json object equal to "git ls-files"
console.log(repo_files);

// log json object equal to "git-sizer -j"
console.log(repo_statistics);

// log json object equal to 'git grep --line-number -I "Statistics" -- "*.js"'
console.log(repo_grep);

// log json object equal to 'git ls-tree -r --long HEAD'
console.log(repo_files_size);

// log json object equal to 'git count-objects --verbose'
console.log(repo_unpack);

// log json object equal to 'git for-each-ref --format='%(authorname),%(authoremail),%(committername),%(committeremail),%(refname:short),%(objecttype),%(objectname:short),%(subject),%(taggername),%(taggeremail)'
console.log(user_refs);

// log json object equal git merge-base --all HEAD )
console.log(repo_ancestors);

// log json object equal git log myFeaturebranch ---not masater --pretty="format:'%H', "%ci", "%s", "%an", "%ae", "%cn", "%ce"" --no-merges
console.log(log_feature_branch_commits)

// log json object equal git log myFeaturebranch ---not masater --pretty="format:%H,%an" --no-merges
console.log(log_feature_branch_users_commits)
})()
`

$3

#### GitLogsShort

`typescript
GitLogsShort = [
{
// Commit unique ID sha-1
sha: string;
// Commit date as ISO
date: string;
// Commit message
message: string;
// Commit signature author name
authorName: string;
// Commit signature author email
authorEmail: string;
// Commit committer name
commiterName: string;
// Commit commiter email
commiterEmail: string;
// Commit total number of insertions
}
...
]
`

#### GitLogs

`typescript
GitLogs = [
{
// Commit unique ID sha-1
sha: string;
// Commit date as ISO
date: string;
// Commit message
message: string;
// Commit signature author name
authorName: string;
// Commit signature author email
authorEmail: string;
// Commit committer name
commiterName: string;
// Commit commiter email
commiterEmail: string;
// Commit total number of insertions
insertion: number;
// Commit total number of deletions
deletion: number;
// Commit total number of files changed
fileChanged: number;
// Committed files
files: [
{
// Commit file relativ path from git repo
newFilePath: string;
// Commit file size
newFileSize: number;
// Commit file context
contextLines: number;
// Commit file added lines
addedLines: number;
// Commit deleted lines
deletedLines: number;
// Commmit - UNMODIFIED, ADDED, DELETED, MODIFIED, IGNORED, TYPECHANGE, UNREADABLE, CONFLICT
status: string[];
// Commit hunks
hunks: [
// Hunk header
header: string
// Hunk total insert tokens
insertTokens: number;
// Hunk totla deleted tokens
deletionTokens: number;
lines: [
{
// Line orgin
origin: number;
// Line old line number
oldLineno: number;
// Line new line number
newLineno: number;
// Line type - CONTEXT, ADDITION, DELETION. CONTEXT_EOFNL. ADD_EOFNL, DEL_EOFNL. FILE_HDR, HUNK_HDR, BINARY
type: string;
// Line diff - '+', '-', ''
diffType: string;
// Line output
content: string;
}
...
]
]
}
...
]
}
...
]
`

#### GitStatuses

`typescript
GitStatuses = [
{
// /filename ex: README.md, 'src/types/git_types.ts
path: string;
// NEW, MODIFIED, TYPECHANGE, RENAMED, IGNORED, WORKING-TREE, CONFLICT, DELETED, IGNORED
status: string[];
// WT_NEW, WT_MODIFIED, WT_DELETED, WT_TYPECHANGE, WT_RENAMED
statusFile: string[];
}
...
]
`

#### GitRefs

`typescript
GitRefs = [
{
// Commit unique ID sha-1
sha: string;
// BRANCH, HEAD, NOTE, REMOTE, TAG, SYMBOLIC, NOTVALID, STASH
status: string[];
// refs/heads/main, refs/tags/v1.0.6
name: string;
}
...
]
`

#### GitUsers

`typescript
GitUsers = [
{
// Commit signature author name
authorName: string;
// Commit signature author email
authorEmail: string;
// Commit total number of files changed
totalCommits: number;
// Commits unique ID sha-1
commits: string[];
}
...
]
`

#### GitConfigs

`typescript
GitConfigs = [
{
// worktree, local, global, system, command, unknown
scope: string;
// Config key and value
variable: { key: string, value: string };
// file path, ref, or blob id
originType: string;
}
...
]
`

#### GitStashes

`typescript
GitStashes = [
{
// Stash index, index zero is refs/stash
index: number;
// Stash index name
indexName: string;
// Stash unique ID sha-1
sha: string;
// Stash message
message: string;
}
...
]
`

#### GitLog

`typescript
GitLog = {
// Commit unique ID sha-1
sha: string;
// Commit date as ISO
date: string;
// Commit message
message: string;
// Commit signature author name
authorName: string;
// Commit signature author email
authorEmail: string;
// Commit committer name
commiterName: string;
// Commit commiter email
commiterEmail: string;
// Commit total number of insertions
insertion: number;
// Commit total number of deletions
deletion: number;
// Commit total number of files changed
fileChanged: number;
// Committed files
files: [{
// Commit file relativ path from git repo
newFilePath: string;
// Commit file size
newFileSize: number;
// Commit file context
contextLines: number;
// Commit file added lines
addedLines: number;
// Commit deleted lines
deletedLines: number;
// Commmit - UNMODIFIED, ADDED, DELETED, MODIFIED, IGNORED, TYPECHANGE, UNREADABLE, CONFLICT
status: string[];
// Commit hunks
hunks: [
// Hunk header
header: string
// Hunk total insert tokens
insertTokens: number;
// Hunk total deleted tokens
deletionTokens: number;
lines: [{
// Line orgin
origin: number;
// Line old line number
oldLineno: number;
// Line new line number
newLineno: number;
// Line type - CONTEXT, ADDITION, DELETION. CONTEXT_EOFNL. ADD_EOFNL, DEL_EOFNL. FILE_HDR, HUNK_HDR, BINARY
type: string;
// Line diff - '+', '-', ''
diffType: string;
// Line output
content: string;
}
...
]
]
}
}
`

#### GitRepoUsersCommitCount

`typescript
GitRepoUsersCommitCount = [
{
// User signature author name
authorName: string;
// User commits
commits: number;
}
...
]
`

#### GitRepoFilePaths

`typescript
// Repo file paths
GitRepoFilePaths = string[]
`

#### GitRepoStatistics

`typescript
// Repo Statistics same as https://github.com/github/git-sizer
GitRepoStatistics = {
// Count repositorys unqiue objects
repositorySize: {
commits: { count: number; size: number; },
trees: { count: number; size: number; entries: number; },
blobs: { count: number; size: number; },
annotatedTags: { count: number; },
references: { count: number; }
};
// Count max Objects
biggestObjects: {
commits: { maxSize: number; maxParents: number; };
trees: { maxEntries: number; },
blobs: { maxSize: number; }
};
// Max depth graph
historyStructure: { maxDepth: number; maxTagDepth: number; };
// Biggest commit
biggestCheckouts: {
numDirectories: number;
maxPathDepth: number;
maxPathLength: number;
numFiles: number;
totalFileSize: number;
numSymlinks: number;
numSubmodules: number;
}
}
`

#### GitRepoGreps

`typescript
GitRepoGreps = [
{
// Repo file path
filePath: string;
// Repo file line number
lineno: string;
// Repo file line
line: string;
}
...
]
`

#### GitRepoFilesSize

`typescript
GitRepoFilesSize = [
{
// Repo file path
filePath: string;
// Repo file size in bytes
size: string;
}
...
]
`

#### GitRepoUnpack

`typescript
GitRepoUnpack = {
count: number;
size: number;
'in-pack': number;
packs: number;
'size-pack': number;
'prune-packable': number;
garbage: number;
'size-garbage': number;
}
`

#### GitUsersRefs

`typescript
GitUsersRefs = [
{
// Commit signature author name
authorName: string;
// Commit signature author email
authorEmail: string;
// Commit committer name
committerName: string;
// Commit commiter email
committerEmail: string;
// Tagger name
taggerName: string;
// Tagger Email
taggerEmail: string;
// Refs Object Type commmits
totalCommits: number;
// Refs Object Type Tags
totalTags: number;
// Refs Object Type Tress
totalTrees: number;
// Refs Object Type Blobs
totalBlobs: number;
// Refs
refs: {
// Refs
refName: string;
// Refs Object Type
objectType: string;
// Refs sha
objectName: string;
// Commit message
subject: string;
}[]
}
...
]
`

#### GitRepoAncestor

`typescript
// List all ancestors branches with sha
GitRepoAncestor = {
// Ref short name
ref: string;
// Head commit unique ID sha-1
sha: string;
ancestors: {
// Ancestor ref short name
ref: string;
// Ancestor commit unique ID sha-1
sha: string;
}[]
};
`

#### GitRepoAncestor

`typescript
// List all dii files filter
GitLogFilter = {
// Head commit unique ID sha-1
sha: string;
// Commit date as ISO
date: string;
// Commit message
message: string;
// Commit signature author name
authorName: string;
// Commit signature author email
authorEmail: string;
// Commit committer name
committerName: string;
// Commit commiter email
committerEmail: string;
// Committed diff files
files: string[]
}

``