# coc-github-users

> coc.nvim completion provider for GitHub usernames

Latest version **1.1.2** (published 2021-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install coc-github-users
pnpm add coc-github-users
yarn add coc-github-users
bun add coc-github-users
```

## 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.1.2 |
| Published | 2021-01-06 |
| First published | 2020-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | cb372 |
| Maintainers | cb372 |

## Links

- npm: https://www.npmjs.com/package/coc-github-users
- Repository: https://github.com/cb372/coc-github-users
- npm.io page: https://npm.io/package/coc-github-users

## Recent versions

- 1.1.2 (latest) — 2021-01-06
- 1.1.1 — 2020-11-04
- 1.1.0 — 2020-11-03
- 1.0.0 — 2020-01-20
- 0.0.18 — 2020-01-20
- 0.0.17 — 2020-01-20
- 0.0.16 — 2020-01-20
- 0.0.15 — 2020-01-20
- 0.0.14 — 2020-01-20
- 0.0.13 — 2020-01-20
- 0.0.12 — 2020-01-20
- 0.0.11 — 2020-01-17
- 0.0.10 — 2020-01-17
- 0.0.9 — 2020-01-17
- 0.0.8 — 2020-01-17
- … 7 more at https://npm.io/package/coc-github-users/versions

## README

# coc-github-users

An extension for [coc.nvim](https://github.com/neoclide/coc.nvim) that provides
completions for GitHub usernames.

This is useful when writing git commit messages or when using [hub
pull-request](https://hub.github.com/) to create a PR.

Allows you to search for users either by their username or real name.

![Example](example.gif)

## Installation

1. Add the extension to coc.nvim:

   ```
   :CocInstall coc-github-users
   ```

2. Create a GitHub personal access token so the extension can access the GitHub
   API.
   1. Go to the [GitHub tokens page](https://github.com/settings/tokens)
   2. Click the `Generate new token` button
   3. Give the token a sensible name, e.g. `coc-github-users`
   4. The token doesn't need any scopes
   5. Click `Generate token` at the bottom of the page

3. Either export the token as environment variable `COC_GITHUB_USERS_TOKEN`, or
   add it to your coc.nvim config (`:CocConfig`) with key
   `coc.githubUsers.githubAccessToken`.

## How to use

Typing `@` followed by 2 or more characters will trigger the extension. For
example, if you type `@cb3`, you will get a list of autocomplete items for
usernames starting with `@cb3`, including my username `@cb372`.

For users who have added their real name to their GitHub profile, you will see
both their username and real name in the autocomplete item label.

You can search by real name by separating the names with underscores. For
example, if you type `@chris_birchall` you will also get you an autocomplete
list containing my username `@cb372`.

## Github Enterprise support

If you have an internal GitHub enterprise installation at work, you can configure it like so:

```json
{
  "coc.githubUsers.graphqlApiUrl": "http://your.internal.github.company.com/api/graphql",
  "coc.githubUsers.unixSocket": "/optional/path/to/unix.sock"
}
```

The `unixSocket` is optional, but useful if your company proxies all internal traffic through a local socket.

If you prefer ENV variables, you can configure:

* `COC_GITHUB_USERS_GRAPHQL_API_URL`
* `COC_GITHUB_USERS_UNIX_SOCKET`

in your shell environment instead.

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