Skip to content

Commit 95ef2a5

Browse files
AlexMunozAlexMunoz
authored
feat: display the tsconfig generated when running tsc --init (#45930)
* feat: display the tsconfig generated when running tsc --init * fix: fix lint issues * refactor: minor changes
1 parent 46a12fd commit 95ef2a5

File tree

2 files changed

+75
-30
lines changed

2 files changed

+75
-30
lines changed

‎src/compiler/commandLineParser.ts‎

Lines changed: 62 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2351,36 +2351,57 @@ namespace ts {
23512351
return result;
23522352
}
23532353

2354+
/**
2355+
* Generate a list of the compiler options whose value is not the default.
2356+
* @param options compilerOptions to be evaluated.
2357+
/** @internal */
2358+
export function getCompilerOptionsDiffValue(options: CompilerOptions, newLine: string): string {
2359+
const compilerOptionsMap = getSerializedCompilerOption(options);
2360+
return getOverwrittenDefaultOptions();
2361+
2362+
function makePadding(paddingLength: number): string {
2363+
return Array(paddingLength + 1).join(" ");
2364+
}
2365+
2366+
function getOverwrittenDefaultOptions() {
2367+
const result: string[] = [];
2368+
const tab = makePadding(2);
2369+
commandOptionsWithoutBuild.forEach(cmd => {
2370+
if (!compilerOptionsMap.has(cmd.name)) {
2371+
return;
2372+
}
2373+
2374+
const newValue = compilerOptionsMap.get(cmd.name);
2375+
const defaultValue = getDefaultValueForOption(cmd);
2376+
if (newValue !== defaultValue) {
2377+
result.push(`${tab}${cmd.name}: ${newValue}`);
2378+
}
2379+
else if (hasProperty(defaultInitCompilerOptions, cmd.name)) {
2380+
result.push(`${tab}${cmd.name}: ${defaultValue}`);
2381+
}
2382+
});
2383+
return result.join(newLine) + newLine;
2384+
}
2385+
}
2386+
2387+
/**
2388+
* Get the compiler options to be written into the tsconfig.json.
2389+
* @param options commandlineOptions to be included in the compileOptions.
2390+
*/
2391+
function getSerializedCompilerOption(options: CompilerOptions): ESMap<string, CompilerOptionsValue> {
2392+
const compilerOptions = extend(options, defaultInitCompilerOptions);
2393+
return serializeCompilerOptions(compilerOptions);
2394+
}
23542395
/**
23552396
* Generate tsconfig configuration when running command line "--init"
23562397
* @param options commandlineOptions to be generated into tsconfig.json
23572398
* @param fileNames array of filenames to be generated into tsconfig.json
23582399
*/
23592400
/* @internal */
23602401
export function generateTSConfig(options: CompilerOptions, fileNames: readonly string[], newLine: string): string {
2361-
const compilerOptions = extend(options, defaultInitCompilerOptions);
2362-
const compilerOptionsMap = serializeCompilerOptions(compilerOptions);
2402+
const compilerOptionsMap = getSerializedCompilerOption(options);
23632403
return writeConfigurations();
23642404

2365-
function getDefaultValueForOption(option: CommandLineOption) {
2366-
switch (option.type) {
2367-
case "number":
2368-
return 1;
2369-
case "boolean":
2370-
return true;
2371-
case "string":
2372-
return option.isFilePath ? "./" : "";
2373-
case "list":
2374-
return [];
2375-
case "object":
2376-
return {};
2377-
default:
2378-
const iterResult = option.type.keys().next();
2379-
if (!iterResult.done) return iterResult.value;
2380-
return Debug.fail("Expected 'option.type' to have entries.");
2381-
}
2382-
}
2383-
23842405
function makePadding(paddingLength: number): string {
23852406
return Array(paddingLength + 1).join(" ");
23862407
}
@@ -3542,4 +3563,24 @@ namespace ts {
35423563
})!; // TODO: GH#18217
35433564
}
35443565
}
3566+
3567+
3568+
function getDefaultValueForOption(option: CommandLineOption) {
3569+
switch (option.type) {
3570+
case "number":
3571+
return 1;
3572+
case "boolean":
3573+
return true;
3574+
case "string":
3575+
return option.isFilePath ? "./" : "";
3576+
case "list":
3577+
return [];
3578+
case "object":
3579+
return {};
3580+
default:
3581+
const iterResult = option.type.keys().next();
3582+
if (!iterResult.done) return iterResult.value;
3583+
return Debug.fail("Expected 'option.type' to have entries.");
3584+
}
3585+
}
35453586
}

