supports-hyperlinks 3.1.0 → 4.0.0

package/browser.js

@@ -1,8 +1,10 @@
-'use strict';
-module.exports = {
-	stdin: false,
-	stderr: false,
-	supportsHyperlink: function () { // eslint-disable-line object-shorthand
-		return false;
-	}
+export function createSupportsHyperlinks() {
+	return false;
+}
+
+const supportsHyperlinks = {
+	stdout: createSupportsHyperlinks(),
+	stderr: createSupportsHyperlinks(),
 };
+
+export default supportsHyperlinks;

package/index.d.ts

@@ -1,5 +1,25 @@
-export function supportsHyperlink(stream: {
-    isTTY?: boolean | undefined;
-}): boolean;
-export declare const stdout: boolean;
-export declare const stderr: boolean;
+/**
+Creates a supports hyperlinks check for a given stream.
+
+@param stream - Optional stream to check for hyperlink support.
+@returns boolean indicating whether hyperlinks are supported.
+*/
+export function createSupportsHyperlinks(stream?: {isTTY?: boolean}): boolean;
+
+/**
+Object containing hyperlink support status for stdout and stderr.
+*/
+type SupportsHyperlinks = {
+	/**
+	Whether stdout supports hyperlinks.
+	*/
+	stdout: boolean;
+	/**
+	Whether stderr supports hyperlinks.
+	*/
+	stderr: boolean;
+};
+
+declare const supportsHyperlinks: SupportsHyperlinks;
+
+export default supportsHyperlinks;

package/index.js

@@ -1,35 +1,28 @@
-'use strict';
-const supportsColor = require('supports-color');
-const hasFlag = require('has-flag');
-
-/**
-@param {string} versionString
-@returns {{ major: number, minor: number, patch: number }}
-*/
-function parseVersion(versionString) {
+import process from 'node:process';
+import {createSupportsColor} from 'supports-color';
+import hasFlag from 'has-flag';
+
+function parseVersion(versionString = '') {
 	if (/^\d{3,4}$/.test(versionString)) {
 		// Env var doesn't always use dots. example: 4601 => 46.1.0
-		const m = /(\d{1,2})(\d{2})/.exec(versionString) || [];
+		const match = /(\d{1,2})(\d{2})/.exec(versionString) ?? [];
 		return {
 			major: 0,
-			minor: parseInt(m[1], 10),
-			patch: parseInt(m[2], 10)
+			minor: Number.parseInt(match[1], 10),
+			patch: Number.parseInt(match[2], 10),
 		};
 	}
 
-	const versions = (versionString || '').split('.').map(n => parseInt(n, 10));
+	const versions = (versionString ?? '').split('.').map(n => Number.parseInt(n, 10));
 	return {
 		major: versions[0],
 		minor: versions[1],
-		patch: versions[2]
+		patch: versions[2],
 	};
 }
 
-/**
-@param {{ isTTY?: boolean | undefined }} stream
-@returns {boolean}
-*/
-function supportsHyperlink(stream) {
+// eslint-disable-next-line complexity
+export function createSupportsHyperlinks(stream) {
 	const {
 		CI,
 		FORCE_HYPERLINK,
@@ -37,11 +30,12 @@ function supportsHyperlink(stream) {
 		TEAMCITY_VERSION,
 		TERM_PROGRAM,
 		TERM_PROGRAM_VERSION,
-		VTE_VERSION
+		VTE_VERSION,
+		TERM,
 	} = process.env;
 
 	if (FORCE_HYPERLINK) {
-		return !(FORCE_HYPERLINK.length > 0 && parseInt(FORCE_HYPERLINK, 10) === 0);
+		return !(FORCE_HYPERLINK.length > 0 && Number.parseInt(FORCE_HYPERLINK, 10) === 0);
 	}
 
 	if (hasFlag('no-hyperlink') || hasFlag('no-hyperlinks') || hasFlag('hyperlink=false') || hasFlag('hyperlink=never')) {
@@ -58,7 +52,7 @@ function supportsHyperlink(stream) {
 	}
 
 	// If they specify no colors, they probably don't want hyperlinks.
-	if (!supportsColor.supportsColor(stream)) {
+	if (!createSupportsColor(stream)) {
 		return false;
 	}
 
@@ -84,20 +78,29 @@ function supportsHyperlink(stream) {
 	}
 
 	if (TERM_PROGRAM) {
-		const version = parseVersion(TERM_PROGRAM_VERSION || '');
+		const version = parseVersion(TERM_PROGRAM_VERSION);
 
 		switch (TERM_PROGRAM) {
-			case 'iTerm.app':
+			case 'iTerm.app': {
 				if (version.major === 3) {
 					return version.minor >= 1;
 				}
 
 				return version.major > 3;
-			case 'WezTerm':
-				return version.major >= 20200620;
-			case 'vscode':
+			}
+
+			case 'WezTerm': {
+				return version.major >= 20_200_620;
+			}
+
+			case 'vscode': {
 				// eslint-disable-next-line no-mixed-operators
 				return version.major > 1 || version.major === 1 && version.minor >= 72;
+			}
+
+			case 'ghostty': {
+				return true;
+			}
 			// No default
 		}
 	}
@@ -112,11 +115,20 @@ function supportsHyperlink(stream) {
 		return version.major > 0 || version.minor >= 50;
 	}
 
+	switch (TERM) {
+		case 'alacritty': {
+			// Support added in v0.11 (2022-10-13)
+			return true;
+		}
+		// No default
+	}
+
 	return false;
 }
 
-module.exports = {
-	supportsHyperlink,
-	stdout: supportsHyperlink(process.stdout),
-	stderr: supportsHyperlink(process.stderr)
+const supportsHyperlinks = {
+	stdout: createSupportsHyperlinks(process.stdout),
+	stderr: createSupportsHyperlinks(process.stderr),
 };
+
+export default supportsHyperlinks;

package/license

@@ -1,5 +1,6 @@
 MIT License
 
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 Copyright (c) James Talmage <james@talmage.io> (https://github.com/jamestalmage)
 
 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/package.json

@@ -1,27 +1,21 @@
 {
 	"name": "supports-hyperlinks",
-	"version": "3.1.0",
-	"description": "Detect if your terminal emulator supports hyperlinks",
+	"version": "4.0.0",
+	"description": "Detect whether a terminal supports hyperlinks",
 	"license": "MIT",
-	"repository": "jamestalmage/supports-hyperlinks",
-	"funding": "https://github.com/sponsors/sindresorhus",
-	"author": {
-		"name": "James Talmage",
-		"email": "james@talmage.io",
-		"url": "github.com/jamestalmage"
-	},
+	"repository": "chalk/supports-hyperlinks",
+	"funding": "https://github.com/chalk/supports-hyperlinks?sponsor=1",
+	"type": "module",
 	"exports": {
 		"types": "./index.d.ts",
 		"default": "./index.js"
 	},
 	"sideEffects": false,
 	"engines": {
-		"node": ">=14.18"
+		"node": ">=20"
 	},
 	"scripts": {
-		"prepublishOnly": "npm run create-types",
-		"test": "xo && nyc ava && tsc",
-		"create-types": "tsc --project declaration.tsconfig.json"
+		"test": "xo && ava && tsc index.d.ts"
 	},
 	"files": [
 		"index.js",
@@ -33,25 +27,21 @@
 		"link",
 		"terminal",
 		"hyperlink",
-		"cli"
+		"cli",
+		"detect",
+		"check",
+		"ansi",
+		"escapes",
+		"console"
 	],
 	"dependencies": {
-		"has-flag": "^4.0.0",
-		"supports-color": "^7.0.0"
+		"has-flag": "^5.0.1",
+		"supports-color": "^10.0.0"
 	},
 	"devDependencies": {
-		"@tsconfig/node14": "^1.0.3",
-		"@types/supports-color": "^8.1.1",
-		"ava": "^2.2.0",
-		"codecov": "^3.5.0",
-		"nyc": "^14.1.1",
-		"typescript": "^4.9.5",
-		"xo": "^0.24.0"
-	},
-	"nyc": {
-		"reporter": [
-			"lcov",
-			"text"
-		]
+		"ava": "^6.2.0",
+		"codecov": "^3.8.3",
+		"typescript": "^5.8.2",
+		"xo": "^0.60.0"
 	}
 }

package/readme.md

@@ -1,12 +1,12 @@
-# supports-hyperlinks [![Build Status](https://travis-ci.org/jamestalmage/supports-hyperlinks.svg?branch=master)](https://travis-ci.org/jamestalmage/supports-hyperlinks) [![codecov](https://codecov.io/gh/jamestalmage/supports-hyperlinks/badge.svg?branch=master)](https://codecov.io/gh/jamestalmage/supports-hyperlinks?branch=master)
+# supports-hyperlinks
 
-> Detect whether a terminal emulator supports hyperlinks
+> Detect whether a terminal supports hyperlinks
 
 Terminal emulators are [starting to support hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda). While many terminals have long detected URL's and linkified them, allowing you to Command-Click or Control-Click them to open a browser, you were forced to print the long unsightly URL's on the screen. As of spring 2017 [a few terminals](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) began supporting HTML like links, where the link text and destination could be specified separately.
 
 This module allows you to detect if hyperlinks are supported in the current Terminal.
 
-As this is a new development, we anticipate the list of supported Terminals to grow rapidly. Please open an issue or submit a PR as new Terminals implement support.
+As this is a new development, we anticipate the list of supported terminals to grow rapidly. Please open an issue or submit a PR as new terminals implement support.
 
 ## Install
 
@@ -14,11 +14,10 @@ As this is a new development, we anticipate the list of supported Terminals to g
 npm install supports-hyperlinks
 ```
 
-
 ## Usage
 
 ```js
-const supportsHyperlinks = require('supports-hyperlinks');
+import supportsHyperlinks from 'supports-hyperlinks';
 
 if (supportsHyperlinks.stdout) {
 	console.log('Terminal stdout supports hyperlinks');
@@ -38,11 +37,3 @@ Returns an `Object` with a `stdout` and `stderr` property for testing either str
 Obeys the `--no-hyperlinks`, `--hyperlink=always`, and `--hyperlink=never` CLI flags.
 
 Can be overridden by the user with the flags `--hyperlinks=always` and `--no-hyperlinks`. For situations where using those flags are not possible, add the environment variable `FORCE_HYPERLINK=1` to forcefully enable hyperlinks or `FORCE_HYPERLINK=0` to forcefully disable. The use of `FORCE_HYPERLINK` overrides all other hyperlink support checks.
-
-## Related
-
-  * [`hyperlinker`](https://github.com/jamestalmage/hyperlinker): Write hyperlinks for the Terminal.
-
-## License
-
-MIT © [James Talmage](https://github.com/jamestalmage)