Skip to content

fix(@angular-devkit/build-angular): handle FORCE_COLOR when stdout is not instance of WriteStream #21737

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
merged 2 commits into from
Sep 14, 2021
Merged

fix(@angular-devkit/build-angular): handle FORCE_COLOR when stdout is not instance of WriteStream #21737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9cce47
fix(@angular-devkit/build-angular): handle `FORCE_COLOR` when stdout …
alan-agius4 Sep 9, 2021
76c95bf
fix(@angular/cli): handle `FORCE_COLOR` when stdout is not instance o…
alan-agius4 Sep 9, 2021
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
30 changes: 28 additions & 2 deletions packages/angular/cli/utilities/color.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,33 @@ import * as ansiColors from 'ansi-colors';
import { WriteStream } from 'tty';

type AnsiColors = typeof ansiColors;
const supportsColor = process.stdout instanceof WriteStream && process.stdout.getColorDepth() > 1;

function supportColor(): boolean {
if (process.env.FORCE_COLOR !== undefined) {
// 2 colors: FORCE_COLOR = 0 (Disables colors), depth 1
// 16 colors: FORCE_COLOR = 1, depth 4
// 256 colors: FORCE_COLOR = 2, depth 8
// 16,777,216 colors: FORCE_COLOR = 3, depth 16
// See: https://nodejs.org/dist/latest-v12.x/docs/api/tty.html#tty_writestream_getcolordepth_env
// and https://github.com/nodejs/node/blob/b9f36062d7b5c5039498e98d2f2c180dca2a7065/lib/internal/tty.js#L106;
switch (process.env.FORCE_COLOR) {
case '':
case 'true':
case '1':
case '2':
case '3':
return true;
default:
return false;
}
}

if (process.stdout instanceof WriteStream) {
return process.stdout.getColorDepth() > 1;
}

return false;
}

export function removeColor(text: string): string {
// This has been created because when colors.enabled is false unstyle doesn't work
Expand All @@ -21,6 +47,6 @@ export function removeColor(text: string): string {
// Create a separate instance to prevent unintended global changes to the color configuration
// Create function is not defined in the typings. See: https://github.com/doowb/ansi-colors/pull/44
const colors = (ansiColors as AnsiColors & { create: () => AnsiColors }).create();
colors.enabled = supportsColor;
colors.enabled = supportColor();

export { colors };
30 changes: 28 additions & 2 deletions packages/angular_devkit/build_angular/src/utils/color.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,33 @@ import * as ansiColors from 'ansi-colors';
import { WriteStream } from 'tty';

type AnsiColors = typeof ansiColors;
const supportsColor = process.stdout instanceof WriteStream && process.stdout.getColorDepth() > 1;

function supportColor(): boolean {
if (process.env.FORCE_COLOR !== undefined) {
// 2 colors: FORCE_COLOR = 0 (Disables colors), depth 1
// 16 colors: FORCE_COLOR = 1, depth 4
// 256 colors: FORCE_COLOR = 2, depth 8
// 16,777,216 colors: FORCE_COLOR = 3, depth 16
// See: https://nodejs.org/dist/latest-v12.x/docs/api/tty.html#tty_writestream_getcolordepth_env
// and https://github.com/nodejs/node/blob/b9f36062d7b5c5039498e98d2f2c180dca2a7065/lib/internal/tty.js#L106;
switch (process.env.FORCE_COLOR) {
case '':
case 'true':
case '1':
case '2':
case '3':
return true;
default:
return false;
}
}

if (process.stdout instanceof WriteStream) {
return process.stdout.getColorDepth() > 1;
}

return false;
}

export function removeColor(text: string): string {
// This has been created because when colors.enabled is false unstyle doesn't work
Expand All @@ -21,6 +47,6 @@ export function removeColor(text: string): string {
// Create a separate instance to prevent unintended global changes to the color configuration
// Create function is not defined in the typings. See: https://github.com/doowb/ansi-colors/pull/44
const colors = (ansiColors as AnsiColors & { create: () => AnsiColors }).create();
colors.enabled = supportsColor;
colors.enabled = supportColor();

export { colors };