Git Mob core

> Beta

The core API for managing Git Mob co-authors.

Shared between Git Mob CLI and Git Mob VS code.

``
npm i git-mob-core
`

API

$3

- process.env.GITMOB_MESSAGE_PATH set the primary path to Git message template
- process.env.GITMOB_COAUTHORS_PATH set the primary path to coauthors file

`TS
// Write actions
saveNewCoAuthors(authors: Author[]): >
createCoAuthorsFile(authors: Author[]): >
updateGitTemplate(selectedAuthors?: Author[]): void
solo(): >
setCoAuthors(keys: string[]): >
messageFormatter(txt: string, authors: Author[]): string

// Read actions
getAllAuthors(): >
getPrimaryAuthor(): >
getSelectedCoAuthors(allAuthors): >
setPrimaryAuthor(author: Author): void
repoAuthorList(authorFilter?: string): Promise
pathToCoAuthors(): >

// GitHub
fetchGitHubAuthors(userNames: string[], userAgent: string): >
searchGitHubAuthors(query: string, userAgent: string): >

gitRevParse = {
insideWorkTree(): >,
topLevelDirectory(): >,
};
`

$3

`TS
// Config manager for library
// supported prop: "processCwd" = set the directory to exec commands
getConfig(prop: string): string | undefined
updateConfig(prop: string, value: string): void

// Read GitMob properties from Git config file
gitMobConfig = {
localTemplate(): >,
fetchFromGitHub(): >,
};

// Read Git properties from Git config
gitConfig = {
getLocalCommitTemplate(): >,
getGlobalCommitTemplate(): >,
};
`

$3

Do not change the structure of the class.

`TS
class Author;

// Properties
Author.key: string
Author.name: string
Author.email: string
Author.trailer: AuthorTrailers // defaults to AuthorTrailers.CoAuthorBy

//Methods
Author.format(): string
Author.toString(): string
``