read-git-user

July 31, 2024 ยท View on GitHub

Returns the GitHub username and email of the current system's .gitconfig.

Note

This function retrieves the original GitHub username since the stored
git config name is not reliable. The local name can be changed without
affecting any Git or GitHub activities as long as the email matches any
verified emails on the GitHub account.

Tests npm

Install

npm i read-git-user

Usage

import readGitUser from "read-git-user";

const gitUser = await readGitUser();

console.log(gitUser);
// => {username: rocktimssaikia, email: rocktimthedev@gmail.com}

API

readGitUser(options)

Returns a Promise<object> with the retrieved git config data.

Options (object) :

dir

Type: string
Default: os.homedir()

The directory of the .gitconfig file.
This option is available in-case the config file is not in the default dir for some systems.