TypeScript/src/compiler/commandLineParser.ts

2028 lines
91 KiB
TypeScript
Raw Normal View History

/// <reference path="sys.ts"/>
2014-07-13 01:04:16 +02:00
/// <reference path="types.ts"/>
/// <reference path="core.ts"/>
/// <reference path="diagnosticInformationMap.generated.ts"/>
/// <reference path="parser.ts"/>
2014-07-13 01:04:16 +02:00
namespace ts {
/* @internal */
export const compileOnSaveCommandLineOption: CommandLineOption = { name: "compileOnSave", type: "boolean" };
/* @internal */
export const optionDeclarations: CommandLineOption[] = [
// CommandLine only options
2014-08-02 02:12:29 +02:00
{
name: "help",
shortName: "h",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Command_line_Options,
2014-08-02 02:12:29 +02:00
description: Diagnostics.Print_this_message,
},
{
2016-05-24 20:33:23 +02:00
name: "help",
shortName: "?",
type: "boolean"
2014-08-02 02:12:29 +02:00
},
2016-02-20 19:27:51 +01:00
{
name: "all",
2015-07-27 13:52:57 +02:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Command_line_Options,
description: Diagnostics.Show_all_compiler_options,
2016-02-20 19:27:51 +01:00
},
2014-08-02 02:12:29 +02:00
{
2017-02-08 08:10:43 +01:00
name: "version",
shortName: "v",
2014-08-02 02:12:29 +02:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Command_line_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Print_the_compiler_s_version,
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "init",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Command_line_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Initializes_a_TypeScript_project_and_creates_a_tsconfig_json_file,
},
{
2017-02-08 08:10:43 +01:00
name: "project",
shortName: "p",
type: "string",
2017-02-08 08:10:43 +01:00
isFilePath: true,
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Command_line_Options,
2017-02-08 08:10:43 +01:00
paramType: Diagnostics.FILE_OR_DIRECTORY,
description: Diagnostics.Compile_the_project_given_the_path_to_its_configuration_file_or_to_a_folder_with_a_tsconfig_json,
},
2014-08-02 02:12:29 +02:00
{
name: "pretty",
2014-08-02 02:12:29 +02:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Command_line_Options,
description: Diagnostics.Stylize_errors_and_messages_using_color_and_context_experimental
2014-08-02 02:12:29 +02:00
},
2016-05-24 20:33:23 +02:00
{
name: "watch",
shortName: "w",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Command_line_Options,
description: Diagnostics.Watch_input_files,
2016-05-24 20:33:23 +02:00
},
// Basic
2015-07-27 13:52:57 +02:00
{
2017-02-08 08:10:43 +01:00
name: "target",
shortName: "t",
type: createMapFromTemplate({
"es3": ScriptTarget.ES3,
"es5": ScriptTarget.ES5,
"es6": ScriptTarget.ES2015,
"es2015": ScriptTarget.ES2015,
"es2016": ScriptTarget.ES2016,
"es2017": ScriptTarget.ES2017,
"esnext": ScriptTarget.ESNext,
}),
paramType: Diagnostics.VERSION,
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Specify_ECMAScript_target_version_Colon_ES3_default_ES5_ES2015_ES2016_ES2017_or_ESNEXT,
2015-07-27 13:52:57 +02:00
},
2015-04-08 09:14:23 +02:00
{
2014-08-02 02:12:29 +02:00
name: "module",
shortName: "m",
2017-01-11 18:52:50 +01:00
type: createMapFromTemplate({
"none": ModuleKind.None,
2014-08-02 02:12:29 +02:00
"commonjs": ModuleKind.CommonJS,
2015-04-10 21:10:38 +02:00
"amd": ModuleKind.AMD,
"system": ModuleKind.System,
2015-04-24 05:50:35 +02:00
"umd": ModuleKind.UMD,
2016-10-14 10:54:54 +02:00
"es6": ModuleKind.ES2015,
"es2015": ModuleKind.ES2015,
2016-08-16 01:41:32 +02:00
}),
2014-08-02 02:12:29 +02:00
paramType: Diagnostics.KIND,
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Specify_module_code_generation_Colon_commonjs_amd_system_umd_or_es2015,
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "lib",
type: "list",
element: {
name: "lib",
type: createMapFromTemplate({
// JavaScript only
"es5": "lib.es5.d.ts",
"es6": "lib.es2015.d.ts",
"es2015": "lib.es2015.d.ts",
"es7": "lib.es2016.d.ts",
"es2016": "lib.es2016.d.ts",
"es2017": "lib.es2017.d.ts",
2017-03-16 01:21:07 +01:00
"esnext": "lib.esnext.d.ts",
2017-02-08 08:10:43 +01:00
// Host only
"dom": "lib.dom.d.ts",
"dom.iterable": "lib.dom.iterable.d.ts",
"webworker": "lib.webworker.d.ts",
"scripthost": "lib.scripthost.d.ts",
// ES2015 Or ESNext By-feature options
"es2015.core": "lib.es2015.core.d.ts",
"es2015.collection": "lib.es2015.collection.d.ts",
"es2015.generator": "lib.es2015.generator.d.ts",
"es2015.iterable": "lib.es2015.iterable.d.ts",
"es2015.promise": "lib.es2015.promise.d.ts",
"es2015.proxy": "lib.es2015.proxy.d.ts",
"es2015.reflect": "lib.es2015.reflect.d.ts",
"es2015.symbol": "lib.es2015.symbol.d.ts",
"es2015.symbol.wellknown": "lib.es2015.symbol.wellknown.d.ts",
"es2016.array.include": "lib.es2016.array.include.d.ts",
"es2017.object": "lib.es2017.object.d.ts",
"es2017.sharedmemory": "lib.es2017.sharedmemory.d.ts",
"es2017.string": "lib.es2017.string.d.ts",
"esnext.asynciterable": "lib.esnext.asynciterable.d.ts",
2017-02-08 08:10:43 +01:00
}),
},
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Specify_library_files_to_be_included_in_the_compilation_Colon
2015-04-08 09:14:23 +02:00
},
2015-04-21 05:33:31 +02:00
{
2017-02-08 08:10:43 +01:00
name: "allowJs",
2015-04-08 09:14:23 +02:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Allow_javascript_files_to_be_compiled
2015-04-08 09:14:23 +02:00
},
2015-04-21 05:33:31 +02:00
{
name: "checkJs",
2015-04-21 05:33:31 +02:00
type: "boolean",
category: Diagnostics.Basic_Options,
description: Diagnostics.Report_errors_in_js_files
2015-04-21 05:33:31 +02:00
},
{
name: "jsx",
2017-01-11 18:52:50 +01:00
type: createMapFromTemplate({
"preserve": JsxEmit.Preserve,
"react-native": JsxEmit.ReactNative,
"react": JsxEmit.React
2016-08-16 01:41:32 +02:00
}),
paramType: Diagnostics.KIND,
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
description: Diagnostics.Specify_JSX_code_generation_Colon_preserve_react_native_or_react,
},
{
2017-02-08 08:10:43 +01:00
name: "declaration",
shortName: "d",
2014-12-17 05:25:19 +01:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Generates_corresponding_d_ts_file,
},
{
2017-02-08 08:10:43 +01:00
name: "sourceMap",
type: "boolean",
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Generates_corresponding_map_file,
},
2014-08-02 02:12:29 +02:00
{
2017-02-08 08:10:43 +01:00
name: "outFile",
2014-08-02 02:12:29 +02:00
type: "string",
2017-02-08 08:10:43 +01:00
isFilePath: true,
paramType: Diagnostics.FILE,
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Concatenate_and_emit_output_to_single_file,
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "outDir",
2014-08-02 02:12:29 +02:00
type: "string",
isFilePath: true,
2017-02-08 08:10:43 +01:00
paramType: Diagnostics.DIRECTORY,
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Redirect_output_structure_to_the_directory,
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "rootDir",
2014-08-02 02:12:29 +02:00
type: "string",
isFilePath: true,
2014-08-02 02:12:29 +02:00
paramType: Diagnostics.LOCATION,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Specify_the_root_directory_of_input_files_Use_to_control_the_output_directory_structure_with_outDir,
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "removeComments",
type: "boolean",
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Do_not_emit_comments_to_output,
},
2014-12-17 05:25:19 +01:00
{
name: "noEmit",
type: "boolean",
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2014-12-17 05:25:19 +01:00
description: Diagnostics.Do_not_emit_outputs,
},
{
2017-02-08 08:10:43 +01:00
name: "importHelpers",
Unused identifiers compiler code (#9200) * Code changes to update references of the Identifiers * Added code for handling function, method and coonstructor level local variables and parameters * Rebased with origin master * Code changes to handle unused private variables, private methods and typed parameters * Code changes to handle namespace level elements * Code changes to handle unimplemented interfaces * Code to optimize the d.ts check * Correct Code change to handle the parameters for methods inside interfaces * Fix for lint error * Remove Trailing whitespace * Code changes to handle interface implementations * Changes to display the error position correctly * Compiler Test Cases * Adding condition to ignore constructor parameters * Removing unnecessary tests * Additional changes for compiler code * Additional changes to handle constructor scenario * Fixing the consolidated case * Changed logic to search for private instead of public * Response to PR Comments * Changed the error code in test cases as result of merge with master * Adding the missing file * Adding the missing file II * Response to PR comments * Code changes for checking unused imports * Test Cases for Unused Imports * Response to PR comments * Code change specific to position of Import Declaration * Code change for handling the position for unused import * New scenarios for handling parameters in lambda function, type parameters in methods, etc. * Additional scenarios based on PR comments * Removing a redundant check * Added ambient check to imports and typeparatmeter reporting * Added one more scenario to handle type parameters * Added new scenario for TypeParameter on Interface * Refactoring the code * Added scenario to handle private class elements declared in constructor. * Minor change to erro reporting
2016-06-25 00:38:39 +02:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Import_emit_helpers_from_tslib
},
2014-10-27 20:48:46 +01:00
{
name: "downlevelIteration",
2014-10-27 20:48:46 +01:00
type: "boolean",
category: Diagnostics.Basic_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.Provide_full_support_for_iterables_in_for_of_spread_and_destructuring_when_targeting_ES5_or_ES3
2014-10-27 20:48:46 +01:00
},
2016-08-06 00:10:02 +02:00
{
2017-02-08 08:10:43 +01:00
name: "isolatedModules",
2014-08-02 02:12:29 +02:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Basic_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.Transpile_each_file_as_a_separate_module_similar_to_ts_transpileModule
2014-08-02 02:12:29 +02:00
},
2017-02-08 08:10:43 +01:00
2017-03-16 00:15:59 +01:00
// Strict Type Checks
{
name: "strict",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Strict_Type_Checking_Options,
description: Diagnostics.Enable_all_strict_type_checking_options
2016-08-06 00:10:02 +02:00
},
2014-08-02 02:12:29 +02:00
{
name: "noImplicitAny",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Strict_Type_Checking_Options,
description: Diagnostics.Raise_error_on_expressions_and_declarations_with_an_implied_any_type,
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "strictNullChecks",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Strict_Type_Checking_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Enable_strict_null_checks
},
{
name: "noImplicitThis",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Strict_Type_Checking_Options,
2016-03-31 00:01:16 +02:00
description: Diagnostics.Raise_error_on_this_expressions_with_an_implied_any_type,
},
2014-08-02 02:12:29 +02:00
{
2017-03-16 00:15:59 +01:00
name: "alwaysStrict",
2014-12-10 21:37:09 +01:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Strict_Type_Checking_Options,
2017-03-16 00:15:59 +01:00
description: Diagnostics.Parse_in_strict_mode_and_emit_use_strict_for_each_source_file
2014-08-02 02:12:29 +02:00
},
2017-03-16 00:15:59 +01:00
// Additional Checks
Unused identifiers compiler code (#9200) * Code changes to update references of the Identifiers * Added code for handling function, method and coonstructor level local variables and parameters * Rebased with origin master * Code changes to handle unused private variables, private methods and typed parameters * Code changes to handle namespace level elements * Code changes to handle unimplemented interfaces * Code to optimize the d.ts check * Correct Code change to handle the parameters for methods inside interfaces * Fix for lint error * Remove Trailing whitespace * Code changes to handle interface implementations * Changes to display the error position correctly * Compiler Test Cases * Adding condition to ignore constructor parameters * Removing unnecessary tests * Additional changes for compiler code * Additional changes to handle constructor scenario * Fixing the consolidated case * Changed logic to search for private instead of public * Response to PR Comments * Changed the error code in test cases as result of merge with master * Adding the missing file * Adding the missing file II * Response to PR comments * Code changes for checking unused imports * Test Cases for Unused Imports * Response to PR comments * Code change specific to position of Import Declaration * Code change for handling the position for unused import * New scenarios for handling parameters in lambda function, type parameters in methods, etc. * Additional scenarios based on PR comments * Removing a redundant check * Added ambient check to imports and typeparatmeter reporting * Added one more scenario to handle type parameters * Added new scenario for TypeParameter on Interface * Refactoring the code * Added scenario to handle private class elements declared in constructor. * Minor change to erro reporting
2016-06-25 00:38:39 +02:00
{
name: "noUnusedLocals",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-16 00:15:59 +01:00
category: Diagnostics.Additional_Checks,
description: Diagnostics.Report_errors_on_unused_locals,
Unused identifiers compiler code (#9200) * Code changes to update references of the Identifiers * Added code for handling function, method and coonstructor level local variables and parameters * Rebased with origin master * Code changes to handle unused private variables, private methods and typed parameters * Code changes to handle namespace level elements * Code changes to handle unimplemented interfaces * Code to optimize the d.ts check * Correct Code change to handle the parameters for methods inside interfaces * Fix for lint error * Remove Trailing whitespace * Code changes to handle interface implementations * Changes to display the error position correctly * Compiler Test Cases * Adding condition to ignore constructor parameters * Removing unnecessary tests * Additional changes for compiler code * Additional changes to handle constructor scenario * Fixing the consolidated case * Changed logic to search for private instead of public * Response to PR Comments * Changed the error code in test cases as result of merge with master * Adding the missing file * Adding the missing file II * Response to PR comments * Code changes for checking unused imports * Test Cases for Unused Imports * Response to PR comments * Code change specific to position of Import Declaration * Code change for handling the position for unused import * New scenarios for handling parameters in lambda function, type parameters in methods, etc. * Additional scenarios based on PR comments * Removing a redundant check * Added ambient check to imports and typeparatmeter reporting * Added one more scenario to handle type parameters * Added new scenario for TypeParameter on Interface * Refactoring the code * Added scenario to handle private class elements declared in constructor. * Minor change to erro reporting
2016-06-25 00:38:39 +02:00
},
{
name: "noUnusedParameters",
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-16 00:15:59 +01:00
category: Diagnostics.Additional_Checks,
description: Diagnostics.Report_errors_on_unused_parameters,
Unused identifiers compiler code (#9200) * Code changes to update references of the Identifiers * Added code for handling function, method and coonstructor level local variables and parameters * Rebased with origin master * Code changes to handle unused private variables, private methods and typed parameters * Code changes to handle namespace level elements * Code changes to handle unimplemented interfaces * Code to optimize the d.ts check * Correct Code change to handle the parameters for methods inside interfaces * Fix for lint error * Remove Trailing whitespace * Code changes to handle interface implementations * Changes to display the error position correctly * Compiler Test Cases * Adding condition to ignore constructor parameters * Removing unnecessary tests * Additional changes for compiler code * Additional changes to handle constructor scenario * Fixing the consolidated case * Changed logic to search for private instead of public * Response to PR Comments * Changed the error code in test cases as result of merge with master * Adding the missing file * Adding the missing file II * Response to PR comments * Code changes for checking unused imports * Test Cases for Unused Imports * Response to PR comments * Code change specific to position of Import Declaration * Code change for handling the position for unused import * New scenarios for handling parameters in lambda function, type parameters in methods, etc. * Additional scenarios based on PR comments * Removing a redundant check * Added ambient check to imports and typeparatmeter reporting * Added one more scenario to handle type parameters * Added new scenario for TypeParameter on Interface * Refactoring the code * Added scenario to handle private class elements declared in constructor. * Minor change to erro reporting
2016-06-25 00:38:39 +02:00
},
2014-08-02 02:12:29 +02:00
{
2017-02-08 08:10:43 +01:00
name: "noImplicitReturns",
2014-08-02 02:12:29 +02:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-16 00:15:59 +01:00
category: Diagnostics.Additional_Checks,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Report_error_when_not_all_code_paths_in_function_return_a_value
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "noFallthroughCasesInSwitch",
2014-08-02 02:12:29 +02:00
type: "boolean",
showInSimplifiedHelpView: true,
2017-03-16 00:15:59 +01:00
category: Diagnostics.Additional_Checks,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Report_errors_for_fallthrough_cases_in_switch_statement
2014-08-02 02:12:29 +02:00
},
2017-02-08 08:10:43 +01:00
// Module Resolution
{
2015-08-21 01:13:49 +02:00
name: "moduleResolution",
2017-01-11 18:52:50 +01:00
type: createMapFromTemplate({
2015-08-21 01:13:49 +02:00
"node": ModuleResolutionKind.NodeJs,
"classic": ModuleResolutionKind.Classic,
2016-08-16 01:41:32 +02:00
}),
paramType: Diagnostics.STRATEGY,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Module_Resolution_Options,
description: Diagnostics.Specify_module_resolution_strategy_Colon_node_Node_js_or_classic_TypeScript_pre_1_6,
},
2016-05-22 02:44:37 +02:00
{
name: "baseUrl",
2015-04-15 07:11:25 +02:00
type: "string",
isFilePath: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Module_Resolution_Options,
2015-11-25 01:41:41 +01:00
description: Diagnostics.Base_directory_to_resolve_non_absolute_module_names
2016-05-22 02:44:37 +02:00
},
2014-08-02 02:12:29 +02:00
{
// this option can only be specified in tsconfig.json
// use type = object to copy the value as-is
name: "paths",
type: "object",
isTSConfigOnly: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Module_Resolution_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.A_series_of_entries_which_re_map_imports_to_lookup_locations_relative_to_the_baseUrl
},
{
// this option can only be specified in tsconfig.json
// use type = object to copy the value as-is
name: "rootDirs",
type: "list",
2015-11-26 01:41:09 +01:00
isTSConfigOnly: true,
element: {
name: "rootDirs",
type: "string",
isFilePath: true
},
2017-02-09 04:25:08 +01:00
category: Diagnostics.Module_Resolution_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.List_of_root_folders_whose_combined_content_represents_the_structure_of_the_project_at_runtime
2014-08-02 02:12:29 +02:00
},
{
2016-06-11 00:44:11 +02:00
name: "typeRoots",
type: "list",
element: {
name: "typeRoots",
2016-06-13 18:33:49 +02:00
type: "string",
isFilePath: true
},
2017-02-09 04:25:08 +01:00
category: Diagnostics.Module_Resolution_Options,
description: Diagnostics.List_of_folders_to_include_type_definitions_from
2014-08-02 02:12:29 +02:00
},
{
name: "types",
type: "list",
element: {
name: "types",
type: "string"
},
showInSimplifiedHelpView: true,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Module_Resolution_Options,
description: Diagnostics.Type_declaration_files_to_be_included_in_compilation
},
2014-12-10 21:37:09 +01:00
{
2017-02-08 08:10:43 +01:00
name: "allowSyntheticDefaultImports",
2014-12-10 21:37:09 +01:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Module_Resolution_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Allow_default_imports_from_modules_with_no_default_export_This_does_not_affect_code_emit_just_typechecking
2014-12-10 21:37:09 +01:00
},
2017-02-08 08:10:43 +01:00
// Source Maps
{
name: "sourceRoot",
type: "string",
isFilePath: true,
paramType: Diagnostics.LOCATION,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Source_Map_Options,
description: Diagnostics.Specify_the_location_where_debugger_should_locate_TypeScript_files_instead_of_source_locations,
2014-08-02 02:12:29 +02:00
},
{
name: "mapRoot",
2014-08-02 02:12:29 +02:00
type: "string",
isFilePath: true,
paramType: Diagnostics.LOCATION,
2017-03-22 20:01:08 +01:00
category: Diagnostics.Source_Map_Options,
description: Diagnostics.Specify_the_location_where_debugger_should_locate_map_files_instead_of_generated_locations,
2014-08-02 02:12:29 +02:00
},
2014-12-10 21:37:09 +01:00
{
name: "inlineSourceMap",
2014-12-10 21:37:09 +01:00
type: "boolean",
2017-03-22 20:01:08 +01:00
category: Diagnostics.Source_Map_Options,
description: Diagnostics.Emit_a_single_file_with_source_maps_instead_of_having_a_separate_file
2014-12-10 21:37:09 +01:00
},
2015-11-02 22:20:48 +01:00
{
name: "inlineSources",
2014-08-02 02:12:29 +02:00
type: "boolean",
2017-03-22 20:01:08 +01:00
category: Diagnostics.Source_Map_Options,
2017-02-14 07:21:34 +01:00
description: Diagnostics.Emit_the_source_alongside_the_sourcemaps_within_a_single_file_requires_inlineSourceMap_or_sourceMap_to_be_set
2015-11-02 22:20:48 +01:00
},
2017-02-08 08:10:43 +01:00
// Experimental
{
2015-06-02 00:01:24 +02:00
name: "experimentalDecorators",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Experimental_Options,
2015-06-02 00:01:24 +02:00
description: Diagnostics.Enables_experimental_support_for_ES7_decorators
},
{
name: "emitDecoratorMetadata",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Experimental_Options,
2015-06-02 00:01:24 +02:00
description: Diagnostics.Enables_experimental_support_for_emitting_type_metadata_for_decorators
2015-08-21 01:13:49 +02:00
},
2017-02-08 08:10:43 +01:00
// Advanced
2015-08-21 01:13:49 +02:00
{
2017-03-16 00:15:59 +01:00
name: "jsxFactory",
type: "string",
2017-03-16 00:15:59 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Specify_the_JSX_factory_function_to_use_when_targeting_react_JSX_emit_e_g_React_createElement_or_h
},
{
2017-02-08 08:10:43 +01:00
name: "diagnostics",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Show_diagnostic_information
},
2014-08-02 02:12:29 +02:00
{
2017-02-08 08:10:43 +01:00
name: "extendedDiagnostics",
2014-08-02 02:12:29 +02:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.Show_verbose_diagnostic_information
2014-08-02 02:12:29 +02:00
},
2015-04-15 07:11:25 +02:00
{
2017-02-08 08:10:43 +01:00
name: "traceResolution",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Enable_tracing_of_the_name_resolution_process
2015-04-15 07:11:25 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "listFiles",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Print_names_of_files_part_of_the_compilation
},
2014-08-02 02:12:29 +02:00
{
name: "listEmittedFiles",
2014-08-02 02:12:29 +02:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Print_names_of_generated_files_part_of_the_compilation
2014-08-02 02:12:29 +02:00
},
2017-02-08 08:10:43 +01:00
2014-08-02 02:12:29 +02:00
{
name: "out",
2014-08-02 02:12:29 +02:00
type: "string",
isFilePath: false, // This is intentionally broken to support compatability with existing tsconfig files
// for correct behaviour, please use outFile
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
paramType: Diagnostics.FILE,
description: Diagnostics.Deprecated_Use_outFile_instead_Concatenate_and_emit_output_to_single_file,
2014-08-02 02:12:29 +02:00
},
{
name: "reactNamespace",
type: "string",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Deprecated_Use_jsxFactory_instead_Specify_the_object_invoked_for_createElement_when_targeting_react_JSX_emit
},
2014-12-10 21:37:09 +01:00
{
name: "skipDefaultLibCheck",
2014-12-10 21:37:09 +01:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Deprecated_Use_skipLibCheck_instead_Skip_type_checking_of_default_library_declaration_files
2014-12-10 21:37:09 +01:00
},
{
2017-02-08 08:10:43 +01:00
name: "charset",
type: "string",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.The_character_set_of_the_input_files
},
{
2017-02-08 08:10:43 +01:00
name: "emitBOM",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-14 07:21:34 +01:00
description: Diagnostics.Emit_a_UTF_8_Byte_Order_Mark_BOM_in_the_beginning_of_output_files
},
2014-08-02 02:12:29 +02:00
{
2017-02-08 08:10:43 +01:00
name: "locale",
type: "string",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.The_locale_used_when_displaying_messages_to_the_user_e_g_en_us
2015-11-20 06:11:57 +01:00
},
{
2017-02-08 08:10:43 +01:00
name: "newLine",
2017-01-11 18:52:50 +01:00
type: createMapFromTemplate({
2017-02-08 08:10:43 +01:00
"crlf": NewLineKind.CarriageReturnLineFeed,
"lf": NewLineKind.LineFeed
2016-08-16 01:41:32 +02:00
}),
2017-02-08 08:10:43 +01:00
paramType: Diagnostics.NEWLINE,
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Specify_the_end_of_line_sequence_to_be_used_when_emitting_files_Colon_CRLF_dos_or_LF_unix,
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "noErrorTruncation",
2014-08-02 02:12:29 +02:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.Do_not_truncate_error_messages
2014-08-02 02:12:29 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "noLib",
2014-08-02 02:12:29 +02:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Do_not_include_the_default_library_file_lib_d_ts
},
2015-06-02 00:01:24 +02:00
{
2017-02-08 08:10:43 +01:00
name: "noResolve",
2015-06-02 00:01:24 +02:00
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.Do_not_add_triple_slash_references_or_imported_modules_to_the_list_of_compiled_files
2015-06-02 00:01:24 +02:00
},
{
2017-02-08 08:10:43 +01:00
name: "stripInternal",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-02-08 08:10:43 +01:00
description: Diagnostics.Do_not_emit_declarations_for_code_that_has_an_internal_annotation,
},
{
2017-02-08 08:10:43 +01:00
name: "disableSizeLimit",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2017-03-22 20:01:08 +01:00
description: Diagnostics.Disable_size_limitations_on_JavaScript_projects
},
{
2016-02-06 01:30:01 +01:00
name: "noImplicitUseStrict",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
2016-02-03 23:16:09 +01:00
description: Diagnostics.Do_not_emit_use_strict_directives_in_module_output
},
{
name: "noEmitHelpers",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Do_not_generate_custom_helper_functions_like_extends_in_compiled_output
},
{
name: "noEmitOnError",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Do_not_emit_outputs_if_any_errors_were_reported,
2015-10-29 17:33:27 +01:00
},
{
name: "preserveConstEnums",
type: "boolean",
2017-02-09 04:25:08 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Do_not_erase_const_enum_declarations_in_generated_code
},
{
2017-02-09 04:32:27 +01:00
name: "declarationDir",
type: "string",
isFilePath: true,
2017-02-09 04:32:27 +01:00
paramType: Diagnostics.DIRECTORY,
category: Diagnostics.Advanced_Options,
description: Diagnostics.Output_directory_for_generated_declaration_files
2015-11-20 06:11:57 +01:00
},
{
2017-02-09 04:32:27 +01:00
name: "skipLibCheck",
type: "boolean",
2017-02-09 04:32:27 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Skip_type_checking_of_declaration_files,
},
{
2017-02-09 04:32:27 +01:00
name: "allowUnusedLabels",
type: "boolean",
2017-02-09 04:32:27 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Do_not_report_errors_on_unused_labels
},
2015-11-20 06:33:33 +01:00
{
2017-02-09 04:32:27 +01:00
name: "allowUnreachableCode",
type: "boolean",
2017-02-09 04:32:27 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Do_not_report_errors_on_unreachable_code
},
{
2017-02-09 04:32:27 +01:00
name: "suppressExcessPropertyErrors",
type: "boolean",
2017-02-09 04:32:27 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Suppress_excess_property_checks_for_object_literals,
},
{
2017-02-09 04:32:27 +01:00
name: "suppressImplicitAnyIndexErrors",
type: "boolean",
2017-02-09 04:32:27 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Suppress_noImplicitAny_errors_for_indexing_objects_lacking_index_signatures,
2016-02-03 23:16:09 +01:00
},
{
2017-02-09 04:32:27 +01:00
name: "forceConsistentCasingInFileNames",
2016-02-03 23:16:09 +01:00
type: "boolean",
2017-02-09 04:32:27 +01:00
category: Diagnostics.Advanced_Options,
description: Diagnostics.Disallow_inconsistently_cased_references_to_the_same_file
},
2016-02-13 16:48:25 +01:00
{
name: "maxNodeModuleJsDepth",
type: "number",
2017-02-09 04:32:27 +01:00
category: Diagnostics.Advanced_Options,
2016-02-13 16:48:25 +01:00
description: Diagnostics.The_maximum_dependency_depth_to_search_under_node_modules_and_load_JavaScript_files
},
{
2017-02-14 22:35:16 +01:00
// A list of plugins to load in the language service
name: "plugins",
type: "list",
2017-02-14 22:35:16 +01:00
isTSConfigOnly: true,
element: {
2017-02-14 22:35:16 +01:00
name: "plugin",
type: "object"
},
2017-03-22 20:01:08 +01:00
description: Diagnostics.List_of_language_service_plugins
}
2014-07-13 01:04:16 +02:00
];
/* @internal */
export const typeAcquisitionDeclarations: CommandLineOption[] = [
{
/* @deprecated typingOptions.enableAutoDiscovery
* Use typeAcquisition.enable instead.
*/
name: "enableAutoDiscovery",
type: "boolean",
},
{
name: "enable",
type: "boolean",
},
{
name: "include",
type: "list",
element: {
name: "include",
type: "string"
}
},
{
name: "exclude",
type: "list",
element: {
2016-03-16 22:08:49 +01:00
name: "exclude",
type: "string"
}
}
2014-07-13 01:04:16 +02:00
];
2015-08-25 23:34:34 +02:00
/* @internal */
2015-07-27 13:52:57 +02:00
export interface OptionNameMap {
optionNameMap: Map<CommandLineOption>;
shortOptionNames: Map<string>;
}
2014-07-13 01:04:16 +02:00
/* @internal */
export const defaultInitCompilerOptions: CompilerOptions = {
module: ModuleKind.CommonJS,
target: ScriptTarget.ES5,
strict: true
};
2015-07-27 13:52:57 +02:00
let optionNameMapCache: OptionNameMap;
/* @internal */
2016-11-22 23:47:44 +01:00
export function convertEnableAutoDiscoveryToEnable(typeAcquisition: TypeAcquisition): TypeAcquisition {
// Convert deprecated typingOptions.enableAutoDiscovery to typeAcquisition.enable
if (typeAcquisition && typeAcquisition.enableAutoDiscovery !== undefined && typeAcquisition.enable === undefined) {
2016-11-22 23:47:44 +01:00
const result: TypeAcquisition = {
enable: typeAcquisition.enableAutoDiscovery,
include: typeAcquisition.include || [],
exclude: typeAcquisition.exclude || []
};
2017-01-07 08:44:17 +01:00
return result;
}
2016-11-22 23:47:44 +01:00
return typeAcquisition;
}
2015-08-25 23:34:34 +02:00
/* @internal */
2015-07-27 13:52:57 +02:00
export function getOptionNameMap(): OptionNameMap {
if (optionNameMapCache) {
return optionNameMapCache;
}
2014-07-13 01:04:16 +02:00
2016-08-11 01:47:06 +02:00
const optionNameMap = createMap<CommandLineOption>();
const shortOptionNames = createMap<string>();
forEach(optionDeclarations, option => {
2016-12-05 23:13:32 +01:00
optionNameMap.set(option.name.toLowerCase(), option);
if (option.shortName) {
2016-12-05 23:13:32 +01:00
shortOptionNames.set(option.shortName, option.name);
}
});
2015-07-27 13:52:57 +02:00
optionNameMapCache = { optionNameMap, shortOptionNames };
return optionNameMapCache;
}
2016-03-14 23:53:42 +01:00
/* @internal */
export function createCompilerDiagnosticForInvalidCustomType(opt: CommandLineOptionOfCustomType): Diagnostic {
return createDiagnosticForInvalidCustomType(opt, createCompilerDiagnostic);
}
function createDiagnosticForInvalidCustomType(opt: CommandLineOptionOfCustomType, createDiagnostic: (message: DiagnosticMessage, arg0: string, arg1: string) => Diagnostic): Diagnostic {
2016-12-28 18:05:52 +01:00
const namesOfType = arrayFrom(opt.type.keys()).map(key => `'${key}'`).join(", ");
return createDiagnostic(Diagnostics.Argument_for_0_option_must_be_Colon_1, `--${opt.name}`, namesOfType);
2016-03-14 23:53:42 +01:00
}
/* @internal */
export function parseCustomTypeOption(opt: CommandLineOptionOfCustomType, value: string, errors: Diagnostic[]) {
return convertJsonOptionOfCustomType(opt, trimString(value || ""), errors);
}
/* @internal */
2016-06-10 23:14:32 +02:00
export function parseListTypeOption(opt: CommandLineOptionOfListType, value = "", errors: Diagnostic[]): (string | number)[] | undefined {
value = trimString(value);
if (startsWith(value, "-")) {
return undefined;
}
2016-06-10 23:35:13 +02:00
if (value === "") {
2016-06-10 23:14:32 +02:00
return [];
}
const values = value.split(",");
switch (opt.element.type) {
case "number":
2016-06-10 23:14:32 +02:00
return map(values, parseInt);
case "string":
2016-06-10 23:14:32 +02:00
return map(values, v => v || "");
default:
return filter(map(values, v => parseCustomTypeOption(<CommandLineOptionOfCustomType>opt.element, v, errors)), v => !!v);
}
}
export function parseCommandLine(commandLine: string[], readFile?: (path: string) => string): ParsedCommandLine {
2015-11-04 23:02:33 +01:00
const options: CompilerOptions = {};
const fileNames: string[] = [];
const errors: Diagnostic[] = [];
const { optionNameMap, shortOptionNames } = getOptionNameMap();
2015-07-27 13:52:57 +02:00
2014-07-13 01:04:16 +02:00
parseStrings(commandLine);
return {
options,
fileNames,
errors
2014-07-13 01:04:16 +02:00
};
function parseStrings(args: string[]) {
2015-06-26 02:36:19 +02:00
let i = 0;
2014-07-13 01:04:16 +02:00
while (i < args.length) {
2015-12-23 00:45:00 +01:00
let s = args[i];
i++;
2014-07-13 01:04:16 +02:00
if (s.charCodeAt(0) === CharacterCodes.at) {
parseResponseFile(s.slice(1));
}
else if (s.charCodeAt(0) === CharacterCodes.minus) {
s = s.slice(s.charCodeAt(1) === CharacterCodes.minus ? 2 : 1).toLowerCase();
// Try to translate short option names to their full equivalents.
2016-12-05 23:13:32 +01:00
const short = shortOptionNames.get(s);
if (short !== undefined) {
s = short;
2014-07-13 01:04:16 +02:00
}
2016-12-05 23:13:32 +01:00
const opt = optionNameMap.get(s);
if (opt) {
if (opt.isTSConfigOnly) {
errors.push(createCompilerDiagnostic(Diagnostics.Option_0_can_only_be_specified_in_tsconfig_json_file, opt.name));
2014-07-13 01:04:16 +02:00
}
else {
// Check to see if no argument was provided (e.g. "--locale" is the last command-line argument).
if (!args[i] && opt.type !== "boolean") {
errors.push(createCompilerDiagnostic(Diagnostics.Compiler_option_0_expects_an_argument, opt.name));
}
switch (opt.type) {
case "number":
options[opt.name] = parseInt(args[i]);
i++;
break;
case "boolean":
// boolean flag has optional value true, false, others
2016-12-18 07:44:54 +01:00
const optValue = args[i];
options[opt.name] = optValue !== "false";
// consume next argument as boolean flag value
if (optValue === "false" || optValue === "true") {
i++;
}
break;
case "string":
options[opt.name] = args[i] || "";
i++;
break;
case "list":
2016-06-10 23:14:32 +02:00
const result = parseListTypeOption(<CommandLineOptionOfListType>opt, args[i], errors);
options[opt.name] = result || [];
if (result) {
i++;
}
break;
// If not a primitive, the possible types are specified in what is effectively a map of options.
default:
options[opt.name] = parseCustomTypeOption(<CommandLineOptionOfCustomType>opt, args[i], errors);
i++;
break;
}
2014-07-13 01:04:16 +02:00
}
}
else {
errors.push(createCompilerDiagnostic(Diagnostics.Unknown_compiler_option_0, s));
}
}
else {
fileNames.push(s);
2014-07-13 01:04:16 +02:00
}
}
}
function parseResponseFile(fileName: string) {
2015-11-04 23:02:33 +01:00
const text = readFile ? readFile(fileName) : sys.readFile(fileName);
2014-07-13 01:04:16 +02:00
if (!text) {
errors.push(createCompilerDiagnostic(Diagnostics.File_0_not_found, fileName));
2014-07-13 01:04:16 +02:00
return;
}
2015-11-04 23:02:33 +01:00
const args: string[] = [];
2015-06-26 02:36:19 +02:00
let pos = 0;
2014-07-13 01:04:16 +02:00
while (true) {
while (pos < text.length && text.charCodeAt(pos) <= CharacterCodes.space) pos++;
if (pos >= text.length) break;
2015-11-04 23:02:33 +01:00
const start = pos;
2014-07-13 01:04:16 +02:00
if (text.charCodeAt(start) === CharacterCodes.doubleQuote) {
pos++;
while (pos < text.length && text.charCodeAt(pos) !== CharacterCodes.doubleQuote) pos++;
if (pos < text.length) {
args.push(text.substring(start + 1, pos));
pos++;
}
else {
errors.push(createCompilerDiagnostic(Diagnostics.Unterminated_quoted_string_in_response_file_0, fileName));
2014-07-13 01:04:16 +02:00
}
}
else {
while (text.charCodeAt(pos) > CharacterCodes.space) pos++;
args.push(text.substring(start, pos));
}
}
parseStrings(args);
}
}
/**
2017-04-03 18:32:39 +02:00
* Read tsconfig.json file
* @param fileName The path to the config file
*/
export function readConfigFile(fileName: string, readFile: (path: string) => string): { config?: any; error?: Diagnostic } {
let text = "";
try {
2015-08-28 01:52:49 +02:00
text = readFile(fileName);
}
catch (e) {
return { error: createCompilerDiagnostic(Diagnostics.Cannot_read_file_0_Colon_1, fileName, e.message) };
2015-04-23 03:09:55 +02:00
}
2015-10-15 00:10:05 +02:00
return parseConfigFileTextToJson(fileName, text);
2015-04-23 03:09:55 +02:00
}
/**
2017-04-03 18:32:39 +02:00
* Parse the text of the tsconfig.json file
* @param fileName The path to the config file
* @param jsonText The text of the config file
*/
export function parseConfigFileTextToJson(fileName: string, jsonText: string): { config?: any; error?: Diagnostic } {
const jsonSourceFile = parseJsonText(fileName, jsonText);
2016-11-11 22:41:43 +01:00
return {
2017-02-08 20:45:03 +01:00
config: convertToObject(jsonSourceFile, jsonSourceFile.parseDiagnostics),
error: jsonSourceFile.parseDiagnostics.length ? jsonSourceFile.parseDiagnostics[0] : undefined
2016-11-11 22:41:43 +01:00
};
}
/**
* Read tsconfig.json file
* @param fileName The path to the config file
*/
2017-02-08 20:45:03 +01:00
export function readJsonConfigFile(fileName: string, readFile: (path: string) => string): JsonSourceFile {
let text = "";
try {
text = readFile(fileName);
}
catch (e) {
return <JsonSourceFile>{ parseDiagnostics: [createCompilerDiagnostic(Diagnostics.Cannot_read_file_0_Colon_1, fileName, e.message)] };
}
return parseJsonText(fileName, text);
}
function commandLineOptionsToMap(options: CommandLineOption[]) {
return arrayToMap(options, option => option.name);
}
2017-02-08 20:45:03 +01:00
let _tsconfigRootOptions: Map<CommandLineOption>;
function getTsconfigRootOptionsMap() {
2017-02-08 20:45:03 +01:00
if (_tsconfigRootOptions === undefined) {
_tsconfigRootOptions = commandLineOptionsToMap([
{
name: "compilerOptions",
type: "object",
optionDeclarations: commandLineOptionsToMap(optionDeclarations),
extraKeyDiagnosticMessage: Diagnostics.Unknown_compiler_option_0
},
{
name: "typingOptions",
type: "object",
optionDeclarations: commandLineOptionsToMap(typeAcquisitionDeclarations),
extraKeyDiagnosticMessage: Diagnostics.Unknown_type_acquisition_option_0
},
{
name: "typeAcquisition",
type: "object",
optionDeclarations: commandLineOptionsToMap(typeAcquisitionDeclarations),
extraKeyDiagnosticMessage: Diagnostics.Unknown_type_acquisition_option_0
},
{
name: "extends",
type: "string"
},
{
name: "files",
type: "list",
element: {
name: "files",
type: "string"
}
},
{
name: "include",
type: "list",
element: {
name: "include",
type: "string"
}
},
{
name: "exclude",
type: "list",
element: {
name: "exclude",
type: "string"
}
},
compileOnSaveCommandLineOption
]);
}
2017-02-08 20:45:03 +01:00
return _tsconfigRootOptions;
}
interface JsonConversionNotifier {
/** Notifies options object is being set with the optionKey and optionValue is being set */
onSetOptionKeyValue(optionsObject: string, option: CommandLineOption, value: CompilerOptionsValue): void;
/** Notify when root key value is being set */
onRootKeyValue(key: string, propertyName: PropertyName, value: CompilerOptionsValue, node: Expression): void;
}
2016-11-11 22:41:43 +01:00
/**
* Convert the json syntax tree into the json value
* @param jsonNode
* @param errors
*/
2017-02-08 20:45:03 +01:00
export function convertToObject(sourceFile: JsonSourceFile, errors: Diagnostic[]): any {
return convertToObjectWorker(sourceFile, errors);
}
/**
* Convert the json syntax tree into the json value
* @param jsonNode
* @param errors
*/
2017-02-08 20:45:03 +01:00
function convertToObjectWorker(sourceFile: JsonSourceFile, errors: Diagnostic[], knownRootOptions?: Map<CommandLineOption>, optionsIterator?: JsonConversionNotifier): any {
if (!sourceFile.jsonObject) {
if (sourceFile.endOfFileToken) {
return {};
}
2016-11-11 22:41:43 +01:00
return undefined;
}
2016-11-11 22:41:43 +01:00
return convertObjectLiteralExpressionToJson(sourceFile.jsonObject, knownRootOptions);
2016-11-11 22:41:43 +01:00
2017-02-08 20:45:03 +01:00
function convertObjectLiteralExpressionToJson(node: ObjectLiteralExpression, knownOptions: Map<CommandLineOption>, extraKeyDiagnosticMessage?: DiagnosticMessage, optionsObject?: string): any {
2016-11-11 22:41:43 +01:00
const result: any = {};
for (const element of node.properties) {
if (element.kind !== SyntaxKind.PropertyAssignment) {
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, element, Diagnostics.Property_assignment_expected));
continue;
}
if (element.questionToken) {
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, element.questionToken, Diagnostics._0_can_only_be_used_in_a_ts_file, "?"));
}
if (!isDoubleQuotedString(element.name)) {
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, element.name, Diagnostics.String_literal_with_double_quotes_expected));
}
const keyText = getTextOfPropertyName(element.name);
2017-02-08 20:45:03 +01:00
const option = knownOptions ? knownOptions.get(keyText) : undefined;
if (extraKeyDiagnosticMessage && !option) {
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, element.name, extraKeyDiagnosticMessage, keyText));
}
2017-02-08 20:45:03 +01:00
const value = convertPropertyValueToJson(element.initializer, option);
if (typeof keyText !== undefined && typeof value !== undefined) {
result[keyText] = value;
// Notify key value set, if user asked for it
if (optionsIterator &&
2017-02-08 20:45:03 +01:00
(optionsObject || knownOptions === knownRootOptions)) {
const isValidOptionValue = isCompilerOptionsValue(option, value);
if (optionsObject && isValidOptionValue) {
optionsIterator.onSetOptionKeyValue(optionsObject, option, value);
2016-11-11 22:41:43 +01:00
}
2017-02-08 20:45:03 +01:00
if (knownOptions === knownRootOptions && (isValidOptionValue || !option)) {
optionsIterator.onRootKeyValue(keyText, element.name, value, element.initializer);
2016-11-11 22:41:43 +01:00
}
}
2016-11-11 22:41:43 +01:00
}
}
return result;
}
function convertArrayLiteralExpressionToJson(elements: NodeArray<Expression>, option?: CommandLineOption): any[] {
2016-11-11 22:41:43 +01:00
const result: any[] = [];
for (const element of elements) {
2017-02-08 20:45:03 +01:00
result.push(convertPropertyValueToJson(element, option));
2016-11-11 22:41:43 +01:00
}
return result;
}
2017-02-08 20:45:03 +01:00
function convertPropertyValueToJson(node: Expression, option: CommandLineOption): any {
2016-11-11 22:41:43 +01:00
switch (node.kind) {
case SyntaxKind.TrueKeyword:
reportInvalidOptionValue(option && option.type !== "boolean");
2016-11-11 22:41:43 +01:00
return true;
case SyntaxKind.FalseKeyword:
reportInvalidOptionValue(option && option.type !== "boolean");
2016-11-11 22:41:43 +01:00
return false;
case SyntaxKind.NullKeyword:
reportInvalidOptionValue(!!option);
2016-11-11 22:41:43 +01:00
return null; // tslint:disable-line:no-null-keyword
case SyntaxKind.StringLiteral:
if (!isDoubleQuotedString(node)) {
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, node, Diagnostics.String_literal_with_double_quotes_expected));
}
reportInvalidOptionValue(option && (typeof option.type === "string" && option.type !== "string"));
const text = (<StringLiteral>node).text;
if (option && typeof option.type !== "string") {
const customOption = <CommandLineOptionOfCustomType>option;
// Validate custom option type
if (!customOption.type.has(text)) {
errors.push(
createDiagnosticForInvalidCustomType(
customOption,
(message, arg0, arg1) => createDiagnosticForNodeInSourceFile(sourceFile, node, message, arg0, arg1)
)
);
}
}
return text;
2016-11-11 22:41:43 +01:00
case SyntaxKind.NumericLiteral:
reportInvalidOptionValue(option && option.type !== "number");
2016-11-11 22:41:43 +01:00
return Number((<NumericLiteral>node).text);
case SyntaxKind.ObjectLiteralExpression:
reportInvalidOptionValue(option && option.type !== "object");
const objectOption = <TsConfigOnlyOption>option;
2017-02-08 20:45:03 +01:00
const optionDeclarations = option && objectOption.optionDeclarations;
return convertObjectLiteralExpressionToJson(
<ObjectLiteralExpression>node,
optionDeclarations,
option && objectOption.extraKeyDiagnosticMessage,
optionDeclarations && option.name
);
2016-11-11 22:41:43 +01:00
case SyntaxKind.ArrayLiteralExpression:
reportInvalidOptionValue(option && option.type !== "list");
return convertArrayLiteralExpressionToJson((<ArrayLiteralExpression>node).elements, option && (<CommandLineOptionOfListType>option).element);
2016-11-11 22:41:43 +01:00
}
// Not in expected format
if (option) {
2017-02-08 20:45:03 +01:00
reportInvalidOptionValue(/*isError*/ true);
}
else {
2017-02-08 20:45:03 +01:00
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, node, Diagnostics.Property_value_can_only_be_string_literal_numeric_literal_true_false_null_object_literal_or_array_literal));
}
2016-11-11 22:41:43 +01:00
return undefined;
function reportInvalidOptionValue(isError: boolean) {
if (isError) {
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, node, Diagnostics.Compiler_option_0_requires_a_value_of_type_1, option.name, getCompilerOptionValueTypeString(option)));
}
}
2016-11-11 22:41:43 +01:00
}
function isDoubleQuotedString(node: Node) {
return node.kind === SyntaxKind.StringLiteral && getSourceTextOfNodeFromSourceFile(sourceFile, node).charCodeAt(0) === CharacterCodes.doubleQuote;
}
}
function getCompilerOptionValueTypeString(option: CommandLineOption) {
return option.type === "list" ?
"Array" :
typeof option.type === "string" ? option.type : "string";
}
function isCompilerOptionsValue(option: CommandLineOption, value: any): value is CompilerOptionsValue {
if (option) {
if (option.type === "list") {
return isArray(value);
}
const expectedType = typeof option.type === "string" ? option.type : "string";
return typeof value === expectedType;
}
}
/**
* Generate tsconfig configuration when running command line "--init"
* @param options commandlineOptions to be generated into tsconfig.json
* @param fileNames array of filenames to be generated into tsconfig.json
*/
/* @internal */
export function generateTSConfig(options: CompilerOptions, fileNames: string[], newLine: string): string {
const compilerOptions = extend(options, defaultInitCompilerOptions);
const configurations: { compilerOptions: MapLike<CompilerOptionsValue>; files?: string[] } = {
compilerOptions: serializeCompilerOptions(compilerOptions)
};
if (fileNames && fileNames.length) {
// only set the files property if we have at least one file
configurations.files = fileNames;
}
return writeConfigurations();
function getCustomTypeMapOfCommandLineOption(optionDefinition: CommandLineOption): Map<string | number> | undefined {
if (optionDefinition.type === "string" || optionDefinition.type === "number" || optionDefinition.type === "boolean") {
// this is of a type CommandLineOptionOfPrimitiveType
return undefined;
}
else if (optionDefinition.type === "list") {
return getCustomTypeMapOfCommandLineOption((<CommandLineOptionOfListType>optionDefinition).element);
}
else {
return (<CommandLineOptionOfCustomType>optionDefinition).type;
}
}
2016-12-05 23:13:32 +01:00
function getNameOfCompilerOptionValue(value: CompilerOptionsValue, customTypeMap: Map<string | number>): string | undefined {
// There is a typeMap associated with this command-line option so use it to map value back to its name
return forEachEntry(customTypeMap, (mapValue, key) => {
2016-12-05 23:13:32 +01:00
if (mapValue === value) {
return key;
}
2016-12-05 23:13:32 +01:00
});
}
2016-12-05 23:13:32 +01:00
function serializeCompilerOptions(options: CompilerOptions): MapLike<CompilerOptionsValue> {
const result: ts.MapLike<CompilerOptionsValue> = {};
const optionsNameMap = getOptionNameMap().optionNameMap;
for (const name in options) {
if (hasProperty(options, name)) {
// tsconfig only options cannot be specified via command line,
// so we can assume that only types that can appear here string | number | boolean
2017-03-22 20:01:08 +01:00
if (optionsNameMap.has(name) && optionsNameMap.get(name).category === Diagnostics.Command_line_Options) {
continue;
}
const value = <CompilerOptionsValue>options[name];
const optionDefinition = optionsNameMap.get(name.toLowerCase());
if (optionDefinition) {
const customTypeMap = getCustomTypeMapOfCommandLineOption(optionDefinition);
if (!customTypeMap) {
// There is no map associated with this compiler option then use the value as-is
// This is the case if the value is expect to be string, number, boolean or list of string
result[name] = value;
}
else {
if (optionDefinition.type === "list") {
const convertedValue: string[] = [];
for (const element of value as (string | number)[]) {
convertedValue.push(getNameOfCompilerOptionValue(element, customTypeMap));
}
result[name] = convertedValue;
}
else {
// There is a typeMap associated with this command-line option so use it to map value back to its name
result[name] = getNameOfCompilerOptionValue(value, customTypeMap);
}
}
}
}
}
return result;
}
function getDefaultValueForOption(option: CommandLineOption) {
switch (option.type) {
case "number":
return 1;
case "boolean":
return true;
case "string":
return option.isFilePath ? "./" : "";
case "list":
return [];
case "object":
return {};
default:
return arrayFrom((<CommandLineOptionOfCustomType>option).type.keys())[0];
}
}
2017-03-16 00:08:32 +01:00
function makePadding(paddingLength: number): string {
return Array(paddingLength + 1).join(" ");
}
function writeConfigurations() {
2017-03-16 00:08:32 +01:00
// Filter applicable options to place in the file
const categorizedOptions = reduceLeft(
2017-03-22 20:01:08 +01:00
filter(optionDeclarations, o => o.category !== Diagnostics.Command_line_Options && o.category !== Diagnostics.Advanced_Options),
(memo, value) => {
if (value.category) {
2017-02-09 04:25:08 +01:00
const name = getLocaleSpecificMessage(value.category);
(memo[name] || (memo[name] = [])).push(value);
}
return memo;
}, <MapLike<CommandLineOption[]>>{});
2017-03-16 00:08:32 +01:00
// Serialize all options and thier descriptions
let marginLength = 0;
let seenKnownKeys = 0;
2017-03-16 00:08:32 +01:00
const nameColumn: string[] = [];
const descriptionColumn: string[] = [];
const knownKeysCount = getOwnKeys(configurations.compilerOptions).length;
for (const category in categorizedOptions) {
2017-03-16 00:08:32 +01:00
if (nameColumn.length !== 0) {
nameColumn.push("");
descriptionColumn.push("");
}
nameColumn.push(`/* ${category} */`);
descriptionColumn.push("");
for (const option of categorizedOptions[category]) {
2017-03-16 00:08:32 +01:00
let optionName;
if (hasProperty(configurations.compilerOptions, option.name)) {
optionName = `"${option.name}": ${JSON.stringify(configurations.compilerOptions[option.name])}${(seenKnownKeys += 1) === knownKeysCount ? "" : ","}`;
}
else {
2017-03-16 00:08:32 +01:00
optionName = `// "${option.name}": ${JSON.stringify(getDefaultValueForOption(option))},`;
}
2017-03-16 00:08:32 +01:00
nameColumn.push(optionName);
descriptionColumn.push(`/* ${option.description && getLocaleSpecificMessage(option.description) || option.name} */`);
marginLength = Math.max(optionName.length, marginLength);
}
2017-03-16 00:08:32 +01:00
}
// Write the output
const tab = makePadding(2);
const result: string[] = [];
result.push(`{`);
result.push(`${tab}"compilerOptions": {`);
// Print out each row, aligning all the descriptions on the same column.
for (let i = 0; i < nameColumn.length; i++) {
const optionName = nameColumn[i];
const description = descriptionColumn[i];
result.push(tab + tab + optionName + makePadding(marginLength - optionName.length + 2) + description);
}
if (configurations.files && configurations.files.length) {
2017-03-16 00:08:32 +01:00
result.push(`${tab}},`);
result.push(`${tab}"files": [`);
for (let i = 0; i < configurations.files.length; i++) {
2017-03-16 00:08:32 +01:00
result.push(`${tab}${tab}${JSON.stringify(configurations.files[i])}${i === configurations.files.length - 1 ? "" : ","}`);
}
2017-03-16 00:08:32 +01:00
result.push(`${tab}]`);
}
else {
2017-03-16 00:08:32 +01:00
result.push(`${tab}}`);
}
2017-03-16 00:08:32 +01:00
result.push(`}`);
return result.join(newLine);
}
}
/**
* Parse the contents of a config file (tsconfig.json).
* @param json The contents of the config file to parse
* @param host Instance of ParseConfigHost used to enumerate files in folder.
* @param basePath A root directory to resolve relative path entries in the config
* file to. e.g. outDir
*/
export function parseJsonConfigFileContent(json: any, host: ParseConfigHost, basePath: string, existingOptions?: CompilerOptions, configFileName?: string, resolutionStack?: Path[], extraFileExtensions?: JsFileExtensionInfo[]): ParsedCommandLine {
return parseJsonConfigFileContentWorker(json, /*sourceFile*/ undefined, host, basePath, existingOptions, configFileName, resolutionStack, extraFileExtensions);
}
/**
* Parse the contents of a config file (tsconfig.json).
* @param jsonNode The contents of the config file to parse
* @param host Instance of ParseConfigHost used to enumerate files in folder.
* @param basePath A root directory to resolve relative path entries in the config
* file to. e.g. outDir
*/
export function parseJsonSourceFileConfigFileContent(sourceFile: JsonSourceFile, host: ParseConfigHost, basePath: string, existingOptions?: CompilerOptions, configFileName?: string, resolutionStack?: Path[], extraFileExtensions?: JsFileExtensionInfo[]): ParsedCommandLine {
return parseJsonConfigFileContentWorker(/*json*/ undefined, sourceFile, host, basePath, existingOptions, configFileName, resolutionStack, extraFileExtensions);
}
/**
2017-04-03 18:32:39 +02:00
* Parse the contents of a config file (tsconfig.json).
* @param json The contents of the config file to parse
* @param host Instance of ParseConfigHost used to enumerate files in folder.
* @param basePath A root directory to resolve relative path entries in the config
* file to. e.g. outDir
*/
function parseJsonConfigFileContentWorker(json: any, sourceFile: JsonSourceFile, host: ParseConfigHost, basePath: string, existingOptions: CompilerOptions = {}, configFileName?: string, resolutionStack: Path[] = [], extraFileExtensions: JsFileExtensionInfo[] = []): ParsedCommandLine {
Debug.assert((json === undefined && sourceFile !== undefined) || (json !== undefined && sourceFile === undefined));
const errors: Diagnostic[] = [];
basePath = normalizeSlashes(basePath);
2016-07-25 23:48:41 +02:00
const getCanonicalFileName = createGetCanonicalFileName(host.useCaseSensitiveFileNames);
const resolvedPath = toPath(configFileName || "", basePath, getCanonicalFileName);
if (resolutionStack.indexOf(resolvedPath) >= 0) {
return {
options: {},
fileNames: [],
typeAcquisition: {},
2017-02-08 20:45:03 +01:00
raw: json || convertToObject(sourceFile, errors),
errors: errors.concat(createCompilerDiagnostic(Diagnostics.Circularity_detected_while_resolving_configuration_Colon_0, [...resolutionStack, resolvedPath].join(" -> "))),
2016-07-25 23:48:41 +02:00
wildcardDirectories: {}
};
}
let options: CompilerOptions;
let typeAcquisition: TypeAcquisition;
let compileOnSave: boolean;
let hasExtendsError: boolean, extendedConfigPath: Path;
if (json) {
options = convertCompilerOptionsFromJsonWorker(json["compilerOptions"], basePath, errors, configFileName);
// typingOptions has been deprecated and is only supported for backward compatibility purposes.
// It should be removed in future releases - use typeAcquisition instead.
const jsonOptions = json["typeAcquisition"] || json["typingOptions"];
typeAcquisition = convertTypeAcquisitionFromJsonWorker(jsonOptions, basePath, errors, configFileName);
compileOnSave = convertCompileOnSaveOptionFromJson(json, basePath, errors);
}
else {
options = getDefaultCompilerOptions(configFileName);
let typingOptionstypeAcquisition: TypeAcquisition;
const optionsIterator: JsonConversionNotifier = {
onSetOptionKeyValue(optionsObject: string, option: CommandLineOption, value: CompilerOptionsValue) {
Debug.assert(optionsObject === "compilerOptions" || optionsObject === "typeAcquisition" || optionsObject === "typingOptions");
const currentOption = optionsObject === "compilerOptions" ? options :
optionsObject === "typeAcquisition" ? (typeAcquisition || (typeAcquisition = getDefaultTypeAcquisition(configFileName)) ) :
(typingOptionstypeAcquisition || (typingOptionstypeAcquisition = getDefaultTypeAcquisition(configFileName)));
currentOption[option.name] = normalizeOptionValue(option, basePath, value);
},
onRootKeyValue(key: string, propertyName: PropertyName, value: CompilerOptionsValue, node: Expression) {
switch (key) {
case "extends":
const extendsDiagnostic = getExtendsConfigPath(<string>value, (message, arg0) =>
createDiagnosticForNodeInSourceFile(sourceFile, node, message, arg0));
if ((<Diagnostic>extendsDiagnostic).messageText) {
errors.push(<Diagnostic>extendsDiagnostic);
hasExtendsError = true;
}
else {
extendedConfigPath = <Path>extendsDiagnostic;
}
return;
case "excludes":
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, propertyName, Diagnostics.Unknown_option_excludes_Did_you_mean_exclude));
return;
case "files":
if ((<string[]>value).length === 0) {
errors.push(createDiagnosticForNodeInSourceFile(sourceFile, node, Diagnostics.The_files_list_in_config_file_0_is_empty, configFileName || "tsconfig.json"));
}
return;
case "compileOnSave":
compileOnSave = <boolean>value;
return;
}
}
};
2017-02-08 20:45:03 +01:00
json = convertToObjectWorker(sourceFile, errors, getTsconfigRootOptionsMap(), optionsIterator);
if (!typeAcquisition) {
if (typingOptionstypeAcquisition) {
typeAcquisition = (typingOptionstypeAcquisition.enableAutoDiscovery !== undefined) ?
{
enable: typingOptionstypeAcquisition.enableAutoDiscovery,
include: typingOptionstypeAcquisition.include,
exclude: typingOptionstypeAcquisition.exclude
} :
typingOptionstypeAcquisition;
}
else {
typeAcquisition = getDefaultTypeAcquisition(configFileName);
}
}
}
2016-07-25 23:48:41 +02:00
if (json["extends"]) {
let [include, exclude, files, baseOptions]: [string[], string[], string[], CompilerOptions] = [undefined, undefined, undefined, {}];
if (!hasExtendsError && typeof json["extends"] === "string") {
[include, exclude, files, baseOptions] = (tryExtendsName(json["extends"], extendedConfigPath) || [include, exclude, files, baseOptions]);
2016-07-25 23:48:41 +02:00
}
else {
createCompilerDiagnosticForJson(Diagnostics.Compiler_option_0_requires_a_value_of_type_1, "extends", "string");
2016-07-25 23:48:41 +02:00
}
if (include && !json["include"]) {
json["include"] = include;
}
if (exclude && !json["exclude"]) {
json["exclude"] = exclude;
}
if (files && !json["files"]) {
json["files"] = files;
}
options = assign({}, baseOptions, options);
}
options = extend(existingOptions, options);
2016-03-23 19:41:34 +01:00
options.configFilePath = configFileName;
options.configFile = sourceFile;
const { fileNames, wildcardDirectories } = getFileNames(errors);
return {
options,
2015-12-07 23:58:13 +01:00
fileNames,
typeAcquisition,
raw: json,
2015-12-07 23:58:13 +01:00
errors,
wildcardDirectories,
compileOnSave
};
function getExtendsConfigPath<T>(extendedConfig: string, createDiagnostic: (message: DiagnosticMessage, arg1?: string) => T): T | Path {
2016-07-25 23:48:41 +02:00
// If the path isn't a rooted or relative path, don't try to resolve it (we reserve the right to special case module-id like paths in the future)
if (!(isRootedDiskPath(extendedConfig) || startsWith(normalizeSlashes(extendedConfig), "./") || startsWith(normalizeSlashes(extendedConfig), "../"))) {
return createDiagnostic(Diagnostics.A_path_in_an_extends_option_must_be_relative_or_rooted_but_0_is_not, extendedConfig);
2016-07-25 23:48:41 +02:00
}
let extendedConfigPath = toPath(extendedConfig, basePath, getCanonicalFileName);
if (!host.fileExists(extendedConfigPath) && !endsWith(extendedConfigPath, ".json")) {
extendedConfigPath = `${extendedConfigPath}.json` as Path;
if (!host.fileExists(extendedConfigPath)) {
return createDiagnostic(Diagnostics.File_0_does_not_exist, extendedConfig);
}
}
return extendedConfigPath;
}
function tryExtendsName(extendedConfig: string, extendedConfigPath?: Path): [string[], string[], string[], CompilerOptions] {
if (!extendedConfigPath) {
const result = getExtendsConfigPath(extendedConfig, (message, arg1) => (createCompilerDiagnosticForJson(message, arg1), true));
if (result === true) {
2016-07-25 23:48:41 +02:00
return;
}
extendedConfigPath = <Path>result;
}
if (!host.fileExists(extendedConfigPath) && !endsWith(extendedConfigPath, ".json")) {
extendedConfigPath = `${extendedConfigPath}.json` as Path;
2016-07-25 23:48:41 +02:00
}
2017-02-08 20:45:03 +01:00
const extendedResult = readJsonConfigFile(extendedConfigPath, path => host.readFile(path));
if (extendedResult.parseDiagnostics.length) {
errors.push(...extendedResult.parseDiagnostics);
2016-07-25 23:48:41 +02:00
return;
}
const extendedDirname = getDirectoryPath(extendedConfigPath);
const relativeDifference = convertToRelativePath(extendedDirname, basePath, getCanonicalFileName);
const updatePath: (path: string) => string = path => isRootedDiskPath(path) ? path : combinePaths(relativeDifference, path);
// Merge configs (copy the resolution stack so it is never reused between branches in potential diamond-problem scenarios)
const result = parseJsonSourceFileConfigFileContent(extendedResult, host, extendedDirname, /*existingOptions*/ undefined, getBaseFileName(extendedConfigPath), resolutionStack.concat([resolvedPath]));
2016-07-25 23:48:41 +02:00
errors.push(...result.errors);
const [include, exclude, files] = map(["include", "exclude", "files"], key => {
if (!json[key] && result.raw[key]) {
return map(result.raw[key], updatePath);
2016-07-25 23:48:41 +02:00
}
});
return [include, exclude, files, result.options];
}
function getFileNames(errors: Diagnostic[]): ExpandResult {
let fileNames: string[];
if (hasProperty(json, "files")) {
if (isArray(json["files"])) {
fileNames = <string[]>json["files"];
if (fileNames.length === 0) {
createCompilerDiagnosticForJson(Diagnostics.The_files_list_in_config_file_0_is_empty, configFileName || "tsconfig.json");
}
}
else {
createCompilerDiagnosticForJson(Diagnostics.Compiler_option_0_requires_a_value_of_type_1, "files", "Array");
}
}
let includeSpecs: string[];
if (hasProperty(json, "include")) {
if (isArray(json["include"])) {
includeSpecs = <string[]>json["include"];
}
else {
createCompilerDiagnosticForJson(Diagnostics.Compiler_option_0_requires_a_value_of_type_1, "include", "Array");
}
}
let excludeSpecs: string[];
if (hasProperty(json, "exclude")) {
if (isArray(json["exclude"])) {
excludeSpecs = <string[]>json["exclude"];
}
else {
createCompilerDiagnosticForJson(Diagnostics.Compiler_option_0_requires_a_value_of_type_1, "exclude", "Array");
}
}
else if (hasProperty(json, "excludes")) {
createCompilerDiagnosticForJson(Diagnostics.Unknown_option_excludes_Did_you_mean_exclude);
}
2016-05-26 02:07:36 +02:00
else {
// If no includes were specified, exclude common package folders and the outDir
excludeSpecs = includeSpecs ? [] : ["node_modules", "bower_components", "jspm_packages"];
2016-05-26 02:07:36 +02:00
const outDir = json["compilerOptions"] && json["compilerOptions"]["outDir"];
if (outDir) {
excludeSpecs.push(outDir);
}
2016-05-26 02:07:36 +02:00
}
if (fileNames === undefined && includeSpecs === undefined) {
2015-12-07 23:58:13 +01:00
includeSpecs = ["**/*"];
}
const result = matchFileNames(fileNames, includeSpecs, excludeSpecs, basePath, options, host, errors, extraFileExtensions, sourceFile);
if (result.fileNames.length === 0 && !hasProperty(json, "files") && resolutionStack.length === 0) {
errors.push(
createCompilerDiagnostic(
Diagnostics.No_inputs_were_found_in_config_file_0_Specified_include_paths_were_1_and_exclude_paths_were_2,
configFileName || "tsconfig.json",
JSON.stringify(includeSpecs || []),
JSON.stringify(excludeSpecs || [])));
}
return result;
}
function createCompilerDiagnosticForJson(message: DiagnosticMessage, arg0?: string, arg1?: string) {
if (!sourceFile) {
errors.push(createCompilerDiagnostic(message, arg0, arg1));
}
}
}
export function convertCompileOnSaveOptionFromJson(jsonOption: any, basePath: string, errors: Diagnostic[]): boolean {
if (!hasProperty(jsonOption, compileOnSaveCommandLineOption.name)) {
return false;
}
const result = convertJsonOption(compileOnSaveCommandLineOption, jsonOption["compileOnSave"], basePath, errors);
if (typeof result === "boolean" && result) {
return result;
}
return false;
}
export function convertCompilerOptionsFromJson(jsonOptions: any, basePath: string, configFileName?: string): { options: CompilerOptions, errors: Diagnostic[] } {
2015-11-04 23:02:33 +01:00
const errors: Diagnostic[] = [];
const options = convertCompilerOptionsFromJsonWorker(jsonOptions, basePath, errors, configFileName);
return { options, errors };
}
export function convertTypeAcquisitionFromJson(jsonOptions: any, basePath: string, configFileName?: string): { options: TypeAcquisition, errors: Diagnostic[] } {
const errors: Diagnostic[] = [];
const options = convertTypeAcquisitionFromJsonWorker(jsonOptions, basePath, errors, configFileName);
return { options, errors };
}
function getDefaultCompilerOptions(configFileName?: string) {
const options: CompilerOptions = getBaseFileName(configFileName) === "jsconfig.json"
? { allowJs: true, maxNodeModuleJsDepth: 2, allowSyntheticDefaultImports: true, skipLibCheck: true }
: {};
return options;
}
function convertCompilerOptionsFromJsonWorker(jsonOptions: any,
basePath: string, errors: Diagnostic[], configFileName?: string): CompilerOptions {
const options = getDefaultCompilerOptions(configFileName);
convertOptionsFromJson(optionDeclarations, jsonOptions, basePath, options, Diagnostics.Unknown_compiler_option_0, errors);
return options;
}
function getDefaultTypeAcquisition(configFileName?: string) {
const options: TypeAcquisition = { enable: getBaseFileName(configFileName) === "jsconfig.json", include: [], exclude: [] };
return options;
}
function convertTypeAcquisitionFromJsonWorker(jsonOptions: any,
basePath: string, errors: Diagnostic[], configFileName?: string): TypeAcquisition {
const options = getDefaultTypeAcquisition(configFileName);
2016-11-22 23:47:44 +01:00
const typeAcquisition = convertEnableAutoDiscoveryToEnable(jsonOptions);
convertOptionsFromJson(typeAcquisitionDeclarations, typeAcquisition, basePath, options, Diagnostics.Unknown_type_acquisition_option_0, errors);
return options;
}
function convertOptionsFromJson(optionDeclarations: CommandLineOption[], jsonOptions: any, basePath: string,
defaultOptions: CompilerOptions | TypeAcquisition, diagnosticMessage: DiagnosticMessage, errors: Diagnostic[]) {
if (!jsonOptions) {
2016-05-03 23:52:41 +02:00
return;
}
const optionNameMap = commandLineOptionsToMap(optionDeclarations);
2015-11-04 23:02:33 +01:00
for (const id in jsonOptions) {
2016-12-05 23:13:32 +01:00
const opt = optionNameMap.get(id);
if (opt) {
defaultOptions[opt.name] = convertJsonOption(opt, jsonOptions[id], basePath, errors);
}
else {
errors.push(createCompilerDiagnostic(diagnosticMessage, id));
}
}
}
2016-03-17 00:35:51 +01:00
function convertJsonOption(opt: CommandLineOption, value: any, basePath: string, errors: Diagnostic[]): CompilerOptionsValue {
if (isCompilerOptionsValue(opt, value)) {
const optType = opt.type;
if (optType === "list" && isArray(value)) {
return convertJsonOptionOfListType(<CommandLineOptionOfListType>opt, value, basePath, errors);
}
else if (typeof optType !== "string") {
return convertJsonOptionOfCustomType(<CommandLineOptionOfCustomType>opt, <string>value, errors);
}
return normalizeNonListOptionValue(opt, basePath, value);
}
else {
errors.push(createCompilerDiagnostic(Diagnostics.Compiler_option_0_requires_a_value_of_type_1, opt.name, getCompilerOptionValueTypeString(opt)));
}
}
function normalizeOptionValue(option: CommandLineOption, basePath: string, value: any): CompilerOptionsValue {
if (option.type === "list") {
const listOption = <CommandLineOptionOfListType>option;
if (listOption.element.isFilePath || typeof listOption.element.type !== "string") {
return <CompilerOptionsValue>filter(map(value, v => normalizeOptionValue(listOption.element, basePath, v)), v => !!v);
}
return value;
}
else if (typeof option.type !== "string") {
return option.type.get(value);
}
return normalizeNonListOptionValue(option, basePath, value);
}
function normalizeNonListOptionValue(option: CommandLineOption, basePath: string, value: any): CompilerOptionsValue {
if (option.isFilePath) {
value = normalizePath(combinePaths(basePath, value));
if (value === "") {
value = ".";
}
}
return value;
}
function convertJsonOptionOfCustomType(opt: CommandLineOptionOfCustomType, value: string, errors: Diagnostic[]) {
const key = value.toLowerCase();
2016-12-05 23:13:32 +01:00
const val = opt.type.get(key);
if (val !== undefined) {
return val;
}
else {
errors.push(createCompilerDiagnosticForInvalidCustomType(opt));
}
}
function convertJsonOptionOfListType(option: CommandLineOptionOfListType, values: any[], basePath: string, errors: Diagnostic[]): any[] {
2016-03-16 23:29:13 +01:00
return filter(map(values, v => convertJsonOption(option.element, v, basePath, errors)), v => !!v);
}
2016-05-03 23:52:41 +02:00
function trimString(s: string) {
return typeof s.trim === "function" ? s.trim() : s.replace(/^[\s]+|[\s]+$/g, "");
}
/**
* Tests for a path that ends in a recursive directory wildcard.
2016-01-04 20:37:25 +01:00
* Matches **, \**, **\, and \**\, but not a**b.
*
2016-01-04 20:37:25 +01:00
* NOTE: used \ in place of / above to avoid issues with multiline comments.
*
* Breakdown:
* (^|\/) # matches either the beginning of the string or a directory separator.
* \*\* # matches the recursive directory wildcard "**".
* \/?$ # matches an optional trailing directory separator at the end of the string.
*/
const invalidTrailingRecursionPattern = /(^|\/)\*\*\/?$/;
/**
* Tests for a path with multiple recursive directory wildcards.
2016-01-04 20:37:25 +01:00
* Matches **\** and **\a\**, but not **\a**b.
*
2016-01-04 20:37:25 +01:00
* NOTE: used \ in place of / above to avoid issues with multiline comments.
*
* Breakdown:
* (^|\/) # matches either the beginning of the string or a directory separator.
* \*\*\/ # matches a recursive directory wildcard "**" followed by a directory separator.
* (.*\/)? # optionally matches any number of characters followed by a directory separator.
* \*\* # matches a recursive directory wildcard "**"
* ($|\/) # matches either the end of the string or a directory separator.
*/
const invalidMultipleRecursionPatterns = /(^|\/)\*\*\/(.*\/)?\*\*($|\/)/;
2015-12-07 23:58:13 +01:00
/**
* Tests for a path where .. appears after a recursive directory wildcard.
* Matches **\..\*, **\a\..\*, and **\.., but not ..\**\*
*
* NOTE: used \ in place of / above to avoid issues with multiline comments.
*
* Breakdown:
* (^|\/) # matches either the beginning of the string or a directory separator.
* \*\*\/ # matches a recursive directory wildcard "**" followed by a directory separator.
* (.*\/)? # optionally matches any number of characters followed by a directory separator.
* \.\. # matches a parent directory path component ".."
* ($|\/) # matches either the end of the string or a directory separator.
*/
const invalidDotDotAfterRecursiveWildcardPattern = /(^|\/)\*\*\/(.*\/)?\.\.($|\/)/;
/**
* Tests for a path containing a wildcard character in a directory component of the path.
2016-01-04 20:37:25 +01:00
* Matches \*\, \?\, and \a*b\, but not \a\ or \a\*.
*
2016-01-04 20:37:25 +01:00
* NOTE: used \ in place of / above to avoid issues with multiline comments.
*
* Breakdown:
* \/ # matches a directory separator.
* [^/]*? # matches any number of characters excluding directory separators (non-greedy).
* [*?] # matches either a wildcard character (* or ?)
* [^/]* # matches any number of characters excluding directory separators (greedy).
* \/ # matches a directory separator.
*/
const watchRecursivePattern = /\/[^/]*?[*?][^/]*\//;
/**
* Matches the portion of a wildcard path that does not contain wildcards.
2016-01-04 20:37:25 +01:00
* Matches \a of \a\*, or \a\b\c of \a\b\c\?\d.
*
* NOTE: used \ in place of / above to avoid issues with multiline comments.
*
* Breakdown:
* ^ # matches the beginning of the string
* [^*?]* # matches any number of non-wildcard characters
* (?=\/[^/]*[*?]) # lookahead that matches a directory separator followed by
* # a path component that contains at least one wildcard character (* or ?).
*/
const wildcardDirectoryPattern = /^[^*?]*(?=\/[^/]*[*?])/;
/**
* Expands an array of file specifications.
*
* @param fileNames The literal file names to include.
2015-12-16 22:42:17 +01:00
* @param include The wildcard file specifications to include.
* @param exclude The wildcard file specifications to exclude.
* @param basePath The base path for any relative file specifications.
* @param options Compiler options.
* @param host The host used to resolve files and directories.
* @param errors An array for diagnostic reporting.
*/
function matchFileNames(fileNames: string[], include: string[], exclude: string[], basePath: string, options: CompilerOptions, host: ParseConfigHost, errors: Diagnostic[], extraFileExtensions: JsFileExtensionInfo[], jsonSourceFile: JsonSourceFile): ExpandResult {
basePath = normalizePath(basePath);
2015-12-07 23:58:13 +01:00
// The exclude spec list is converted into a regular expression, which allows us to quickly
// test whether a file or directory should be excluded before recursively traversing the
// file system.
const keyMapper = host.useCaseSensitiveFileNames ? caseSensitiveKeyMapper : caseInsensitiveKeyMapper;
// Literal file names (provided via the "files" array in tsconfig.json) are stored in a
2015-12-08 19:54:23 +01:00
// file map with a possibly case insensitive key. We use this map later when when including
2015-12-07 23:58:13 +01:00
// wildcard paths.
2016-08-11 01:47:06 +02:00
const literalFileMap = createMap<string>();
2015-12-07 23:58:13 +01:00
2015-12-08 19:54:23 +01:00
// Wildcard paths (provided via the "includes" array in tsconfig.json) are stored in a
// file map with a possibly case insensitive key. We use this map to store paths matched
2015-12-07 23:58:13 +01:00
// via wildcard, and to handle extension priority.
2016-08-11 01:47:06 +02:00
const wildcardFileMap = createMap<string>();
2015-12-07 23:58:13 +01:00
2015-12-16 22:42:17 +01:00
if (include) {
include = validateSpecs(include, errors, /*allowTrailingRecursion*/ false, jsonSourceFile, "include");
2015-12-16 22:42:17 +01:00
}
if (exclude) {
exclude = validateSpecs(exclude, errors, /*allowTrailingRecursion*/ true, jsonSourceFile, "exclude");
2015-12-16 22:42:17 +01:00
}
2015-12-07 23:58:13 +01:00
// Wildcard directories (provided as part of a wildcard path) are stored in a
// file map that marks whether it was a regular wildcard match (with a `*` or `?` token),
// or a recursive directory. This information is used by filesystem watchers to monitor for
// new entries in these paths.
2016-12-05 23:13:32 +01:00
const wildcardDirectories = getWildcardDirectories(include, exclude, basePath, host.useCaseSensitiveFileNames);
2015-12-07 23:58:13 +01:00
2015-12-08 19:54:23 +01:00
// Rather than requery this for each file and filespec, we query the supported extensions
2015-12-07 23:58:13 +01:00
// once and store it on the expansion context.
const supportedExtensions = getSupportedExtensions(options, extraFileExtensions);
2015-12-07 23:58:13 +01:00
// Literal files are always included verbatim. An "include" or "exclude" specification cannot
// remove a literal file.
if (fileNames) {
for (const fileName of fileNames) {
const file = combinePaths(basePath, fileName);
2016-12-05 23:13:32 +01:00
literalFileMap.set(keyMapper(file), file);
}
}
2015-12-16 22:42:17 +01:00
if (include && include.length > 0) {
for (const file of host.readDirectory(basePath, supportedExtensions, exclude, include)) {
// If we have already included a literal or wildcard path with a
// higher priority extension, we should skip this file.
//
// This handles cases where we may encounter both <file>.ts and
// <file>.d.ts (or <file>.js if "allowJs" is enabled) in the same
// directory when they are compilation outputs.
if (hasFileWithHigherPriorityExtension(file, literalFileMap, wildcardFileMap, supportedExtensions, keyMapper)) {
2015-12-07 23:58:13 +01:00
continue;
}
// We may have included a wildcard path with a lower priority
// extension due to the user-defined order of entries in the
// "include" array. If there is a lower priority extension in the
// same directory, we should remove it.
removeWildcardFilesWithLowerPriorityExtension(file, wildcardFileMap, supportedExtensions, keyMapper);
const key = keyMapper(file);
2016-12-05 23:13:32 +01:00
if (!literalFileMap.has(key) && !wildcardFileMap.has(key)) {
wildcardFileMap.set(key, file);
}
}
}
2015-12-07 23:58:13 +01:00
2016-12-28 18:05:52 +01:00
const literalFiles = arrayFrom(literalFileMap.values());
const wildcardFiles = arrayFrom(wildcardFileMap.values());
return {
fileNames: literalFiles.concat(wildcardFiles),
wildcardDirectories
};
}
function validateSpecs(specs: string[], errors: Diagnostic[], allowTrailingRecursion: boolean, jsonSourceFile: JsonSourceFile, specKey: string) {
const validSpecs: string[] = [];
for (const spec of specs) {
if (!allowTrailingRecursion && invalidTrailingRecursionPattern.test(spec)) {
errors.push(createDiagnostic(Diagnostics.File_specification_cannot_end_in_a_recursive_directory_wildcard_Asterisk_Asterisk_Colon_0, spec));
}
else if (invalidMultipleRecursionPatterns.test(spec)) {
errors.push(createDiagnostic(Diagnostics.File_specification_cannot_contain_multiple_recursive_directory_wildcards_Asterisk_Asterisk_Colon_0, spec));
2015-12-07 23:58:13 +01:00
}
else if (invalidDotDotAfterRecursiveWildcardPattern.test(spec)) {
errors.push(createDiagnostic(Diagnostics.File_specification_cannot_contain_a_parent_directory_that_appears_after_a_recursive_directory_wildcard_Asterisk_Asterisk_Colon_0, spec));
}
else {
validSpecs.push(spec);
2015-12-07 23:58:13 +01:00
}
}
return validSpecs;
function createDiagnostic(message: DiagnosticMessage, spec: string): Diagnostic {
if (jsonSourceFile && jsonSourceFile.jsonObject) {
for (const property of getPropertyAssignment(jsonSourceFile.jsonObject, specKey)) {
if (isArrayLiteralExpression(property.initializer)) {
for (const element of property.initializer.elements) {
if (element.kind === SyntaxKind.StringLiteral && (<StringLiteral>element).text === spec) {
return createDiagnosticForNodeInSourceFile(jsonSourceFile, element, message, spec);
}
}
}
}
}
return createCompilerDiagnostic(message, spec);
}
2015-12-07 23:58:13 +01:00
}
/**
* Gets directories in a set of include patterns that should be watched for changes.
2015-12-07 23:58:13 +01:00
*/
2016-12-05 23:13:32 +01:00
function getWildcardDirectories(include: string[], exclude: string[], path: string, useCaseSensitiveFileNames: boolean): MapLike<WatchDirectoryFlags> {
// We watch a directory recursively if it contains a wildcard anywhere in a directory segment
// of the pattern:
//
// /a/b/**/d - Watch /a/b recursively to catch changes to any d in any subfolder recursively
// /a/b/*/d - Watch /a/b recursively to catch any d in any immediate subfolder, even if a new subfolder is added
// /a/b - Watch /a/b recursively to catch changes to anything in any recursive subfoler
//
// We watch a directory without recursion if it contains a wildcard in the file segment of
// the pattern:
//
// /a/b/* - Watch /a/b directly to catch any new file
// /a/b/a?z - Watch /a/b directly to catch any new file matching a?z
const rawExcludeRegex = getRegularExpressionForWildcard(exclude, path, "exclude");
const excludeRegex = rawExcludeRegex && new RegExp(rawExcludeRegex, useCaseSensitiveFileNames ? "" : "i");
const wildcardDirectories: ts.MapLike<WatchDirectoryFlags> = {};
2015-12-16 22:42:17 +01:00
if (include !== undefined) {
const recursiveKeys: string[] = [];
2015-12-16 22:42:17 +01:00
for (const file of include) {
const spec = normalizePath(combinePaths(path, file));
if (excludeRegex && excludeRegex.test(spec)) {
2015-12-16 22:42:17 +01:00
continue;
}
const match = getWildcardDirectoryFromSpec(spec, useCaseSensitiveFileNames);
if (match) {
const { key, flags } = match;
2016-08-15 21:03:39 +02:00
const existingFlags = wildcardDirectories[key];
if (existingFlags === undefined || existingFlags < flags) {
wildcardDirectories[key] = flags;
if (flags === WatchDirectoryFlags.Recursive) {
recursiveKeys.push(key);
}
}
2015-12-07 23:58:13 +01:00
}
}
// Remove any subpaths under an existing recursively watched directory.
for (const key in wildcardDirectories) if (hasProperty(wildcardDirectories, key)) {
2016-08-15 21:03:39 +02:00
for (const recursiveKey of recursiveKeys) {
if (key !== recursiveKey && containsPath(recursiveKey, key, path, !useCaseSensitiveFileNames)) {
delete wildcardDirectories[key];
}
}
}
2015-12-07 23:58:13 +01:00
}
return wildcardDirectories;
2015-12-07 23:58:13 +01:00
}
function getWildcardDirectoryFromSpec(spec: string, useCaseSensitiveFileNames: boolean): { key: string, flags: WatchDirectoryFlags } | undefined {
const match = wildcardDirectoryPattern.exec(spec);
2016-10-12 19:08:43 +02:00
if (match) {
return {
key: useCaseSensitiveFileNames ? match[0] : match[0].toLowerCase(),
flags: watchRecursivePattern.test(spec) ? WatchDirectoryFlags.Recursive : WatchDirectoryFlags.None
2016-10-12 19:08:43 +02:00
};
}
2016-10-24 15:48:05 +02:00
if (isImplicitGlob(spec)) {
2016-10-12 19:08:43 +02:00
return { key: spec, flags: WatchDirectoryFlags.Recursive };
}
2016-10-24 15:48:05 +02:00
return undefined;
}
2015-12-07 23:58:13 +01:00
/**
* Determines whether a literal or wildcard file has already been included that has a higher
* extension priority.
*
* @param file The path to the file.
* @param extensionPriority The priority of the extension.
* @param context The expansion context.
*/
function hasFileWithHigherPriorityExtension(file: string, literalFiles: Map<string>, wildcardFiles: Map<string>, extensions: string[], keyMapper: (value: string) => string) {
const extensionPriority = getExtensionPriority(file, extensions);
const adjustedExtensionPriority = adjustExtensionPriority(extensionPriority, extensions);
2016-01-05 19:11:44 +01:00
for (let i = ExtensionPriority.Highest; i < adjustedExtensionPriority; i++) {
const higherPriorityExtension = extensions[i];
const higherPriorityPath = keyMapper(changeExtension(file, higherPriorityExtension));
2016-12-05 23:13:32 +01:00
if (literalFiles.has(higherPriorityPath) || wildcardFiles.has(higherPriorityPath)) {
2015-12-07 23:58:13 +01:00
return true;
}
}
return false;
}
/**
* Removes files included via wildcard expansion with a lower extension priority that have
* already been included.
*
* @param file The path to the file.
* @param extensionPriority The priority of the extension.
* @param context The expansion context.
*/
function removeWildcardFilesWithLowerPriorityExtension(file: string, wildcardFiles: Map<string>, extensions: string[], keyMapper: (value: string) => string) {
const extensionPriority = getExtensionPriority(file, extensions);
const nextExtensionPriority = getNextLowestExtensionPriority(extensionPriority, extensions);
2016-01-05 19:11:44 +01:00
for (let i = nextExtensionPriority; i < extensions.length; i++) {
const lowerPriorityExtension = extensions[i];
const lowerPriorityPath = keyMapper(changeExtension(file, lowerPriorityExtension));
2016-12-05 23:13:32 +01:00
wildcardFiles.delete(lowerPriorityPath);
}
}
/**
* Gets a case sensitive key.
*
* @param key The original key.
*/
function caseSensitiveKeyMapper(key: string) {
return key;
}
/**
* Gets a case insensitive key.
*
* @param key The original key.
*/
function caseInsensitiveKeyMapper(key: string) {
return key.toLowerCase();
}
2017-02-14 07:21:34 +01:00
}