Require Node.js 12.20 and move to ESM

sindresorhus · sindresorhus · commit aa0cf6ed283f · 2021-10-18T18:43:12.000+07:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -10,12 +10,10 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - 14
-          - 12
-          - 10
+          - 16
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
diff --git a/index.d.ts b/index.d.ts
@@ -1,108 +1,95 @@
-declare namespace newGithubIssueUrl {
-	interface CommonOptions {
-		/**
-		The issue body.
-		*/
-		readonly body?: string;
-
-		/**
-		The issue title.
-		*/
-		readonly title?: string;
-
-		/**
-		Use an [issue template](https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/).
-
-		@example
-		```
-		'unicorn.md' // If you want to use a template at `ISSUE_TEMPLATE/unicorn.md`.
-		```
-		*/
-		readonly template?: string;
-
-		/**
-		The labels for the issue.
-
-		_Requires the user to have the permission to add labels._
-		*/
-		readonly labels?: string[];
-
-		/**
-		The milestone for the issue.
-
-		_Requires the user to have the permission to add milestone._
-		*/
-		readonly milestone?: string;
-
-		/**
-		The user to assign to the issue.
-
-		_Requires the user to have the permission to add assignee._
-		*/
-		readonly assignee?: string;
-
-		/**
-		The projects to add the issue to.
-		The project reference format is `user/<project-number>`, for example, if the URL to the project is `https://github.com/sindresorhus/some-repo/projects/3`, the project reference would be `some-repo/3`.
-
-		_Requires the user to have the permission to add projects._
-		*/
-		readonly projects?: string[];
-	}
-
-	interface RepoUrlOptions extends CommonOptions {
-		/**
-		The full URL to the repo.
-		*/
-		readonly repoUrl: string;
-	}
-
-	interface UserAndRepoOptions extends CommonOptions {
-		/**
-		GitHub username or organization.
-		*/
-		readonly user: string;
-
-		/**
-		GitHub repo.
-		*/
-		readonly repo: string;
-	}
+export interface CommonOptions {
+	/**
+	The issue body.
+	*/
+	readonly body?: string;
 
 	/**
-	You are required to either specify the `repoUrl` option or both the `user` and `repo` options.
+	The issue title.
 	*/
-	type Options = RepoUrlOptions | UserAndRepoOptions;
-}
+	readonly title?: string;
 
-declare const newGithubIssueUrl: {
 	/**
-	Generate a URL for opening a new GitHub issue with prefilled title, body, and other fields.
+	Use an [issue template](https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/).
 
 	@example
 	```
-	import newGithubIssueUrl = require('new-github-issue-url');
-	import open = require('open');
-
-	const url = newGithubIssueUrl({
-		user: 'sindresorhus',
-		repo: 'new-github-issue-url',
-		body: '\n\n\n---\nI\'m a human. Please be nice.'
-	});
-	//=> 'https://github.com/sindresorhus/new-github-issue-url/issues/new?body=%0A%0A%0A---%0AI%27m+a+human.+Please+be+nice.'
-
-	// Then open it
-	(async () => {
-		await open(url);
-	}}();
+	'unicorn.md' // If you want to use a template at `ISSUE_TEMPLATE/unicorn.md`.
 	```
 	*/
-	(options: newGithubIssueUrl.Options): string;
+	readonly template?: string;
+
+	/**
+	The labels for the issue.
+
+	_Requires the user to have the permission to add labels._
+	*/
+	readonly labels?: string[];
+
+	/**
+	The milestone for the issue.
+
+	_Requires the user to have the permission to add milestone._
+	*/
+	readonly milestone?: string;
+
+	/**
+	The user to assign to the issue.
+
+	_Requires the user to have the permission to add assignee._
+	*/
+	readonly assignee?: string;
 
-	// TODO: Remove this for the next major release, refactor the whole definition to:
-	// declare function newGithubIssueUrl(options: newGithubIssueUrl.Options): string;
-	// export = newGithubIssueUrl;
-	default: typeof newGithubIssueUrl;
-};
+	/**
+	The projects to add the issue to.
+	The project reference format is `user/<project-number>`, for example, if the URL to the project is `https://github.com/sindresorhus/some-repo/projects/3`, the project reference would be `some-repo/3`.
+
+	_Requires the user to have the permission to add projects._
+	*/
+	readonly projects?: string[];
+}
+
+export interface RepoUrlOptions extends CommonOptions {
+	/**
+	The full URL to the repo.
+	*/
+	readonly repoUrl: string;
+}
+
+export interface UserAndRepoOptions extends CommonOptions {
+	/**
+	GitHub username or organization.
+	*/
+	readonly user: string;
+
+	/**
+	GitHub repo.
+	*/
+	readonly repo: string;
+}
 
