.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 18
+          - 16
+          - 14
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

.gitignore

@@ -1 +1,2 @@
 node_modules
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+package-lock=false

index.js

@@ -1,68 +1,91 @@
-'use strict';
-const got = require('got');
-const isPlainObj = require('is-plain-obj');
+import process from 'node:process';
+import got from 'got';
 
-function ghGot(path, opts) {
-	if (typeof path !== 'string') {
-		return Promise.reject(new TypeError(`Expected \`path\` to be a string, got ${typeof path}`));
-	}
+const getRateLimit = headers => ({
+	limit: Number.parseInt(headers['x-ratelimit-limit'], 10),
+	remaining: Number.parseInt(headers['x-ratelimit-remaining'], 10),
+	reset: new Date(Number.parseInt(headers['x-ratelimit-reset'], 10) * 1000),
+});
 
-	const env = process.env;
+const create = () => got.extend({
+	prefixUrl: process.env.GITHUB_ENDPOINT || 'https://api.github.com',
+	headers: {
+		accept: 'application/vnd.github.v3+json',
+		'user-agent': 'https://github.com/sindresorhus/gh-got',
+	},
+	responseType: 'json',
+	context: {
+		token: process.env.GITHUB_TOKEN,
+	},
+	hooks: {
+		init: [
+			(raw, options) => {
+				// TODO: This should be fixed in Got.
+				// TODO: This doesn't seem to have any effect.
+				if (typeof options.url === 'string' && options.url.startsWith('/')) {
+					options.url = options.url.slice(1);
+				}
 
-	opts = Object.assign({
-		json: true,
-		token: env.GITHUB_TOKEN,
-		endpoint: env.GITHUB_ENDPOINT ? env.GITHUB_ENDPOINT.replace(/[^/]$/, '$&/') : 'https://api.github.com/'
-	}, opts);
+				if ('token' in raw) {
+					options.context.token = raw.token;
+					delete raw.token;
+				}
+			},
+		],
+	},
+	handlers: [
+		(options, next) => {
+			// TODO: This should be fixed in Got
+			// TODO: This doesn't seem to have any effect.
+			if (typeof options.url === 'string' && options.url.startsWith('/')) {
+				options.url = options.url.slice(1);
+			}
 
-	opts.headers = Object.assign({
-		accept: 'application/vnd.github.v3+json',
-		'user-agent': 'https://github.com/sindresorhus/gh-got'
-	}, opts.headers);
+			// Authorization
+			const {token} = options.context;
+			if (token && !options.headers.authorization) {
+				options.headers.authorization = `token ${token}`;
+			}
 
-	if (opts.token) {
-		opts.headers.authorization = `token ${opts.token}`;
-	}
+			// Don't touch streams
+			if (options.isStream) {
+				return next(options);
+			}
 
-	// https://developer.github.com/v3/#http-verbs
-	if (opts.method && opts.method.toLowerCase() === 'put' && !opts.body) {
-		opts.headers['content-length'] = 0;
-	}
+			// Magic begins
+			return (async () => {
+				try {
+					const response = await next(options);
 
-	const url = /^https?/.test(path) ? path : opts.endpoint + path;
+					// Rate limit for the Response object
+					response.rateLimit = getRateLimit(response.headers);
 
-	if (opts.stream) {
-		return got.stream(url, opts);
-	}
+					return response;
+				} catch (error) {
+					const {response} = error;
 
-	return got(url, opts).catch(err => {
-		if (err.response && isPlainObj(err.response.body)) {
-			err.name = 'GitHubError';
-			err.message = `${err.response.body.message} (${err.statusCode})`;
-		}
+					// Nicer errors
+					if (response && response.body) {
+						error.name = 'GitHubError';
+						error.message = `${response.body.message} (${response.statusCode})`;
+					}
 
-		throw err;
-	});
-}
+					// Rate limit for errors
+					if (response) {
+						error.rateLimit = getRateLimit(response.headers);
+					}
 
-const helpers = [
-	'get',
-	'post',
-	'put',
-	'patch',
-	'head',
-	'delete'
-];
+					throw error;
+				}
+			})();
+		},
+	],
+});
 
-ghGot.stream = (url, opts) => ghGot(url, Object.assign({}, opts, {
-	json: false,
-	stream: true
-}));
+const ghGot = create();
 
