https://github.com/sapegin/user-meta
Read user name, email and URL from .npmrc or .gitconfig
https://github.com/sapegin/user-meta
Last synced: 3 months ago
JSON representation
Read user name, email and URL from .npmrc or .gitconfig
- Host: GitHub
- URL: https://github.com/sapegin/user-meta
- Owner: sapegin
- License: mit
- Created: 2017-08-23T11:39:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T09:16:15.000Z (almost 3 years ago)
- Last Synced: 2025-10-14T14:52:17.252Z (3 months ago)
- Language: JavaScript
- Size: 56.6 KB
- Stars: 14
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Contributing: Contributing.md
- License: License.md
Awesome Lists containing this project
README
# user-meta
Read user name, email and URL from `.npmrc` or `.gitconfig`.
## Installation
```shell
npm install user-meta
```
## Usage
```js
const { name, email, url } = require('user-meta');
```
## How it works
It tries to read data from your npm and Git configs:
| Property | npm | Git |
| -------- | --- | --- |
| `name` | `npm get init-author-name` | `git config user.name` |
| `email` | `npm get init-author-email` | `git config user.email` |
| `url` | `npm get init-author-url` | — |
Npm has priority over Git. `git` binary is required and used to read Git configuration. Don’t use this module if performance is important.
## Changelog
The changelog can be found on the [Releases page](https://github.com/sapegin/user-meta/releases).
## Contributing
Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](Contributing.md).
## Authors and license
[Artem Sapegin](http://sapegin.me) and [contributors](https://github.com/sapegin/user-meta/graphs/contributors).
MIT License, see the included [License.md](License.md) file.