‎src/executeCommandLine/executeCommandLine.ts‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ namespace ts {
354354

355355
function printEasyHelp(sys: System, simpleOptions: readonly CommandLineOption[]) {
356356
const colors = createColors(sys);
357-
let output: string[] = [...getHelpHeader(sys)];
357+
let output: string[] = [...getHeader(sys,`${getDiagnosticText(Diagnostics.tsc_Colon_The_TypeScript_Compiler)} - ${getDiagnosticText(Diagnostics.Version_0, version)}`)];
358358
output.push(colors.bold(getDiagnosticText(Diagnostics.COMMON_COMMANDS)) + sys.newLine + sys.newLine);
359359

360360
example("tsc", Diagnostics.Compiles_the_current_project_tsconfig_json_in_the_working_directory);
@@ -388,7 +388,7 @@ namespace ts {
388388
}
389389

390390
function printAllHelp(sys: System, compilerOptions: readonly CommandLineOption[], buildOptions: readonly CommandLineOption[], watchOptions: readonly CommandLineOption[]) {
391-
let output: string[] = [...getHelpHeader(sys)];
391+
let output: string[] = [...getHeader(sys,`${getDiagnosticText(Diagnostics.tsc_Colon_The_TypeScript_Compiler)} - ${getDiagnosticText(Diagnostics.Version_0, version)}`)];
392392
output = [...output, ...generateSectionOptionsOutput(sys, getDiagnosticText(Diagnostics.ALL_COMPILER_OPTIONS), compilerOptions, /*subCategory*/ true, /* beforeOptionsDescription */ undefined, formatMessage(/*_dummy*/ undefined, Diagnostics.You_can_learn_about_all_of_the_compiler_options_at_0, "https://aka.ms/tsconfig-reference"))];
393393
output = [...output, ...generateSectionOptionsOutput(sys, getDiagnosticText(Diagnostics.WATCH_OPTIONS), watchOptions, /*subCategory*/ false, getDiagnosticText(Diagnostics.Including_watch_w_will_start_watching_the_current_project_for_the_file_changes_Once_set_you_can_config_watch_mode_with_Colon))];
394394
output = [...output, ...generateSectionOptionsOutput(sys, getDiagnosticText(Diagnostics.BUILD_OPTIONS), buildOptions, /*subCategory*/ false, formatMessage(/*_dummy*/ undefined, Diagnostics.Using_build_b_will_make_tsc_behave_more_like_a_build_orchestrator_than_a_compiler_This_is_used_to_trigger_building_composite_projects_which_you_can_learn_more_about_at_0, "https://aka.ms/tsc-composite-builds"))];
@@ -398,32 +398,31 @@ namespace ts {
398398
}
399399

400400
function printBuildHelp(sys: System, buildOptions: readonly CommandLineOption[]) {
401-
let output: string[] = [...getHelpHeader(sys)];
401+
let output: string[] = [...getHeader(sys,`${getDiagnosticText(Diagnostics.tsc_Colon_The_TypeScript_Compiler)} - ${getDiagnosticText(Diagnostics.Version_0, version)}`)];
402402
output = [...output, ...generateSectionOptionsOutput(sys, getDiagnosticText(Diagnostics.BUILD_OPTIONS), buildOptions, /*subCategory*/ false, formatMessage(/*_dummy*/ undefined, Diagnostics.Using_build_b_will_make_tsc_behave_more_like_a_build_orchestrator_than_a_compiler_This_is_used_to_trigger_building_composite_projects_which_you_can_learn_more_about_at_0, "https://aka.ms/tsc-composite-builds"))];
403403
for (const line of output) {
404404
sys.write(line);
405405
}
406406
}
407407

408-
function getHelpHeader(sys: System) {
408+
function getHeader(sys: System, message: string) {
409409
const colors = createColors(sys);
410410
const header: string[] = [];
411-
const tscExplanation = `${getDiagnosticText(Diagnostics.tsc_Colon_The_TypeScript_Compiler)} - ${getDiagnosticText(Diagnostics.Version_0, version)}`;
412411
const terminalWidth = sys.getWidthOfTerminal?.() ?? 0;;
413412
const tsIconLength = 5;
414413

415414
const tsIconFirstLine = colors.blueBackground(padLeft("", tsIconLength));
416415
const tsIconSecondLine = colors.blueBackground(colors.brightWhite(padLeft("TS ", tsIconLength)));
417416
// If we have enough space, print TS icon.
418-
if (terminalWidth >= tscExplanation.length + tsIconLength) {
417+
if (terminalWidth >= message.length + tsIconLength) {
419418
// right align of the icon is 120 at most.
420419
const rightAlign = terminalWidth > 120 ? 120 : terminalWidth;
421420
const leftAlign = rightAlign - tsIconLength;
422-
header.push(padRight(tscExplanation, leftAlign) + tsIconFirstLine + sys.newLine);
421+
header.push(padRight(message, leftAlign) + tsIconFirstLine + sys.newLine);
423422
header.push(padLeft("", leftAlign) + tsIconSecondLine + sys.newLine);
424423
}
425424
else {
426-
header.push(tscExplanation + sys.newLine);
425+
header.push(message + sys.newLine);
427426
header.push(sys.newLine);
428427
}
429428
return header;
@@ -1035,7 +1034,12 @@ namespace ts {
10351034
}
10361035
else {
10371036
sys.writeFile(file, generateTSConfig(options, fileNames, sys.newLine));
1038-
reportDiagnostic(createCompilerDiagnostic(Diagnostics.Successfully_created_a_tsconfig_json_file));
1037+
const output: string[] = [sys.newLine, ...getHeader(sys,"Created a new tsconfig.json with:")];
1038+
output.push(getCompilerOptionsDiffValue(options, sys.newLine) + sys.newLine + sys.newLine);
1039+
output.push(`You can learn more at https://aka.ms/tsconfig.json` + sys.newLine);
1040+
for (const line of output) {
1041+
sys.write(line);
1042+
}
10391043
}
10401044

10411045
return;

0 commit comments

Comments
 (0)