-for (const x of helpers) {
-	const method = x.toUpperCase();
-	ghGot[x] = (url, opts) => ghGot(url, Object.assign({}, opts, {method}));
-	ghGot.stream[x] = (url, opts) => ghGot.stream(url, Object.assign({}, opts, {method}));
-}
+export default ghGot;
 
-module.exports = ghGot;
+if (process.env.NODE_ENV === 'test') {
+	ghGot.recreate = create;
+}

license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package.json

@@ -1,48 +1,45 @@
 {
-  "name": "gh-got",
-  "version": "6.0.0",
-  "description": "Convenience wrapper for `got` to interact with the GitHub API",
-  "license": "MIT",
-  "repository": "sindresorhus/gh-got",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=4"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "got",
-    "gh",
-    "github",
-    "api",
-    "request",
-    "http",
-    "https",
-    "get",
-    "url",
-    "uri",
-    "util",
-    "utility"
-  ],
-  "dependencies": {
-    "got": "^7.0.0",
-    "is-plain-obj": "^1.1.0"
-  },
-  "devDependencies": {
-    "ava": "*",
-    "get-stream": "^2.0.0",
-    "nock": "^8.0.0",
-    "xo": "*"
-  },
-  "xo": {
-    "esnext": true
-  }
+	"name": "gh-got",
+	"version": "10.0.0",
+	"description": "Convenience wrapper for Got to interact with the GitHub API",
+	"license": "MIT",
+	"repository": "sindresorhus/gh-got",
+	"funding": "https://github.com/sindresorhus/got?sponsor=1",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "https://sindresorhus.com"
+	},
+	"type": "module",
+	"exports": "./index.js",
+	"engines": {
+		"node": ">=14.16"
+	},
+	"scripts": {
+		"test": "xo && ava"
+	},
+	"files": [
+		"index.js"
+	],
+	"keywords": [
+		"got",
+		"gh",
+		"github",
+		"api",
+		"request",
+		"http",
+		"https",
+		"get",
+		"url",
+		"utility"
+	],
+	"dependencies": {
+		"got": "^12.5.2"
+	},
+	"devDependencies": {
+		"ava": "^4.3.3",
+		"get-stream": "^6.0.1",
+		"nock": "^13.2.9",
+		"xo": "^0.52.4"
+	}
 }

readme.md

@@ -1,88 +1,134 @@
-# gh-got [![Build Status](https://travis-ci.org/sindresorhus/gh-got.svg?branch=master)](https://travis-ci.org/sindresorhus/gh-got)
+# gh-got
 
