rocktimsaikia / read-git-user Goto Github PK

View Code? Open in Web Editor NEW

3.0 3.0 1.0 17 KB

Reads the username and email from `.gitconfig` and returns it as json object

License: MIT License

JavaScript 100.00%

gitconfig github github-user

read-git-user's Introduction

read-git-user

Reads the Github username and email from .gitconfig 🔧 and returns it as a json object

Highlights

Tiny(1.3kB ✨) and simple
Returns the original github-username since the stored git name can be altered and not reliable.
Uses Ini to handle the parsing of the ini config file

Install

npm install read-git-user

Usage

import readGitUser = require('read-git-user');

(async () => {
        const gitUser = await readGitUser();
        //=> {username: RocktimsSaikia, email: [email protected]}
})();

API

readGitUser(options?)

Returns a Promise<object> with the parsed JSON.

options

dir

Type: string
Default: os.homedir()

The directory of the .gitconfig file

License

MIT © Rocktim Saikia

read-git-user's People

Contributors

Stargazers

Watchers

Forkers

ozum

read-git-user's Issues

Cannot find module 'xo' or its corresponding type declarations.

Hi,

When used with typescript (v3 and v4), I got following error:

node_modules/read-git-user/index.d.ts:1:23 - error TS2307: Cannot find module 'xo' or its corresponding type declarations.

1 import {Options} from 'xo';
                        ~~~~

Also it seems, xo is not used here. Removing this line corrects the error.

Thanks,

Use node `os` instead of `process`

The current implemented way of getting the user home dir is through the node process api.

https://github.com/RocktimSaikia/read-git-user/blob/aa2d027c8fb72974f2c37414069c506a7c8fb6df/index.js#L8

But this whole line can be optimized with the OS API's homedir property, It reduces the requirement of checking for diff home dir in diff OS. It will return the home dir based on the user's operating system.

Remove the `dir` option.

The whole point of this module is getting the username with automation and zero config. Having a dir option to point to a .gitconfig file is completely opposite and redundant.

read the username using the system email address

The username stored in the system is not very reliable and can be altered anytime and it won't even affect the git cli experience as the authentication process only cares about the email.

No, your user.name does not matter.
However, your user.email should match one of the addresses in your GitHub settings.

https://stackoverflow.com/a/28142874/9360234

So we should read the online Github username by using the existing system email address.
This can be easily achieved with a module like Github-username

run a `exec` command as a fallback function.

Currently, we are navigating to the system's homeDir and extracting the git user details from there. But still, there is a chance of running into some errors while doing so, it may also work differently in different OSS.

So as a fallback function it would be nice to implement an exec run command to read the git user details right from the stdout.Exec based libs like shelljs or execa with good error handling support can be used for this feature.