Support FORCE_COLOR (#63055)

This commit is contained in:
Jake Bailey 2026-01-28 10:59:07 -08:00 committed by GitHub
parent 66edca11c9
commit 46ec6af171
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 361 additions and 1 deletions

View File

@ -157,7 +157,13 @@ function updateReportDiagnostic(
}
function defaultIsPretty(sys: System) {
return !!sys.writeOutputIsTTY && sys.writeOutputIsTTY() && !sys.getEnvironmentVariable("NO_COLOR");
if (sys.getEnvironmentVariable("NO_COLOR")) {
return false;
}
if (sys.getEnvironmentVariable("FORCE_COLOR")) {
return true;
}
return !!sys.writeOutputIsTTY && sys.writeOutputIsTTY();
}
function shouldBePretty(sys: System, options: CompilerOptions | BuildOptions) {

View File

@ -30,6 +30,26 @@ describe("unittests:: tsc:: commandLine::", () => {
commandLineArgs: emptyArray,
});
verifyTsc({
scenario: "commandLine",
subScenario: "adds color when FORCE_COLOR is set",
sys: () =>
TestServerHost.createWatchedSystem(emptyArray, {
environmentVariables: new Map([["FORCE_COLOR", "true"]]),
}),
commandLineArgs: emptyArray,
});
verifyTsc({
scenario: "commandLine",
subScenario: "does not add color when NO_COLOR is set even if FORCE_COLOR is set",
sys: () =>
TestServerHost.createWatchedSystem(emptyArray, {
environmentVariables: new Map([["NO_COLOR", "true"], ["FORCE_COLOR", "true"]]),
}),
commandLineArgs: emptyArray,
});
verifyTsc({
scenario: "commandLine",
subScenario: "when build not first argument",

View File

@ -0,0 +1,167 @@
currentDirectory:: /home/src/workspaces/project useCaseSensitiveFileNames:: false
Input::
//// [/home/src/tslibs/TS/Lib/lib.d.ts]
interface Boolean {}
interface Function {}
interface CallableFunction {}
interface NewableFunction {}
interface IArguments {}
interface Number { toExponential: any; }
interface Object {}
interface RegExp {}
interface String { charAt: any; }
interface Array<T> { length: number; [n: number]: T; }
interface ReadonlyArray<T> {}
declare const console: { log(msg: any): void; };
/home/src/tslibs/TS/Lib/tsc.js
Output::
Version FakeTSVersion
tsc: The TypeScript Compiler - Version FakeTSVersion
COMMON COMMANDS
tsc
Compiles the current project (tsconfig.json in the working directory.)
tsc app.ts util.ts
Ignoring tsconfig.json, compiles the specified files with default compiler options.
tsc -b
Build a composite project in the working directory.
tsc --init
Creates a tsconfig.json with the recommended settings in the working directory.
tsc -p ./path/to/tsconfig.json
Compiles the TypeScript project located at the specified path.
tsc --help --all
An expanded version of this information, showing all possible compiler options
tsc --noEmit
tsc --target esnext
Compiles the current project, with additional settings.
COMMAND LINE FLAGS
--help, -h
Print this message.
--watch, -w
Watch input files.
--all
Show all compiler options.
--version, -v
Print the compiler's version.
--init
Initializes a TypeScript project and creates a tsconfig.json file.
--project, -p
Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.
--showConfig
Print the final configuration instead of building.
--ignoreConfig
Ignore the tsconfig found and build with commandline options and files.
--build, -b
Build one or more projects and their dependencies, if out of date
COMMON COMPILER OPTIONS
--pretty
Enable color and formatting in TypeScript's output to make compiler errors easier to read.
type: boolean
default: true
--declaration, -d
Generate .d.ts files from TypeScript and JavaScript files in your project.
type: boolean
default: `false`, unless `composite` is set
--declarationMap
Create sourcemaps for d.ts files.
type: boolean
default: false
--emitDeclarationOnly
Only output d.ts files and not JavaScript files.
type: boolean
default: false
--sourceMap
Create source map files for emitted JavaScript files.
type: boolean
default: false
--noEmit
Disable emitting files from a compilation.
type: boolean
default: false
--target, -t
Set the JavaScript language version for emitted JavaScript and include compatible library declarations.
one of: es5, es6/es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, es2024, esnext
default: es5
--module, -m
Specify what module code is generated.
one of: commonjs, es6/es2015, es2020, es2022, esnext, node16, node18, node20, nodenext, preserve
default: undefined
--lib
Specify a set of bundled library declaration files that describe the target runtime environment.
one or more: es5, es6/es2015, es7/es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, es2024, esnext, dom, dom.iterable, dom.asynciterable, webworker, webworker.importscripts, webworker.iterable, webworker.asynciterable, scripthost, es2015.core, es2015.collection, es2015.generator, es2015.iterable, es2015.promise, es2015.proxy, es2015.reflect, es2015.symbol, es2015.symbol.wellknown, es2016.array.include, es2016.intl, es2017.arraybuffer, es2017.date, es2017.object, es2017.sharedmemory, es2017.string, es2017.intl, es2017.typedarrays, es2018.asyncgenerator, es2018.asynciterable/esnext.asynciterable, es2018.intl, es2018.promise, es2018.regexp, es2019.array, es2019.object, es2019.string, es2019.symbol/esnext.symbol, es2019.intl, es2020.bigint/esnext.bigint, es2020.date, es2020.promise, es2020.sharedmemory, es2020.string, es2020.symbol.wellknown, es2020.intl, es2020.number, es2021.promise, es2021.string, es2021.weakref/esnext.weakref, es2021.intl, es2022.array, es2022.error, es2022.intl, es2022.object, es2022.string, es2022.regexp, es2023.array, es2023.collection, es2023.intl, es2024.arraybuffer, es2024.collection, es2024.object/esnext.object, es2024.promise, es2024.regexp/esnext.regexp, es2024.sharedmemory, es2024.string/esnext.string, esnext.array, esnext.collection, esnext.intl, esnext.disposable, esnext.promise, esnext.decorators, esnext.iterator, esnext.float16, esnext.typedarrays, esnext.error, esnext.sharedmemory, decorators, decorators.legacy
default: undefined
--allowJs
Allow JavaScript files to be a part of your program. Use the 'checkJs' option to get errors from these files.
type: boolean
default: `false`, unless `checkJs` is set
--checkJs
Enable error reporting in type-checked JavaScript files.
type: boolean
default: false
--jsx
Specify what JSX code is generated.
one of: preserve, react, react-native, react-jsx, react-jsxdev
default: undefined
--outFile
Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output.
--outDir
Specify an output folder for all emitted files.
--removeComments
Disable emitting comments.
type: boolean
default: false
--strict
Enable all strict type-checking options.
type: boolean
default: false
--types
Specify type package names to be included without being referenced in a source file.
--esModuleInterop
Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility.
type: boolean
default: true
You can learn about all of the compiler options at https://aka.ms/tsc
exitCode:: ExitStatus.DiagnosticsPresent_OutputsSkipped

View File

@ -0,0 +1,167 @@
currentDirectory:: /home/src/workspaces/project useCaseSensitiveFileNames:: false
Input::
//// [/home/src/tslibs/TS/Lib/lib.d.ts]
interface Boolean {}
interface Function {}
interface CallableFunction {}
interface NewableFunction {}
interface IArguments {}
interface Number { toExponential: any; }
interface Object {}
interface RegExp {}
interface String { charAt: any; }
interface Array<T> { length: number; [n: number]: T; }
interface ReadonlyArray<T> {}
declare const console: { log(msg: any): void; };
/home/src/tslibs/TS/Lib/tsc.js
Output::
Version FakeTSVersion
tsc: The TypeScript Compiler - Version FakeTSVersion
COMMON COMMANDS
tsc
Compiles the current project (tsconfig.json in the working directory.)
tsc app.ts util.ts
Ignoring tsconfig.json, compiles the specified files with default compiler options.
tsc -b
Build a composite project in the working directory.
tsc --init
Creates a tsconfig.json with the recommended settings in the working directory.
tsc -p ./path/to/tsconfig.json
Compiles the TypeScript project located at the specified path.
tsc --help --all
An expanded version of this information, showing all possible compiler options
tsc --noEmit
tsc --target esnext
Compiles the current project, with additional settings.
COMMAND LINE FLAGS
--help, -h
Print this message.
--watch, -w
Watch input files.
--all
Show all compiler options.
--version, -v
Print the compiler's version.
--init
Initializes a TypeScript project and creates a tsconfig.json file.
--project, -p
Compile the project given the path to its configuration file, or to a folder with a 'tsconfig.json'.
--showConfig
Print the final configuration instead of building.
--ignoreConfig
Ignore the tsconfig found and build with commandline options and files.
--build, -b
Build one or more projects and their dependencies, if out of date
COMMON COMPILER OPTIONS
--pretty
Enable color and formatting in TypeScript's output to make compiler errors easier to read.
type: boolean
default: true
--declaration, -d
Generate .d.ts files from TypeScript and JavaScript files in your project.
type: boolean
default: `false`, unless `composite` is set
--declarationMap
Create sourcemaps for d.ts files.
type: boolean
default: false
--emitDeclarationOnly
Only output d.ts files and not JavaScript files.
type: boolean
default: false
--sourceMap
Create source map files for emitted JavaScript files.
type: boolean
default: false
--noEmit
Disable emitting files from a compilation.
type: boolean
default: false
--target, -t
Set the JavaScript language version for emitted JavaScript and include compatible library declarations.
one of: es5, es6/es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, es2024, esnext
default: es5
--module, -m
Specify what module code is generated.
one of: commonjs, es6/es2015, es2020, es2022, esnext, node16, node18, node20, nodenext, preserve
default: undefined
--lib
Specify a set of bundled library declaration files that describe the target runtime environment.
one or more: es5, es6/es2015, es7/es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, es2024, esnext, dom, dom.iterable, dom.asynciterable, webworker, webworker.importscripts, webworker.iterable, webworker.asynciterable, scripthost, es2015.core, es2015.collection, es2015.generator, es2015.iterable, es2015.promise, es2015.proxy, es2015.reflect, es2015.symbol, es2015.symbol.wellknown, es2016.array.include, es2016.intl, es2017.arraybuffer, es2017.date, es2017.object, es2017.sharedmemory, es2017.string, es2017.intl, es2017.typedarrays, es2018.asyncgenerator, es2018.asynciterable/esnext.asynciterable, es2018.intl, es2018.promise, es2018.regexp, es2019.array, es2019.object, es2019.string, es2019.symbol/esnext.symbol, es2019.intl, es2020.bigint/esnext.bigint, es2020.date, es2020.promise, es2020.sharedmemory, es2020.string, es2020.symbol.wellknown, es2020.intl, es2020.number, es2021.promise, es2021.string, es2021.weakref/esnext.weakref, es2021.intl, es2022.array, es2022.error, es2022.intl, es2022.object, es2022.string, es2022.regexp, es2023.array, es2023.collection, es2023.intl, es2024.arraybuffer, es2024.collection, es2024.object/esnext.object, es2024.promise, es2024.regexp/esnext.regexp, es2024.sharedmemory, es2024.string/esnext.string, esnext.array, esnext.collection, esnext.intl, esnext.disposable, esnext.promise, esnext.decorators, esnext.iterator, esnext.float16, esnext.typedarrays, esnext.error, esnext.sharedmemory, decorators, decorators.legacy
default: undefined
--allowJs
Allow JavaScript files to be a part of your program. Use the 'checkJs' option to get errors from these files.
type: boolean
default: `false`, unless `checkJs` is set
--checkJs
Enable error reporting in type-checked JavaScript files.
type: boolean
default: false
--jsx
Specify what JSX code is generated.
one of: preserve, react, react-native, react-jsx, react-jsxdev
default: undefined
--outFile
Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output.
--outDir
Specify an output folder for all emitted files.
--removeComments
Disable emitting comments.
type: boolean
default: false
--strict
Enable all strict type-checking options.
type: boolean
default: false
--types
Specify type package names to be included without being referenced in a source file.
--esModuleInterop
Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility.
type: boolean
default: true
You can learn about all of the compiler options at https://aka.ms/tsc
exitCode:: ExitStatus.DiagnosticsPresent_OutputsSkipped