-> Convenience wrapper for [`got`](https://github.com/sindresorhus/got) to interact with the [GitHub API](https://developer.github.com/v3/)
+> Convenience wrapper for [Got](https://github.com/sindresorhus/got) to interact with the [GitHub API](https://developer.github.com/v3/)
 
+Unless you're already using Got, you should probably use GitHub's own [@octokit/rest.js](https://github.com/octokit/rest.js) or [@octokit/graphql.js](https://github.com/octokit/graphql.js) packages instead.
 
 ## Install
 
+```sh
+npm install gh-got
 ```
-$ npm install --save gh-got
-```
-
 
 ## Usage
 
 Instead of:
 
 ```js
-const got = require('got');
+import got from 'got';
+
 const token = 'foo';
 
-got('https://api.github.com/users/sindresorhus', {
+const {body} = await got('https://api.github.com/users/sindresorhus', {
 	json: true,
 	headers: {
 		'accept': 'application/vnd.github.v3+json',
 		'authorization': `token ${token}`
 	}
-}).then(res => {
-	console.log(res.body.login);
-	//=> 'sindresorhus'
 });
+
+console.log(body.login);
+//=> 'sindresorhus'
 ```
 
 You can do:
 
 ```js
-const ghGot = require('gh-got');
+import ghGot from 'gh-got';
 
-ghGot('users/sindresorhus', {token: 'foo'}).then(res => {
-	console.log(res.body.login);
-	//=> 'sindresorhus'
+const {body} = await ghGot('users/sindresorhus', {
+	context: {
+		token: 'foo'
+	}
 });
+
+console.log(body.login);
+//=> 'sindresorhus'
 ```
 
 Or:
 
 ```js
-const ghGot = require('gh-got');
+import ghGot from 'gh-got';
 
-ghGot('https://api.github.com/users/sindresorhus', {token: 'foo'}).then(res => {
-	console.log(res.body.login);
-	//=> 'sindresorhus'
+const {body} = await ghGot('https://api.github.com/users/sindresorhus', {
+	context: {
+		token: 'foo'
+	}
 });
-```
 
+console.log(body.login);
+//=> 'sindresorhus'
+```
 
 ## API
 
-Same as [`got`](https://github.com/sindresorhus/got) (including the stream API and aliases), but with some additional options below.
+Same API as [`got`](https://github.com/sindresorhus/got), including options, the stream API, aliases, pagination, etc, but with some additional options below.
 
 Errors are improved by using the custom GitHub error messages. Doesn't apply to the stream API.
 
-### token
+### `gh-got` specific options
+
+#### token
 
 Type: `string`
 
 GitHub [access token](https://github.com/settings/tokens/new).
 
 Can be set globally with the `GITHUB_TOKEN` environment variable.
 
-### endpoint
+#### prefixUrl
 
-Type: `string`<br>
+Type: `string`\
 Default: `https://api.github.com/`
 
 To support [GitHub Enterprise](https://enterprise.github.com).
 
 Can be set globally with the `GITHUB_ENDPOINT` environment variable.
 
-### body
+#### body
 
-Type: `Object`
+Type: `object`
 
 Can be specified as a plain object and will be serialized as JSON with the appropriate headers set.
 
+## Rate limit
+
+Responses and errors have a `.rateLimit` property with info about the current [rate limit](https://developer.github.com/v3/#rate-limiting). *(This is not yet implemented for the stream API)*
+
+```js
+import ghGot from 'gh-got';
+
+const {rateLimit} = await ghGot('users/sindresorhus');
+
+console.log(rateLimit);
+//=> {limit: 5000, remaining: 4899, reset: [Date 2018-12-31T20:45:20.000Z]}
+```
+
+## Authorization
+
+Authorization for GitHub uses the following logic:
+
+1. If `options.headers.authorization` is passed to `gh-got`, then this will be used as first preference.
+2. If `options.token` is provided, then the `authorization` header will be set to `token <options.token>`.
+3. If `options.headers.authorization` and `options.token` are not provided, then the `authorization` header will be set to `token <process.env.GITHUB_TOKEN>`
+
+In most cases, this means you can simply set `GITHUB_TOKEN`, but it also allows it to be overridden by setting `options.token` or `options.headers.authorization` explicitly. For example, if [authenticating as a GitHub App](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app), you could do the following:
+
+```js
+import ghGot from 'gh-got';
+
+const options = {
+	headers: {
+		authorization: `Bearer ${jwt}`
+	}
+};
+const {body} = await ghGot('app', options);
+
+console.log(body.name);
+//=> 'MyApp'
+```
 
-## License
+## Pagination
 
-MIT © [Sindre Sorhus](https://sindresorhus.com)
+See the [Got docs](https://github.com/sindresorhus/got/blob/main/documentation/4-pagination.md).

test.js

@@ -1,65 +1,115 @@
+import process from 'node:process';
 import test from 'ava';
 import nock from 'nock';
 import getStream from 'get-stream';
-import m from '.';
+import ghGot from './index.js';
 
 const token = process.env.GITHUB_TOKEN;
 
 test('default', async t => {
-	t.is((await m('users/sindresorhus')).body.login, 'sindresorhus');
+	const {body} = await ghGot('users/sindresorhus');
+	t.is(body.login, 'sindresorhus');
 });
 
 test('full path', async t => {
-	t.is((await m('https://api.github.com/users/sindresorhus')).body.login, 'sindresorhus');
+	const {body} = await ghGot('https://api.github.com/users/sindresorhus', {prefixUrl: ''});
+	t.is(body.login, 'sindresorhus');
 });
 
 test('accepts options', async t => {
-	t.is((await m('users/sindresorhus', {})).body.login, 'sindresorhus');
+	const {body} = await ghGot('users/sindresorhus', {});
+	t.is(body.login, 'sindresorhus');
+});
+
+test('accepts options.prefixUrl without trailing slash', async t => {
+	const {body} = await ghGot('users/sindresorhus', {prefixUrl: 'https://api.github.com'});
+	t.is(body.login, 'sindresorhus');
+});
+
+test.failing('dedupes slashes', async t => {
+	const {body} = await ghGot('/users/sindresorhus', {prefixUrl: 'https://api.github.com/'});
+	t.is(body.login, 'sindresorhus');
 });
 
 test.serial('global token option', async t => {
 	process.env.GITHUB_TOKEN = 'fail';
-	await t.throws(m('users/sindresorhus'), 'Bad credentials (401)');
+
+	await t.throwsAsync(
+		ghGot.recreate()('users/sindresorhus'),
+		{
+			message: 'Bad credentials (401)',
+		},
+	);
+
 	process.env.GITHUB_TOKEN = token;
 });
 
 test('token option', async t => {
-	await t.throws(m('users/sindresorhus', {token: 'fail'}), 'Bad credentials (401)');
+	await t.throwsAsync(ghGot('users/sindresorhus', {context: {token: 'fail'}}), {
+		message: 'Bad credentials (401)',
+	});
 });
 
 test.serial('global endpoint option', async t => {
 	process.env.GITHUB_ENDPOINT = 'fail';
-	await t.throws(m('users/sindresorhus', {retries: 1}), /ENOTFOUND/);
+
+	await t.throwsAsync(ghGot.recreate()('users/sindresorhus', {retries: 1}), {
+		message: /Invalid URL/,
+	});
+
 	delete process.env.GITHUB_ENDPOINT;
 });
 
 test.serial('endpoint option', async t => {
 	process.env.GITHUB_ENDPOINT = 'https://api.github.com/';
-	await t.throws(m('users/sindresorhus', {
-		endpoint: 'fail',
-		retries: 1
-	}), /ENOTFOUND/);
+
+	await t.throwsAsync(ghGot.recreate()('users/sindresorhus', {
+		prefixUrl: 'fail',
+		retries: 1,
+	}), {
+		message: /Invalid URL/,
+	});
+
 	delete process.env.GITHUB_ENDPOINT;
 });
 
 test('stream interface', async t => {
-	t.is(JSON.parse(await getStream(m.stream('users/sindresorhus'))).login, 'sindresorhus');
-	t.is(JSON.parse(await getStream(m.stream.get('users/sindresorhus'))).login, 'sindresorhus');
+	const string1 = await getStream(ghGot.stream('users/sindresorhus'));
+	t.is(JSON.parse(string1).login, 'sindresorhus');
+
+	const string2 = await getStream(ghGot.stream.get('users/sindresorhus'));
+	t.is(JSON.parse(string2).login, 'sindresorhus');
 });
 
 test('json body', async t => {
-	const endpoint = 'http://mock-endpoint';
-	const body = {test: [1, 3, 3, 7]};
+	const prefixUrl = 'http://mock-endpoint';
+	const postBody = {test: [1, 3, 3, 7]};
 	const reply = {ok: true};
 
-	const scope = nock(endpoint).post('/test', body).reply(200, reply);
+	const scope = nock(prefixUrl).post('/test', postBody).reply(200, reply);
 
-	t.deepEqual((await m('/test', {endpoint, body})).body, reply);
+	const {body} = await ghGot.post('test', {prefixUrl, json: postBody});
+	t.deepEqual(body, reply);
 	t.truthy(scope.isDone());
 });
 
 test('custom error', async t => {
-	const err = await t.throws(m('users/sindresorhus', {token: 'fail'}));
-	t.is(err.name, 'GitHubError');
-	t.is(err.message, 'Bad credentials (401)');
+	await t.throwsAsync(ghGot('users/sindresorhus', {context: {token: 'fail'}}), {
+		name: 'GitHubError',
+		message: 'Bad credentials (401)',
+	});
+});
+
+test('.rateLimit response property', async t => {
+	const {rateLimit} = await ghGot('users/sindresorhus');
+	t.is(typeof rateLimit.limit, 'number');
+	t.is(typeof rateLimit.remaining, 'number');
+	t.true(rateLimit.reset instanceof Date);
+});
+
+test('.rateLimit error property', async t => {
+	const {rateLimit} = await t.throwsAsync(ghGot('users/sindresorhus', {context: {token: 'fail'}}));
+	t.is(typeof rateLimit.limit, 'number');
+	t.is(typeof rateLimit.remaining, 'number');
+	t.true(rateLimit.reset instanceof Date);
 });