Skip to content

lib: respect terminal capabilities on styleText #54389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 8 commits into from
Aug 28, 2024
Merged

lib: respect terminal capabilities on styleText #54389

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9e3ada1
lib: respect terminal capabilities on styleText
RafaelGSS Aug 14, 2024
66cd3f3
fixup! lib: respect terminal capabilities on styleText
RafaelGSS Aug 14, 2024
cc08b60
fixup! fixup! lib: respect terminal capabilities on styleText
RafaelGSS Aug 16, 2024
0d3a65d
fixup! fixup! fixup! lib: respect terminal capabilities on styleText
RafaelGSS Aug 20, 2024
dd807c0
fixup! fixup! lib: respect terminal capabilities on styleText
RafaelGSS Aug 20, 2024
de39601
fixup! fixup! lib: respect terminal capabilities on styleText
RafaelGSS Aug 20, 2024
317c284
fixup! lib: respect terminal capabilities on styleText
RafaelGSS Aug 21, 2024
5efe9b8
fixup! doc: added missing options
ovflowd Aug 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup! fixup! lib: respect terminal capabilities on styleText
  • Loading branch information
@RafaelGSS
RafaelGSS committed Aug 16, 2024
commit cc08b60053766f5224d2aa95fdc27135e1933412
28 changes: 24 additions & 4 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1831,14 +1831,34 @@ and act according to the configuration set via `NO_COLORS`,

```mjs
import { styleText } from 'node:util';
const errorMessage = styleText('red', 'Error! Error!');
console.log(errorMessage);
import { stderr } from 'node:process';

const successMessage = styleText('green', 'Success!');
console.log(successMessage);

const errorMessage = styleText(
'red',
'Error! Error!',
// Validate if process.stderr has TTY
{ stream: stderr },
);
console.error(successMessage);
```

```cjs
const { styleText } = require('node:util');
const errorMessage = styleText('red', 'Error! Error!');
console.log(errorMessage);
const { stderr } = require('node:process');

const successMessage = styleText('green', 'Success!');
console.log(successMessage);

const errorMessage = styleText(
'red',
'Error! Error!',
// Validate if process.stderr has TTY
{ stream: stderr },
);
console.error(successMessage);
```

`util.inspect.colors` also provides text formats such as `italic`, and
Expand Down
15 changes: 15 additions & 0 deletions lib/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,17 @@ const {
} = require('internal/util/inspect');
const { debuglog } = require('internal/util/debuglog');
const {
validateBoolean,
validateFunction,
validateNumber,
validateString,
validateOneOf,
} = require('internal/validators');
const {
isReadableStream,
isWritableStream,
isNodeStream,
} = require('internal/streams/utils');
const types = require('internal/util/types');

let utilColors;
Expand Down Expand Up @@ -106,8 +112,17 @@ function escapeStyleCode(code) {
*/
function styleText(format, text, { validateStream = true, stream = process.stdout } = {}) {
validateString(text, 'text');
Comment thread
RafaelGSS marked this conversation as resolved.
validateBoolean(validateStream, 'options.validateStream');

if (validateStream) {
if (
!isReadableStream(stream) &&
!isWritableStream(stream) &&
!isNodeStream(stream)
) {
throw new ERR_INVALID_ARG_TYPE('stream', ['ReadableStream', 'WritableStream', 'Stream'], stream);
}

if (
!stream ||
Comment thread
RafaelGSS marked this conversation as resolved.
Outdated
!lazyUtilColors().shouldColorize(stream)
Expand Down
9 changes: 9 additions & 0 deletions test/parallel/test-util-styletext.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ assert.throws(() => {
code: 'ERR_INVALID_ARG_VALUE',
});

assert.throws(() => {
util.styleText('red', 'text', { stream: {} });
}, {
code: 'ERR_INVALID_ARG_TYPE',
});

// does not throw
Comment thread
RafaelGSS marked this conversation as resolved.
util.styleText('red', 'text', { stream: {}, validateStream: false });

assert.strictEqual(util.styleText('red', 'test'), styled);

const originalEnv = process.env;
Expand Down