Add a way to override description for tsconfig.json

This commit is contained in:
Daniel
2018-01-13 16:52:21 +07:00
parent 94f9e67a24
commit efe57733ca
2 changed files with 5 additions and 2 deletions

View File

@@ -151,7 +151,8 @@ namespace ts {
},
showInSimplifiedHelpView: true,
category: Diagnostics.Basic_Options,
description: Diagnostics.Specify_library_files_to_be_included_in_the_compilation_Colon
description: Diagnostics.Specify_library_files_to_be_included_in_the_compilation_Colon,
descriptionOnTSConfig: Diagnostics.Specify_library_files_to_be_included_in_the_compilation
},
{
name: "allowJs",
@@ -1351,7 +1352,8 @@ namespace ts {
optionName = `// "${option.name}": ${JSON.stringify(getDefaultValueForOption(option))},`;
}
nameColumn.push(optionName);
descriptionColumn.push(`/* ${option.description && getLocaleSpecificMessage(option.description) || option.name} */`);
const optionDescription = option.descriptionOnTSConfig || option.description;
descriptionColumn.push(`/* ${optionDescription && getLocaleSpecificMessage(optionDescription) || option.name} */`);
marginLength = Math.max(optionName.length, marginLength);
}
});

View File

@@ -4120,6 +4120,7 @@ namespace ts {
isFilePath?: boolean; // True if option value is a path or fileName
shortName?: string; // A short mnemonic for convenience - for instance, 'h' can be used in place of 'help'
description?: DiagnosticMessage; // The message describing what the command line switch does
descriptionOnTSConfig?: DiagnosticMessage; // The message describing what the option does in tsconfig.json file
paramType?: DiagnosticMessage; // The name to be used for a non-boolean option's parameter
isTSConfigOnly?: boolean; // True if option can only be specified via tsconfig.json file
isCommandLineOnly?: boolean;