supports-hyperlinks 3.2.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/browser.js +9 -7
  2. package/index.d.ts +24 -5
  3. package/index.js +33 -32
  4. package/package.json +10 -12
package/browser.js CHANGED
@@ -1,8 +1,10 @@
1
- 'use strict';
2
- module.exports = {
3
- stdin: false,
4
- stderr: false,
5
- supportsHyperlink: function () { // eslint-disable-line object-shorthand
6
- return false;
7
- }
1
+ export function createSupportsHyperlinks() {
2
+ return false;
3
+ }
4
+
5
+ const supportsHyperlinks = {
6
+ stdout: createSupportsHyperlinks(),
7
+ stderr: createSupportsHyperlinks(),
8
8
  };
9
+
10
+ export default supportsHyperlinks;
package/index.d.ts CHANGED
@@ -1,6 +1,25 @@
1
- export function supportsHyperlink(stream: {
2
- isTTY?: boolean | undefined;
3
- }): boolean;
1
+ /**
2
+ Creates a supports hyperlinks check for a given stream.
4
3
 
5
- export declare const stdout: boolean;
6
- export declare const stderr: boolean;
4
+ @param stream - Optional stream to check for hyperlink support.
5
+ @returns boolean indicating whether hyperlinks are supported.
6
+ */
7
+ export function createSupportsHyperlinks(stream?: {isTTY?: boolean}): boolean;
8
+
9
+ /**
10
+ Object containing hyperlink support status for stdout and stderr.
11
+ */
12
+ type SupportsHyperlinks = {
13
+ /**
14
+ Whether stdout supports hyperlinks.
15
+ */
16
+ stdout: boolean;
17
+ /**
18
+ Whether stderr supports hyperlinks.
19
+ */
20
+ stderr: boolean;
21
+ };
22
+
23
+ declare const supportsHyperlinks: SupportsHyperlinks;
24
+
25
+ export default supportsHyperlinks;
package/index.js CHANGED
@@ -1,36 +1,28 @@
1
- 'use strict';
2
- const supportsColor = require('supports-color');
3
- const hasFlag = require('has-flag');
4
-
5
- /**
6
- @param {string} versionString
7
- @returns {{ major: number, minor: number, patch: number }}
8
- */
9
- function parseVersion(versionString) {
1
+ import process from 'node:process';
2
+ import {createSupportsColor} from 'supports-color';
3
+ import hasFlag from 'has-flag';
4
+
5
+ function parseVersion(versionString = '') {
10
6
  if (/^\d{3,4}$/.test(versionString)) {
11
7
  // Env var doesn't always use dots. example: 4601 => 46.1.0
12
- const m = /(\d{1,2})(\d{2})/.exec(versionString) || [];
8
+ const match = /(\d{1,2})(\d{2})/.exec(versionString) ?? [];
13
9
  return {
14
10
  major: 0,
15
- minor: parseInt(m[1], 10),
16
- patch: parseInt(m[2], 10)
11
+ minor: Number.parseInt(match[1], 10),
12
+ patch: Number.parseInt(match[2], 10),
17
13
  };
18
14
  }
19
15
 
20
- const versions = (versionString || '').split('.').map(n => parseInt(n, 10));
16
+ const versions = (versionString ?? '').split('.').map(n => Number.parseInt(n, 10));
21
17
  return {
22
18
  major: versions[0],
23
19
  minor: versions[1],
24
- patch: versions[2]
20
+ patch: versions[2],
25
21
  };
26
22
  }
27
23
 
28
- /**
29
- @param {{ isTTY?: boolean | undefined }} stream
30
- @returns {boolean}
31
- */
32
24
  // eslint-disable-next-line complexity
33
- function supportsHyperlink(stream) {
25
+ export function createSupportsHyperlinks(stream) {
34
26
  const {
35
27
  CI,
36
28
  FORCE_HYPERLINK,
@@ -43,7 +35,7 @@ function supportsHyperlink(stream) {
43
35
  } = process.env;
44
36
 
45
37
  if (FORCE_HYPERLINK) {
46
- return !(FORCE_HYPERLINK.length > 0 && parseInt(FORCE_HYPERLINK, 10) === 0);
38
+ return !(FORCE_HYPERLINK.length > 0 && Number.parseInt(FORCE_HYPERLINK, 10) === 0);
47
39
  }
48
40
 
49
41
  if (hasFlag('no-hyperlink') || hasFlag('no-hyperlinks') || hasFlag('hyperlink=false') || hasFlag('hyperlink=never')) {
@@ -60,7 +52,7 @@ function supportsHyperlink(stream) {
60
52
  }
61
53
 
62
54
  // If they specify no colors, they probably don't want hyperlinks.
63
- if (!supportsColor.supportsColor(stream)) {
55
+ if (!createSupportsColor(stream)) {
64
56
  return false;
65
57
  }
66
58
 
@@ -86,22 +78,29 @@ function supportsHyperlink(stream) {
86
78
  }
87
79
 
88
80
  if (TERM_PROGRAM) {
89
- const version = parseVersion(TERM_PROGRAM_VERSION || '');
81
+ const version = parseVersion(TERM_PROGRAM_VERSION);
90
82
 
91
83
  switch (TERM_PROGRAM) {
92
- case 'iTerm.app':
84
+ case 'iTerm.app': {
93
85
  if (version.major === 3) {
94
86
  return version.minor >= 1;
95
87
  }
96
88
 
97
89
  return version.major > 3;
98
- case 'WezTerm':
99
- return version.major >= 20200620;
100
- case 'vscode':
90
+ }
91
+
92
+ case 'WezTerm': {
93
+ return version.major >= 20_200_620;
94
+ }
95
+
96
+ case 'vscode': {
101
97
  // eslint-disable-next-line no-mixed-operators
102
98
  return version.major > 1 || version.major === 1 && version.minor >= 72;
103
- case 'ghostty':
99
+ }
100
+
101
+ case 'ghostty': {
104
102
  return true;
103
+ }
105
104
  // No default
106
105
  }
107
106
  }
@@ -117,17 +116,19 @@ function supportsHyperlink(stream) {
117
116
  }
118
117
 
119
118
  switch (TERM) {
120
- case 'alacritty':
119
+ case 'alacritty': {
121
120
  // Support added in v0.11 (2022-10-13)
122
121
  return true;
122
+ }
123
123
  // No default
124
124
  }
125
125
 
126
126
  return false;
127
127
  }
128
128
 
129
- module.exports = {
130
- supportsHyperlink,
131
- stdout: supportsHyperlink(process.stdout),
132
- stderr: supportsHyperlink(process.stderr)
129
+ const supportsHyperlinks = {
130
+ stdout: createSupportsHyperlinks(process.stdout),
131
+ stderr: createSupportsHyperlinks(process.stderr),
133
132
  };
133
+
134
+ export default supportsHyperlinks;
package/package.json CHANGED
@@ -1,21 +1,21 @@
1
1
  {
2
2
  "name": "supports-hyperlinks",
3
- "version": "3.2.0",
3
+ "version": "4.0.0",
4
4
  "description": "Detect whether a terminal supports hyperlinks",
5
5
  "license": "MIT",
6
6
  "repository": "chalk/supports-hyperlinks",
7
7
  "funding": "https://github.com/chalk/supports-hyperlinks?sponsor=1",
8
+ "type": "module",
8
9
  "exports": {
9
10
  "types": "./index.d.ts",
10
11
  "default": "./index.js"
11
12
  },
12
13
  "sideEffects": false,
13
14
  "engines": {
14
- "node": ">=14.18"
15
+ "node": ">=20"
15
16
  },
16
17
  "scripts": {
17
- "//test": "xo && ava && tsc",
18
- "test": "ava"
18
+ "test": "xo && ava && tsc index.d.ts"
19
19
  },
20
20
  "files": [
21
21
  "index.js",
@@ -35,15 +35,13 @@
35
35
  "console"
36
36
  ],
37
37
  "dependencies": {
38
- "has-flag": "^4.0.0",
39
- "supports-color": "^7.0.0"
38
+ "has-flag": "^5.0.1",
39
+ "supports-color": "^10.0.0"
40
40
  },
41
41
  "devDependencies": {
42
- "@tsconfig/node14": "^1.0.3",
43
- "@types/supports-color": "^8.1.1",
44
- "ava": "^3.2.0",
45
- "codecov": "^3.5.0",
46
- "typescript": "^4.9.5",
47
- "xo": "^0.53.0"
42
+ "ava": "^6.2.0",
43
+ "codecov": "^3.8.3",
44
+ "typescript": "^5.8.2",
45
+ "xo": "^0.60.0"
48
46
  }
49
47
  }