-export = newGithubIssueUrl;
+/**
+You are required to either specify the `repoUrl` option or both the `user` and `repo` options.
+*/
+export type Options = RepoUrlOptions | UserAndRepoOptions;
+
+/**
+Generate a URL for opening a new GitHub issue with prefilled title, body, and other fields.
+
+@example
+```
+import newGithubIssueUrl from 'new-github-issue-url';
+import open from 'open';
+
+const url = newGithubIssueUrl({
+	user: 'sindresorhus',
+	repo: 'new-github-issue-url',
+	body: '\n\n\n---\nI\'m a human. Please be nice.'
+});
+//=> 'https://github.com/sindresorhus/new-github-issue-url/issues/new?body=%0A%0A%0A---%0AI%27m+a+human.+Please+be+nice.'
+
+// Then open it
+await open(url);
+```
+*/
+export default function newGithubIssueUrl(options: Options): string;
diff --git a/index.js b/index.js
@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = (options = {}) => {
+export default function newGithubIssueUrl(options = {}) {
 	let repoUrl;
 	if (options.repoUrl) {
 		repoUrl = options.repoUrl;
@@ -19,7 +17,7 @@ module.exports = (options = {}) => {
 		'template',
 		'milestone',
 		'assignee',
-		'projects'
+		'projects',
 	];
 
 	for (const type of types) {
@@ -40,7 +38,4 @@ module.exports = (options = {}) => {
 	}
 
 	return url.toString();
-};
-
-// TODO: Remove this for the next major release
-module.exports.default = module.exports;
+}
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -1,16 +1,16 @@
 import {expectType} from 'tsd';
-import newGithubIssueUrl = require('.');
+import newGithubIssueUrl from './index.js';
 
 expectType<string>(
 	newGithubIssueUrl({
 		repoUrl: 'https://github.com/sindresorhus/new-github-issue-url',
-		body: 'test'
-	})
+		body: 'test',
+	}),
 );
 
 expectType<string>(
 	newGithubIssueUrl({
 		user: 'sindresorhus',
-		repo: 'new-github-issue-url'
-	})
+		repo: 'new-github-issue-url',
+	}),
 );
diff --git a/license b/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:
 
diff --git a/package.json b/package.json
@@ -4,13 +4,16 @@
 	"description": "Generate a URL for opening a new GitHub issue with prefilled title, body, and other fields",
 	"license": "MIT",
 	"repository": "sindresorhus/new-github-issue-url",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=10"
+		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -32,8 +35,8 @@
 		"params"
 	],
 	"devDependencies": {
-		"ava": "^1.4.1",
-		"tsd": "^0.7.2",
-		"xo": "^0.24.0"
+		"ava": "^3.15.0",
+		"tsd": "^0.18.0",
+		"xo": "^0.45.0"
 	}
 }
diff --git a/readme.md b/readme.md
@@ -4,19 +4,17 @@
 
 GitHub supports prefilling a new issue by setting [certain search parameters](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-url-query). This package simplifies generating such URL.
 
-
 ## Install
 
-```
-$ npm install new-github-issue-url
+```sh
+npm install new-github-issue-url
 ```
 
-
 ## Usage
 
 ```js
-const newGithubIssueUrl = require('new-github-issue-url');
-const open = require('open');
+import newGithubIssueUrl from 'new-github-issue-url';
+import open from 'open';
 
 const url = newGithubIssueUrl({
 	user: 'sindresorhus',
@@ -26,16 +24,14 @@ const url = newGithubIssueUrl({
 //=> 'https://github.com/sindresorhus/new-github-issue-url/issues/new?body=%0A%0A%0A---%0AI%27m+a+human.+Please+be+nice.'
 
 // Then open it
-(async () => {
-	await open(url);
-})();
+await open(url);
 ```
 
-[Try the URL](https://github.com/sindresorhus/new-github-issue-url/issues/new?body=%0A%0A%0A---%0AI%27m+a+human.+Please+be+nice.)<br>*(Don't click the "Submit new issue" button!)*
+[Try the URL](https://github.com/sindresorhus/new-github-issue-url/issues/new?body=%0A%0A%0A---%0AI%27m+a+human.+Please+be+nice.)\
+*(Don't click the "Submit new issue" button!)*
 
 If you use Electron, check out `electron-util`'s [`openNewGitHubIssue()` method](https://github.com/sindresorhus/electron-util#opennewgithubissueoptions).
 
-
 ## API
 
 ### newGithubIssueUrl(options)
@@ -120,12 +116,6 @@ The project reference format is `user/repo/<project-number>`, for example, if th
 
 *Requires the user to have the permission to add projects.*
 
-
 ## Related
 
 - [new-github-release-url](https://github.com/sindresorhus/new-github-release-url) - Generate a URL for opening a new GitHub release with prefilled tag, body, and other fields
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)
diff --git a/test.js b/test.js
@@ -1,5 +1,5 @@
 import test from 'ava';
-import newGithubIssueUrl from '.';
+import newGithubIssueUrl from './index.js';
 
 test('main', t => {
 	const user = 'sindresorhus';
@@ -11,7 +11,7 @@ test('main', t => {
 		user,
 		repo,
 		body,
-		title
+		title,
 	});
 
 	const {searchParams} = new URL(urlString);
@@ -30,7 +30,7 @@ test('repoUrl option', t => {
 	const urlString = newGithubIssueUrl({
 		repoUrl,
 		body,
-		title
+		title,
 	});
 
 	const {searchParams} = new URL(urlString);
@@ -43,5 +43,7 @@ test('repoUrl option', t => {
 test('throws when required options are not specified', t => {
 	t.throws(() => {
 		newGithubIssueUrl();
-	}, /need to specify either/);
+	}, {
+		message: /need to specify either/,
+	});
 });

-Original file line number
+Diff line change
@@ @@ -1,6 +1,6 @@ @@
 MIT License
 -Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
 +Copyright (c) Sindre Sorhus <[email protected]> (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: