-
-
Notifications
You must be signed in to change notification settings - Fork 363
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
146 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
import { execFileSync } from "child_process" | ||
|
||
import { logGitCommits } from "../localLogGitCommits" | ||
|
||
const COMMAND_OUTPUT = "" | ||
|
||
jest.mock("child_process", () => ({ | ||
__esModule: true, | ||
execFileSync: jest.fn(() => COMMAND_OUTPUT), | ||
})) | ||
|
||
it("get git commits from the 'git log' command", () => { | ||
const options = { | ||
number: 10, | ||
branch: "test_branch", | ||
fields: ["hash" as "hash", "subject" as "subject"], | ||
} | ||
|
||
const result = logGitCommits(options) | ||
|
||
expect(execFileSync).toHaveBeenCalledWith("git", [ | ||
"log", | ||
"-l0", | ||
`-n ${options.number}`, | ||
"--pretty=@begin@" + "\t%H\t%s" + "@end@", | ||
options.branch, | ||
]) | ||
|
||
expect(result).toEqual([]) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
import { execFileSync } from "child_process" | ||
|
||
const delimiter = "\t" | ||
const fieldMap = { | ||
hash: "%H", | ||
treeHash: "%T", | ||
abbrevParentHashes: "%P", | ||
authorName: "%an", | ||
authorEmail: "%ae", | ||
authorDate: "%ai", | ||
committerName: "%cn", | ||
committerEmail: "%ce", | ||
committerDate: "%cd", | ||
subject: "%s", | ||
} | ||
|
||
export type GitLogOptions = { | ||
number: number | ||
branch: string | ||
fields: Array<Partial<keyof typeof fieldMap>> | ||
} | ||
|
||
export type GitLogCommit = { | ||
hash: string | ||
treeHash: string | ||
abbrevParentHashes: string | ||
authorName: string | ||
authorEmail: string | ||
authorDate: string | ||
committerName: string | ||
committerEmail: string | ||
committerDate: string | ||
subject: string | ||
} | ||
|
||
const createCommandArguments = (options: GitLogOptions) => { | ||
// Start constructing command | ||
let command: string[] = ["log", "-l0"] | ||
|
||
command.push(`-n ${options.number}`) | ||
|
||
// Start of custom format | ||
let prettyArgument = "--pretty=@begin@" | ||
|
||
// Iterating through the fields and adding them to the custom format | ||
if (options.fields) { | ||
options.fields.forEach(field => { | ||
prettyArgument += delimiter + fieldMap[field] | ||
}) | ||
} | ||
|
||
// Close custom format | ||
prettyArgument += "@end@" | ||
command.push(prettyArgument) | ||
|
||
// Append branch (revision range) if specified | ||
if (options.branch) { | ||
command.push(options.branch) | ||
} | ||
|
||
return command | ||
} | ||
|
||
const parseCommits = (commits: string[], fields: string[]) => | ||
commits.map(rawCommit => { | ||
const parts = rawCommit.split("@end@") | ||
const commit = parts[0].split(delimiter) | ||
|
||
// Remove the first empty char from the array | ||
commit.shift() | ||
|
||
const parsed = {} | ||
|
||
commit.forEach((commitField, index) => { | ||
if (!fields[index]) { | ||
return | ||
} | ||
|
||
parsed[fields[index]] = commitField | ||
}) | ||
|
||
return parsed as GitLogCommit | ||
}) | ||
|
||
export const logGitCommits = (options: GitLogOptions) => { | ||
const commandArguments = createCommandArguments(options) | ||
|
||
const stdout = execFileSync("git", commandArguments).toString() | ||
|
||
const commits = stdout.split("@begin@") | ||
|
||
if (commits[0] === "") { | ||
commits.shift() | ||
} | ||
|
||
return parseCommits(commits, options.fields) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters