# user-meta

> Read user name, email and URL from .npmrc or .gitconfig

Latest version **1.0.0** (published 2017-08-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install user-meta
pnpm add user-meta
yarn add user-meta
bun add user-meta
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-08-23 |
| First published | 2017-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Artem Sapegin |
| Maintainers | sapegin |
| Keywords | npm, npmrc, git, gitconfig, name, username, user, url, config, configuration |

## Links

- npm: https://www.npmjs.com/package/user-meta
- Repository: https://github.com/sapegin/user-meta
- Issues: https://github.com/sapegin/user-meta/issues
- npm.io page: https://npm.io/package/user-meta

## Dependencies (1)

- [rc](https://npm.io/package/rc.md) ^1.2.1

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-08-23

## 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.

---
_Source: https://npm.io/package/user-meta · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._