microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-05-18 07:29:16 -05:00
Code Issues Packages Projects Releases 212 Wiki Activity

Update descriptions for all compiler options (#44409)

Browse Source 
* Add new descriptions to compiler options

* Update baselines
This commit is contained in:
Orta Therox
2021-06-15 21:20:14 +01:00
committed by GitHub
parent e53f19f8f2
commit b74b8977d5
18 changed files with 1625 additions and 1202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
src/compiler/commandLineParser.ts
View File

@@ -110,7 +110,7 @@ namespace ts {
usefseventsonparentdirectory: WatchFileKind.UseFsEventsOnParentDirectory,
})),
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Specify_strategy_for_watching_file_Colon_FixedPollingInterval_default_PriorityPollingInterval_DynamicPriorityPolling_FixedChunkSizePolling_UseFsEvents_UseFsEventsOnParentDirectory,
description: Diagnostics.Specify_how_the_TypeScript_watch_mode_works,
},
{
name: "watchDirectory",
@@ -121,7 +121,7 @@ namespace ts {
fixedchunksizepolling: WatchDirectoryKind.FixedChunkSizePolling,
})),
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Specify_strategy_for_watching_directory_on_platforms_that_don_t_support_recursive_watching_natively_Colon_UseFsEvents_default_FixedPollingInterval_DynamicPriorityPolling_FixedChunkSizePolling,
description: Diagnostics.Specify_how_directories_are_watched_on_systems_that_lack_recursive_file_watching_functionality,
},
{
name: "fallbackPolling",
@@ -132,7 +132,7 @@ namespace ts {
fixedchunksize: PollingWatchKind.FixedChunkSize,
})),
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Specify_strategy_for_creating_a_polling_watch_when_it_fails_to_create_using_file_system_events_Colon_FixedInterval_default_PriorityInterval_DynamicPriority_FixedChunkSize,
description: Diagnostics.Specify_what_approach_the_watcher_should_use_if_the_system_runs_out_of_native_file_watchers,
},
{
name: "synchronousWatchDirectory",
@@ -150,7 +150,7 @@ namespace ts {
extraValidation: specToDiagnostic
},
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Synchronously_call_callbacks_and_update_the_state_of_directory_watchers_on_platforms_that_don_t_support_recursive_watching_natively,
description: Diagnostics.Remove_a_list_of_directories_from_the_watch_process,
},
{
name: "excludeFiles",
@@ -162,7 +162,7 @@ namespace ts {
extraValidation: specToDiagnostic
},
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Synchronously_call_callbacks_and_update_the_state_of_directory_watchers_on_platforms_that_don_t_support_recursive_watching_natively,
description: Diagnostics.Remove_a_list_of_files_from_the_watch_mode_s_processing,
},
];
@@ -195,50 +195,50 @@ namespace ts {
type: "boolean",
showInSimplifiedHelpView: false,
category: Diagnostics.Output_Formatting,
description: Diagnostics.Whether_to_keep_outdated_console_output_in_watch_mode_instead_of_clearing_the_screen,
description: Diagnostics.Disable_wiping_the_console_in_watch_mode,
},
{
name: "listFiles",
type: "boolean",
category: Diagnostics.Compiler_Diagnostics,
description: Diagnostics.Print_names_of_files_part_of_the_compilation
description: Diagnostics.Print_all_of_the_files_read_during_the_compilation
},
{
name: "explainFiles",
type: "boolean",
category: Diagnostics.Compiler_Diagnostics,
description: Diagnostics.Print_names_of_files_and_the_reason_they_are_part_of_the_compilation
description: Diagnostics.Print_files_read_during_the_compilation_including_why_it_was_included
},
{
name: "listEmittedFiles",
type: "boolean",
category: Diagnostics.Compiler_Diagnostics,
description: Diagnostics.Print_names_of_generated_files_part_of_the_compilation
description: Diagnostics.Print_the_names_of_emitted_files_after_a_compilation
},
{
name: "pretty",
type: "boolean",
showInSimplifiedHelpView: true,
category: Diagnostics.Output_Formatting,
description: Diagnostics.Stylize_errors_and_messages_using_color_and_context_experimental
description: Diagnostics.Enable_color_and_formatting_in_output_to_make_compiler_errors_easier_to_read
},
{
name: "traceResolution",
type: "boolean",
category: Diagnostics.Compiler_Diagnostics,
description: Diagnostics.Enable_tracing_of_the_name_resolution_process
description: Diagnostics.Log_paths_used_during_the_moduleResolution_process
},
{
name: "diagnostics",
type: "boolean",
category: Diagnostics.Compiler_Diagnostics,
description: Diagnostics.Show_diagnostic_information
description: Diagnostics.Output_compiler_performance_information_after_building
},
{
name: "extendedDiagnostics",
type: "boolean",
category: Diagnostics.Compiler_Diagnostics,
description: Diagnostics.Show_verbose_diagnostic_information
description: Diagnostics.Output_more_detailed_compiler_performance_information_after_building
},
{
name: "generateCpuProfile",
@@ -246,7 +246,7 @@ namespace ts {
isFilePath: true,
paramType: Diagnostics.FILE_OR_DIRECTORY,
category: Diagnostics.Compiler_Diagnostics,
description: Diagnostics.Generates_a_CPU_profile
description: Diagnostics.Emit_a_v8_CPU_profile_of_the_compiler_run_for_debugging
},
{
name: "generateTrace",
@@ -271,14 +271,14 @@ namespace ts {
affectsSemanticDiagnostics: true,
affectsEmit: true,
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Have_recompiles_in_incremental_and_watch_assume_that_changes_within_a_file_will_only_affect_files_directly_depending_on_it
description: Diagnostics.Have_recompiles_in_projects_that_use_incremental_and_watch_mode_assume_that_changes_within_a_file_will_only_affect_files_directly_depending_on_it
},
{
name: "locale",
type: "string",
category: Diagnostics.Command_line_Options,
isCommandLineOnly: true,
description: Diagnostics.The_locale_used_when_displaying_messages_to_the_user_e_g_en_us
description: Diagnostics.Set_the_language_of_the_messaging_from_TypeScript_This_does_not_affect_emit
},
];
@@ -305,7 +305,7 @@ namespace ts {
paramType: Diagnostics.VERSION,
showInSimplifiedHelpView: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Specify_ECMAScript_target_version_Colon_ES3_default_ES5_ES2015_ES2016_ES2017_ES2018_ES2019_ES2020_ES2021_or_ESNEXT,
description: Diagnostics.Set_the_JavaScript_language_version_for_emitted_JavaScript_and_include_compatible_library_declarations,
};
const commandOptionsWithoutBuild: CommandLineOption[] = [
@@ -388,7 +388,7 @@ namespace ts {
paramType: Diagnostics.KIND,
showInSimplifiedHelpView: true,
category: Diagnostics.Modules,
description: Diagnostics.Specify_module_code_generation_Colon_none_commonjs_amd_system_umd_es2015_es2020_or_ESNext,
description: Diagnostics.Specify_what_module_code_is_generated,
},
{
name: "lib",
@@ -400,7 +400,7 @@ namespace ts {
affectsProgramStructure: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Specify_library_files_to_be_included_in_the_compilation,
description: Diagnostics.Specify_a_set_of_bundled_library_declaration_files_that_describe_the_target_runtime_environment,
transpileOptionValue: undefined
},
{
@@ -409,13 +409,13 @@ namespace ts {
affectsModuleResolution: true,
showInSimplifiedHelpView: true,
category: Diagnostics.JavaScript_Support,
description: Diagnostics.Allow_javascript_files_to_be_compiled
description: Diagnostics.Allow_JavaScript_files_to_be_a_part_of_your_program_Use_the_checkJS_option_to_get_errors_from_these_files
},
{
name: "checkJs",
type: "boolean",
category: Diagnostics.JavaScript_Support,
description: Diagnostics.Report_errors_in_js_files
description: Diagnostics.Enable_error_reporting_in_type_checked_JavaScript_files
},
{
name: "jsx",
@@ -426,7 +426,7 @@ namespace ts {
paramType: Diagnostics.KIND,
showInSimplifiedHelpView: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Specify_JSX_code_generation_Colon_preserve_react_native_react_react_jsx_or_react_jsxdev,
description: Diagnostics.Specify_what_JSX_code_is_generated,
},
{
name: "declaration",
@@ -435,7 +435,7 @@ namespace ts {
affectsEmit: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Emit,
description: Diagnostics.Generates_corresponding_d_ts_file,
description: Diagnostics.Generate_d_ts_files_from_TypeScript_and_JavaScript_files_in_your_project,
transpileOptionValue: undefined
},
{
@@ -444,7 +444,7 @@ namespace ts {
affectsEmit: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Emit,
description: Diagnostics.Generates_a_sourcemap_for_each_corresponding_d_ts_file,
description: Diagnostics.Create_sourcemaps_for_d_ts_files,
transpileOptionValue: undefined
},
{
@@ -452,7 +452,7 @@ namespace ts {
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Only_emit_d_ts_declaration_files,
description: Diagnostics.Only_output_d_ts_files_and_not_JavaScript_files,
transpileOptionValue: undefined
},
{
@@ -461,7 +461,7 @@ namespace ts {
affectsEmit: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Emit,
description: Diagnostics.Generates_corresponding_map_file,
description: Diagnostics.Create_source_map_files_for_emitted_JavaScript_files,
},
{
name: "outFile",
@@ -471,7 +471,7 @@ namespace ts {
paramType: Diagnostics.FILE,
showInSimplifiedHelpView: true,
category: Diagnostics.Emit,
description: Diagnostics.Concatenate_and_emit_output_to_single_file,
description: Diagnostics.Specify_a_file_that_bundles_all_outputs_into_one_JavaScript_file_If_declaration_is_true_also_designates_a_file_that_bundles_all_d_ts_output,
transpileOptionValue: undefined
},
{
@@ -482,7 +482,7 @@ namespace ts {
paramType: Diagnostics.DIRECTORY,
showInSimplifiedHelpView: true,
category: Diagnostics.Emit,
description: Diagnostics.Redirect_output_structure_to_the_directory,
description: Diagnostics.Specify_an_output_folder_for_all_emitted_files,
},
{
name: "rootDir",
@@ -491,7 +491,7 @@ namespace ts {
isFilePath: true,
paramType: Diagnostics.LOCATION,
category: Diagnostics.Modules,
description: Diagnostics.Specify_the_root_directory_of_input_files_Use_to_control_the_output_directory_structure_with_outDir,
description: Diagnostics.Specify_the_root_folder_within_your_source_files,
},
{
name: "composite",
@@ -499,7 +499,7 @@ namespace ts {
affectsEmit: true,
isTSConfigOnly: true,
category: Diagnostics.Projects,
description: Diagnostics.Enable_project_compilation,
description: Diagnostics.Enable_constraints_that_allow_a_TypeScript_project_to_be_used_with_project_references,
transpileOptionValue: undefined
},
{
@@ -509,7 +509,7 @@ namespace ts {
isFilePath: true,
paramType: Diagnostics.FILE,
category: Diagnostics.Projects,
description: Diagnostics.Specify_file_to_store_incremental_compilation_information,
description: Diagnostics.Specify_the_folder_for_tsbuildinfo_incremental_compilation_files,
transpileOptionValue: undefined
},
{
@@ -518,14 +518,14 @@ namespace ts {
affectsEmit: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Emit,
description: Diagnostics.Do_not_emit_comments_to_output,
description: Diagnostics.Disable_emitting_comments,
},
{
name: "noEmit",
type: "boolean",
showInSimplifiedHelpView: true,
category: Diagnostics.Emit,
description: Diagnostics.Do_not_emit_outputs,
description: Diagnostics.Disable_emitting_file_from_a_compilation,
transpileOptionValue: undefined
},
{
@@ -533,7 +533,7 @@ namespace ts {
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Import_emit_helpers_from_tslib
description: Diagnostics.Allow_importing_helper_functions_from_tslib_once_per_project_instead_of_including_them_per_file
},
{
name: "importsNotUsedAsValues",
@@ -552,13 +552,13 @@ namespace ts {
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Provide_full_support_for_iterables_in_for_of_spread_and_destructuring_when_targeting_ES5_or_ES3
description: Diagnostics.Emit_more_compliant_but_verbose_and_less_performant_JavaScript_for_iteration
},
{
name: "isolatedModules",
type: "boolean",
category: Diagnostics.Interop_Constraints,
description: Diagnostics.Transpile_each_file_as_a_separate_module_similar_to_ts_transpileModule,
description: Diagnostics.Ensure_that_each_file_can_be_safely_transpiled_without_relying_on_other_imports,
transpileOptionValue: true
},
@@ -579,7 +579,7 @@ namespace ts {
strictFlag: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Raise_error_on_expressions_and_declarations_with_an_implied_any_type
description: Diagnostics.Enable_error_reporting_for_expressions_and_declarations_with_an_implied_any_type
},
{
name: "strictNullChecks",
@@ -588,7 +588,7 @@ namespace ts {
strictFlag: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Enable_strict_null_checks
description: Diagnostics.When_type_checking_take_into_account_null_and_undefined
},
{
name: "strictFunctionTypes",
@@ -597,7 +597,7 @@ namespace ts {
strictFlag: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Enable_strict_checking_of_function_types
description: Diagnostics.When_assigning_functions_check_to_ensure_parameters_and_the_return_values_are_subtype_compatible
},
{
name: "strictBindCallApply",
@@ -605,7 +605,7 @@ namespace ts {
strictFlag: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Enable_strict_bind_call_and_apply_methods_on_functions
description: Diagnostics.Check_that_the_arguments_for_bind_call_and_apply_methods_match_the_original_function
},
{
name: "strictPropertyInitialization",
@@ -614,7 +614,7 @@ namespace ts {
strictFlag: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Enable_strict_checking_of_property_initialization_in_classes
description: Diagnostics.Check_for_class_properties_that_are_declared_but_not_set_in_the_constructor
},
{
name: "strictOptionalProperties",
@@ -632,7 +632,7 @@ namespace ts {
strictFlag: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Raise_error_on_this_expressions_with_an_implied_any_type,
description: Diagnostics.Enable_error_reporting_when_this_is_given_the_type_any,
},
{
name: "useUnknownInCatchVariables",
@@ -650,7 +650,7 @@ namespace ts {
strictFlag: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Parse_in_strict_mode_and_emit_use_strict_for_each_source_file
description: Diagnostics.Ensure_use_strict_is_always_emitted
},
// Additional Checks
@@ -660,7 +660,7 @@ namespace ts {
affectsSemanticDiagnostics: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Report_errors_on_unused_locals,
description: Diagnostics.Enable_error_reporting_when_a_local_variables_aren_t_read,
},
{
name: "noUnusedParameters",
@@ -668,7 +668,7 @@ namespace ts {
affectsSemanticDiagnostics: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Report_errors_on_unused_parameters,
description: Diagnostics.Raise_an_error_when_a_function_parameter_isn_t_read,
},
{
name: "noImplicitReturns",
@@ -676,7 +676,7 @@ namespace ts {
affectsSemanticDiagnostics: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Report_error_when_not_all_code_paths_in_function_return_a_value
description: Diagnostics.Enable_error_reporting_for_codepaths_that_do_not_explicitly_return_in_a_function
},
{
name: "noFallthroughCasesInSwitch",
@@ -685,7 +685,7 @@ namespace ts {
affectsSemanticDiagnostics: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Report_errors_for_fallthrough_cases_in_switch_statement
description: Diagnostics.Enable_error_reporting_for_fallthrough_cases_in_switch_statements
},
{
name: "noUncheckedIndexedAccess",
@@ -701,14 +701,14 @@ namespace ts {
affectsSemanticDiagnostics: true,
showInSimplifiedHelpView: false,
category: Diagnostics.Type_Checking,
description: Diagnostics.Ensure_overriding_members_in_derived_classes_are_marked_with_an_override_modifier
description: Diagnostics.Add_undefined_to_a_type_when_accessed_using_an_index
},
{
name: "noPropertyAccessFromIndexSignature",
type: "boolean",
showInSimplifiedHelpView: false,
category: Diagnostics.Type_Checking,
description: Diagnostics.Require_undeclared_properties_from_index_signatures_to_use_element_accesses
description: Diagnostics.Enforces_using_indexed_accessors_for_keys_declared_using_an_indexed_type
},
// Module Resolution
@@ -721,7 +721,7 @@ namespace ts {
affectsModuleResolution: true,
paramType: Diagnostics.STRATEGY,
category: Diagnostics.Modules,
description: Diagnostics.Specify_module_resolution_strategy_Colon_node_Node_js_or_classic_TypeScript_pre_1_6,
description: Diagnostics.Specify_how_TypeScript_looks_up_a_file_from_a_given_module_specifier,
},
{
name: "baseUrl",
@@ -729,7 +729,7 @@ namespace ts {
affectsModuleResolution: true,
isFilePath: true,
category: Diagnostics.Modules,
description: Diagnostics.Base_directory_to_resolve_non_absolute_module_names
description: Diagnostics.Specify_the_base_directory_to_resolve_non_relative_module_names
},
{
// this option can only be specified in tsconfig.json
@@ -739,7 +739,7 @@ namespace ts {
affectsModuleResolution: true,
isTSConfigOnly: true,
category: Diagnostics.Modules,
description: Diagnostics.A_series_of_entries_which_re_map_imports_to_lookup_locations_relative_to_the_baseUrl,
description: Diagnostics.Specify_a_set_of_entries_that_re_map_imports_to_additional_lookup_locations,
transpileOptionValue: undefined
},
{
@@ -755,7 +755,7 @@ namespace ts {
},
affectsModuleResolution: true,
category: Diagnostics.Modules,
description: Diagnostics.List_of_root_folders_whose_combined_content_represents_the_structure_of_the_project_at_runtime,
description: Diagnostics.Allow_multiple_folders_to_be_treated_as_one_when_resolving_modules,
transpileOptionValue: undefined
},
{
@@ -768,7 +768,7 @@ namespace ts {
},
affectsModuleResolution: true,
category: Diagnostics.Modules,
description: Diagnostics.List_of_folders_to_include_type_definitions_from
description: Diagnostics.Specify_multiple_folders_that_act_like_Slashnode_modules_Slash_types
},
{
name: "types",
@@ -780,7 +780,7 @@ namespace ts {
affectsProgramStructure: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Modules,
description: Diagnostics.Type_declaration_files_to_be_included_in_compilation,
description: Diagnostics.Specify_type_package_names_to_be_included_without_being_referenced_in_a_source_file,
transpileOptionValue: undefined
},
{
@@ -788,7 +788,7 @@ namespace ts {
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Interop_Constraints,
description: Diagnostics.Allow_default_imports_from_modules_with_no_default_export_This_does_not_affect_code_emit_just_typechecking
description: Diagnostics.Allow_import_x_from_y_when_a_module_doesn_t_have_a_default_export
},
{
name: "esModuleInterop",
@@ -797,13 +797,13 @@ namespace ts {
affectsEmit: true,
showInSimplifiedHelpView: true,
category: Diagnostics.Interop_Constraints,
description: Diagnostics.Enables_emit_interoperability_between_CommonJS_and_ES_Modules_via_creation_of_namespace_objects_for_all_imports_Implies_allowSyntheticDefaultImports
description: Diagnostics.Emit_additional_JavaScript_to_ease_support_for_importing_CommonJS_modules_This_enables_allowSyntheticDefaultImports_for_type_compatibility
},
{
name: "preserveSymlinks",
type: "boolean",
category: Diagnostics.Interop_Constraints,
description: Diagnostics.Do_not_resolve_the_real_path_of_symlinks,
description: Diagnostics.Disable_resolving_symlinks_to_their_realpath_This_correlates_to_the_same_flag_in_node,
},
{
name: "allowUmdGlobalAccess",
@@ -820,7 +820,7 @@ namespace ts {
affectsEmit: true,
paramType: Diagnostics.LOCATION,
category: Diagnostics.Emit,
description: Diagnostics.Specify_the_location_where_debugger_should_locate_TypeScript_files_instead_of_source_locations,
description: Diagnostics.Specify_the_root_path_for_debuggers_to_find_the_reference_source_code,
},
{
name: "mapRoot",
@@ -835,14 +835,14 @@ namespace ts {
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Emit_a_single_file_with_source_maps_instead_of_having_a_separate_file
description: Diagnostics.Include_sourcemap_files_inside_the_emitted_JavaScript
},
{
name: "inlineSources",
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Emit_the_source_alongside_the_sourcemaps_within_a_single_file_requires_inlineSourceMap_or_sourceMap_to_be_set
description: Diagnostics.Include_source_code_in_the_sourcemaps_inside_the_emitted_JavaScript
},
// Experimental
@@ -851,7 +851,7 @@ namespace ts {
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Enables_experimental_support_for_ES7_decorators
description: Diagnostics.Enable_experimental_support_for_TC39_stage_2_draft_decorators
},
{
name: "emitDecoratorMetadata",
@@ -859,7 +859,7 @@ namespace ts {
affectsSemanticDiagnostics: true,
affectsEmit: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Enables_experimental_support_for_emitting_type_metadata_for_decorators
description: Diagnostics.Emit_design_type_metadata_for_decorated_declarations_in_source_files
},
// Advanced
@@ -867,13 +867,13 @@ namespace ts {
name: "jsxFactory",
type: "string",
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Specify_the_JSX_factory_function_to_use_when_targeting_react_JSX_emit_e_g_React_createElement_or_h
description: Diagnostics.Specify_the_JSX_factory_function_used_when_targeting_React_JSX_emit_e_g_React_createElement_or_h
},
{
name: "jsxFragmentFactory",
type: "string",
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Specify_the_JSX_fragment_factory_function_to_use_when_targeting_react_JSX_emit_with_jsxFactory_compiler_option_is_specified_e_g_Fragment
description: Diagnostics.Specify_the_JSX_Fragment_reference_used_for_fragments_when_targeting_React_JSX_emit_e_g_React_Fragment_or_Fragment
},
{
name: "jsxImportSource",
@@ -882,14 +882,14 @@ namespace ts {
affectsEmit: true,
affectsModuleResolution: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Specify_the_module_specifier_to_be_used_to_import_the_jsx_and_jsxs_factory_functions_from_eg_react
description: Diagnostics.Specify_module_specifier_used_to_import_the_JSX_factory_functions_when_using_jsx_Colon_react_jsx_Asterisk
},
{
name: "resolveJsonModule",
type: "boolean",
affectsModuleResolution: true,
category: Diagnostics.Modules,
description: Diagnostics.Include_modules_imported_with_json_extension
description: Diagnostics.Enable_importing_json_files
},
{
@@ -900,7 +900,7 @@ namespace ts {
// for correct behaviour, please use outFile
category: Diagnostics.Backwards_Compatibility,
paramType: Diagnostics.FILE,
description: Diagnostics.Deprecated_Use_outFile_instead_Concatenate_and_emit_output_to_single_file,
description: Diagnostics.Deprecated_setting_Use_outFile_instead,
transpileOptionValue: undefined
},
{
@@ -908,19 +908,19 @@ namespace ts {
type: "string",
affectsEmit: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Deprecated_Use_jsxFactory_instead_Specify_the_object_invoked_for_createElement_when_targeting_react_JSX_emit
description: Diagnostics.Specify_the_object_invoked_for_createElement_This_only_applies_when_targeting_react_JSX_emit
},
{
name: "skipDefaultLibCheck",
type: "boolean",
category: Diagnostics.Completeness,
description: Diagnostics.Deprecated_Use_skipLibCheck_instead_Skip_type_checking_of_default_library_declaration_files
description: Diagnostics.Skip_type_checking_d_ts_files_that_are_included_with_TypeScript
},
{
name: "charset",
type: "string",
category: Diagnostics.Backwards_Compatibility,
description: Diagnostics.The_character_set_of_the_input_files
description: Diagnostics.No_longer_supported_In_early_versions_manually_set_the_text_encoding_for_reading_files
},
{
name: "emitBOM",
@@ -938,21 +938,21 @@ namespace ts {
affectsEmit: true,
paramType: Diagnostics.NEWLINE,
category: Diagnostics.Emit,
description: Diagnostics.Specify_the_end_of_line_sequence_to_be_used_when_emitting_files_Colon_CRLF_dos_or_LF_unix,
description: Diagnostics.Set_the_newline_character_for_emitting_files,
},
{
name: "noErrorTruncation",
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Output_Formatting,
description: Diagnostics.Do_not_truncate_error_messages
description: Diagnostics.Disable_truncating_types_in_error_messages
},
{
name: "noLib",
type: "boolean",
category: Diagnostics.Language_and_Environment,
affectsProgramStructure: true,
description: Diagnostics.Do_not_include_the_default_library_file_lib_d_ts,
description: Diagnostics.Disable_including_any_library_files_including_the_default_lib_d_ts,
// We are not returning a sourceFile for lib file when asked by the program,
// so pass --noLib to avoid reporting a file not found error.
transpileOptionValue: true
@@ -962,7 +962,7 @@ namespace ts {
type: "boolean",
affectsModuleResolution: true,
category: Diagnostics.Modules,
description: Diagnostics.Do_not_add_triple_slash_references_or_imported_modules_to_the_list_of_compiled_files,
description: Diagnostics.Disallow_import_s_require_s_or_reference_s_from_expanding_the_number_of_files_TypeScript_should_add_to_a_project,
// We are not doing a full typecheck, we are not resolving the whole context,
// so pass --noResolve to avoid reporting missing file errors.
transpileOptionValue: true
@@ -972,56 +972,56 @@ namespace ts {
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Do_not_emit_declarations_for_code_that_has_an_internal_annotation,
description: Diagnostics.Disable_emitting_declarations_that_have_internal_in_their_JSDoc_comments,
},
{
name: "disableSizeLimit",
type: "boolean",
affectsProgramStructure: true,
category: Diagnostics.Editor_Support,
description: Diagnostics.JavaScript_Support
description: Diagnostics.Remove_the_20mb_cap_on_total_source_code_size_for_JavaScript_files_in_the_TypeScript_language_server
},
{
name: "disableSourceOfProjectReferenceRedirect",
type: "boolean",
isTSConfigOnly: true,
category: Diagnostics.Projects,
description: Diagnostics.Disable_use_of_source_files_instead_of_declaration_files_from_referenced_projects
description: Diagnostics.Disable_preferring_source_files_instead_of_declaration_files_when_referencing_composite_projects
},
{
name: "disableSolutionSearching",
type: "boolean",
isTSConfigOnly: true,
category: Diagnostics.Projects,
description: Diagnostics.Projects
description: Diagnostics.Opt_a_project_out_of_multi_project_reference_checking_when_editing
},
{
name: "disableReferencedProjectLoad",
type: "boolean",
isTSConfigOnly: true,
category: Diagnostics.Projects,
description: Diagnostics.Disable_loading_referenced_projects
description: Diagnostics.Reduce_the_number_of_projects_loaded_automatically_by_TypeScript
},
{
name: "noImplicitUseStrict",
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Backwards_Compatibility,
description: Diagnostics.Do_not_emit_use_strict_directives_in_module_output
description: Diagnostics.Disable_adding_use_strict_directives_in_emitted_JavaScript_files
},
{
name: "noEmitHelpers",
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Do_not_generate_custom_helper_functions_like_extends_in_compiled_output
description: Diagnostics.Disable_generating_custom_helper_functions_like_extends_in_compiled_output
},
{
name: "noEmitOnError",
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Do_not_emit_outputs_if_any_errors_were_reported,
description: Diagnostics.Disable_emitting_files_if_any_type_checking_errors_are_reported,
transpileOptionValue: undefined
},
{
@@ -1029,7 +1029,7 @@ namespace ts {
type: "boolean",
affectsEmit: true,
category: Diagnostics.Emit,
description: Diagnostics.Do_not_erase_const_enum_declarations_in_generated_code
description: Diagnostics.Disable_erasing_const_enum_declarations_in_generated_code
},
{
name: "declarationDir",
@@ -1038,14 +1038,14 @@ namespace ts {
isFilePath: true,
paramType: Diagnostics.DIRECTORY,
category: Diagnostics.Emit,
description: Diagnostics.Output_directory_for_generated_declaration_files,
description: Diagnostics.Specify_the_output_directory_for_generated_declaration_files,
transpileOptionValue: undefined
},
{
name: "skipLibCheck",
type: "boolean",
category: Diagnostics.Completeness,
description: Diagnostics.Skip_type_checking_of_declaration_files,
description: Diagnostics.Skip_type_checking_all_d_ts_files,
},
{
name: "allowUnusedLabels",
@@ -1053,7 +1053,7 @@ namespace ts {
affectsBindDiagnostics: true,
affectsSemanticDiagnostics: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Do_not_report_errors_on_unused_labels
description: Diagnostics.Disable_error_reporting_for_unused_labels
},
{
name: "allowUnreachableCode",
@@ -1061,35 +1061,35 @@ namespace ts {
affectsBindDiagnostics: true,
affectsSemanticDiagnostics: true,
category: Diagnostics.Type_Checking,
description: Diagnostics.Do_not_report_errors_on_unreachable_code
description: Diagnostics.Disable_error_reporting_for_unreachable_code
},
{
name: "suppressExcessPropertyErrors",
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Backwards_Compatibility,
description: Diagnostics.Suppress_excess_property_checks_for_object_literals,
description: Diagnostics.Disable_reporting_of_excess_property_errors_during_the_creation_of_object_literals,
},
{
name: "suppressImplicitAnyIndexErrors",
type: "boolean",
affectsSemanticDiagnostics: true,
category: Diagnostics.Backwards_Compatibility,
description: Diagnostics.Suppress_noImplicitAny_errors_for_indexing_objects_lacking_index_signatures,
description: Diagnostics.Suppress_noImplicitAny_errors_when_indexing_objects_that_lack_index_signatures,
},
{
name: "forceConsistentCasingInFileNames",
type: "boolean",
affectsModuleResolution: true,
category: Diagnostics.Interop_Constraints,
description: Diagnostics.Disallow_inconsistently_cased_references_to_the_same_file
description: Diagnostics.Ensure_that_casing_is_correct_in_imports
},
{
name: "maxNodeModuleJsDepth",
type: "number",
affectsModuleResolution: true,
category: Diagnostics.JavaScript_Support,
description: Diagnostics.The_maximum_dependency_depth_to_search_under_node_modules_and_load_JavaScript_files
description: Diagnostics.Specify_the_maximum_folder_depth_used_for_checking_JavaScript_files_from_node_modules_Only_applicable_with_allowJs
},
{
name: "noStrictGenericChecks",
@@ -1104,14 +1104,14 @@ namespace ts {
affectsSemanticDiagnostics: true,
affectsEmit: true,
category: Diagnostics.Language_and_Environment,
description: Diagnostics.Emit_class_fields_with_Define_instead_of_Set,
description: Diagnostics.Emit_ECMAScript_standard_compliant_class_fields,
},
{
name: "keyofStringsOnly",
type: "boolean",
category: Diagnostics.Backwards_Compatibility,
description: Diagnostics.Resolve_keyof_to_string_valued_property_names_only_no_numbers_or_symbols,
description: Diagnostics.Make_keyof_only_return_strings_instead_of_string_numbers_or_symbols_Legacy_option,
},
{
// A list of plugins to load in the language service

485
src/compiler/diagnosticMessages.json
View File

@@ -1120,10 +1120,6 @@
"category": "Message",
"code": 1367
},
"Specify emit/checking behavior for imports that are only used for types": {
"category": "Message",
"code": 1368
},
"Did you mean '{0}'?": {
"category": "Message",
"code": 1369
@@ -4633,10 +4629,6 @@
"category": "Message",
"code": 6184
},
"Disable strict checking of generic signatures in function types.": {
"category": "Message",
"code": 6185
},
"Enable strict checking of function types.": {
"category": "Message",
"code": 6186
@@ -4805,10 +4797,6 @@
"category": "Message",
"code": 6227
},
"Synchronously call callbacks and update the state of directory watchers on platforms that don't support recursive watching natively.": {
"category": "Message",
"code": 6228
},
"Tag '{0}' expects at least '{1}' arguments, but the JSX factory '{2}' provides at most '{3}'.": {
"category": "Error",
"code": 6229
@@ -4936,7 +4924,6 @@
"category": "Message",
"code": 6302
},
"Composite projects may not disable declaration emit.": {
"category": "Error",
"code": 6304
@@ -5029,18 +5016,10 @@
"category": "Message",
"code": 6365
},
"Enable verbose logging": {
"category": "Message",
"code": 6366
},
"Show what would be built (or deleted, if specified with '--clean')": {
"category": "Message",
"code": 6367
},
"Build all projects, including those that appear to be up to date": {
"category": "Message",
"code": 6368
},
"Option '--build' must be the first command line argument.": {
"category": "Error",
"code": 6369
@@ -5194,17 +5173,465 @@
},
"Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.": {
"category": "Message",
"code": 6600
},
"Allow 'import x from y' when a module doesn't have a default export.": {
"category": "Message",
"code": 6601
},
"Allow accessing UMD globals from modules.": {
"category": "Message",
"code": 6602
},
"Disable error reporting for unreachable code.": {
"category": "Message",
"code": 6603
},
"Disable error reporting for unused labels.": {
"category": "Message",
"code": 6604
},
"Ensure 'use strict' is always emitted.": {
"category": "Message",
"code": 6605
},
"Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.": {
"category": "Message",
"code": 6606
},
"Specify the base directory to resolve non-relative module names.": {
"category": "Message",
"code": 6607
},
"No longer supported. In early versions, manually set the text encoding for reading files.": {
"category": "Message",
"code": 6608
},
"Enable error reporting in type-checked JavaScript files.": {
"category": "Message",
"code": 6609
},
"Enable constraints that allow a TypeScript project to be used with project references.": {
"category": "Message",
"code": 6611
},
"Generate .d.ts files from TypeScript and JavaScript files in your project.": {
"category": "Message",
"code": 6612
},
"Specify the output directory for generated declaration files.": {
"category": "Message",
"code": 6613
},
"Create sourcemaps for d.ts files.": {
"category": "Message",
"code": 6614
},
"Output compiler performance information after building.": {
"category": "Message",
"code": 6615
},
"Disables inference for type acquisition by looking at filenames in a project.": {
"category": "Message",
"code": 6616
},
"Reduce the number of projects loaded automatically by TypeScript.": {
"category": "Message",
"code": 6617
},
"Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.": {
"category": "Message",
"code": 6618
},
"Opt a project out of multi-project reference checking when editing.": {
"category": "Message",
"code": 6619
},
"Disable preferring source files instead of declaration files when referencing composite projects": {
"category": "Message",
"code": 6620
},
"Emit more compliant, but verbose and less performant JavaScript for iteration.": {
"category": "Message",
"code": 6621
},
"Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.": {
"category": "Message",
"code": 6622
},
"Only output d.ts files and not JavaScript files.": {
"category": "Message",
"code": 6623
},
"Emit design-type metadata for decorated declarations in source files.": {
"category": "Message",
"code": 6624
},
"Disable the type acquisition for JavaScript projects": {
"category": "Message",
"code": 6625
},
"Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.": {
"category": "Message",
"code": 6626
},
"Filters results from the `include` option.": {
"category": "Message",
"code": 6627
},
"Remove a list of directories from the watch process.": {
"category": "Message",
"code": 6628
},
"Remove a list of files from the watch mode's processing.": {
"category": "Message",
"code": 6629
},
"Enable experimental support for TC39 stage 2 draft decorators.": {
"category": "Message",
"code": 6630
},
"Print files read during the compilation including why it was included.": {
"category": "Message",
"code": 6631
},
"Output more detailed compiler performance information after building.": {
"category": "Message",
"code": 6632
},
"Specify one or more path or node module references to base configuration files from which settings are inherited.": {
"category": "Message",
"code": 6633
},
"Specify what approach the watcher should use if the system runs out of native file watchers.": {
"category": "Message",
"code": 6634
},
"Include a list of files. This does not support glob patterns, as opposed to `include`.": {
"category": "Message",
"code": 6635
},
"Build all projects, including those that appear to be up to date": {
"category": "Message",
"code": 6636
},
"Ensure that casing is correct in imports.": {
"category": "Message",
"code": 6637
},
"Emit a v8 CPU profile of the compiler run for debugging.": {
"category": "Message",
"code": 6638
},
"Allow importing helper functions from tslib once per project, instead of including them per-file.": {
"category": "Message",
"code": 6639
},
"Specify a list of glob patterns that match files to be included in compilation.": {
"category": "Message",
"code": 6641
},
"Save .tsbuildinfo files to allow for incremental compilation of projects.": {
"category": "Message",
"code": 6642
},
"Include sourcemap files inside the emitted JavaScript.": {
"category": "Message",
"code": 6643
},
"Include source code in the sourcemaps inside the emitted JavaScript.": {
"category": "Message",
"code": 6644
},
"Ensure that each file can be safely transpiled without relying on other imports.": {
"category": "Message",
"code": 6645
},
"Specify what JSX code is generated.": {
"category": "Message",
"code": 6646
},
"Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'": {
"category": "Message",
"code": 6647
},
"Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.": {
"category": "Message",
"code": 6648
},
"Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.`": {
"category": "Message",
"code": 6649
},
"Make keyof only return strings instead of string, numbers or symbols. Legacy option.": {
"category": "Message",
"code": 6650
},
"Specify a set of bundled library declaration files that describe the target runtime environment.": {
"category": "Message",
"code": 6651
},
"Print the names of emitted files after a compilation.": {
"category": "Message",
"code": 6652
},
"Print all of the files read during the compilation.": {
"category": "Message",
"code": 6653
},
"Set the language of the messaging from TypeScript. This does not affect emit.": {
"category": "Message",
"code": 6654
},
"Specify the location where debugger should locate map files instead of generated locations.": {
"category": "Message",
"code": 6655
},
"Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.": {
"category": "Message",
"code": 6656
},
"Specify what module code is generated.": {
"category": "Message",
"code": 6657
},
"Specify how TypeScript looks up a file from a given module specifier.": {
"category": "Message",
"code": 6658
},
"Set the newline character for emitting files.": {
"category": "Message",
"code": 6659
},
"Disable emitting file from a compilation.": {
"category": "Message",
"code": 6660
},
"Disable generating custom helper functions like `__extends` in compiled output.": {
"category": "Message",
"code": 6661
},
"Disable emitting files if any type checking errors are reported.": {
"category": "Message",
"code": 6662
},
"Disable truncating types in error messages.": {
"category": "Message",
"code": 6663
},
"Enable error reporting for fallthrough cases in switch statements.": {
"category": "Message",
"code": 6664
},
"Enable error reporting for expressions and declarations with an implied `any` type..": {
"category": "Message",
"code": 6665
},
"Ensure overriding members in derived classes are marked with an override modifier.": {
"category": "Message",
"code": 6666
},
"Enable error reporting for codepaths that do not explicitly return in a function.": {
"category": "Message",
"code": 6667
},
"Enable error reporting when `this` is given the type `any`.": {
"category": "Message",
"code": 6668
},
"Disable adding 'use strict' directives in emitted JavaScript files.": {
"category": "Message",
"code": 6669
},
"Disable including any library files, including the default lib.d.ts.": {
"category": "Message",
"code": 6670
},
"Enforces using indexed accessors for keys declared using an indexed type": {
"category": "Message",
"code": 6671
},
"Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.": {
"category": "Message",
"code": 6672
},
"Disable strict checking of generic signatures in function types.": {
"category": "Message",
"code": 6673
},
"Add `undefined` to a type when accessed using an index.": {
"category": "Message",
"code": 6674
},
"Enable error reporting when a local variables aren't read.": {
"category": "Message",
"code": 6675
},
"Raise an error when a function parameter isn't read": {
"category": "Message",
"code": 6676
},
"Deprecated setting. Use `outFile` instead.": {
"category": "Message",
"code": 6677
},
"Specify an output folder for all emitted files.": {
"category": "Message",
"code": 6678
},
"Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.": {
"category": "Message",
"code": 6679
},
"Specify a set of entries that re-map imports to additional lookup locations.": {
"category": "Message",
"code": 6680
},
"Specify a list of language service plugins to include.": {
"category": "Message",
"code": 6681
},
"Disable erasing `const enum` declarations in generated code.": {
"category": "Message",
"code": 6682
},
"Disable resolving symlinks to their realpath. This correlates to the same flag in node.": {
"category": "Message",
"code": 6683
},
"Disable wiping the console in watch mode": {
"category": "Message",
"code": 6684
},
"Enable color and formatting in output to make compiler errors easier to read": {
"category": "Message",
"code": 6685
},
"Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.": {
"category": "Message",
"code": 6686
},
"Specify an array of objects that specify paths for projects. Used in project references.": {
"category": "Message",
"code": 6687
},
"Disable emitting comments.": {
"category": "Message",
"code": 6688
},
"Enable importing .json files": {
"category": "Message",
"code": 6689
},
"Specify the root folder within your source files.": {
"category": "Message",
"code": 6690
},
"Allow multiple folders to be treated as one when resolving modules.": {
"category": "Message",
"code": 6691
},
"Skip type checking .d.ts files that are included with TypeScript.": {
"category": "Message",
"code": 6692
},
"Skip type checking all .d.ts files.": {
"category": "Message",
"code": 6693
},
"Create source map files for emitted JavaScript files.": {
"category": "Message",
"code": 6694
},
"Specify the root path for debuggers to find the reference source code.": {
"category": "Message",
"code": 6695
},
"Check that the arguments for `bind`, `call`, and `apply` methods match the original function.": {
"category": "Message",
"code": 6697
},
"When assigning functions, check to ensure parameters and the return values are subtype-compatible.": {
"category": "Message",
"code": 6698
},
"When type checking, take into account `null` and `undefined`.": {
"category": "Message",
"code": 6699
},
"Check for class properties that are declared but not set in the constructor.": {
"category": "Message",
"code": 6700
},
"Disable emitting declarations that have `@internal` in their JSDoc comments.": {
"category": "Message",
"code": 6701
},
"Disable reporting of excess property errors during the creation of object literals.": {
"category": "Message",
"code": 6702
},
"Suppress `noImplicitAny` errors when indexing objects that lack index signatures.": {
"category": "Message",
"code": 6703
},
"Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.": {
"category": "Message",
"code": 6704
},
"Set the JavaScript language version for emitted JavaScript and include compatible library declarations.": {
"category": "Message",
"code": 6705
},
"Log paths used during the `moduleResolution` process.": {
"category": "Message",
"code": 6706
},
"Specify the folder for .tsbuildinfo incremental compilation files.": {
"category": "Message",
"code": 6707
},
"Specify options for automatic acquisition of declaration files.": {
"category": "Message",
"code": 6709
},
"Specify multiple folders that act like `./node_modules/@types`.": {
"category": "Message",
"code": 6710
},
"Specify type package names to be included without being referenced in a source file.": {
"category": "Message",
"code": 6711
},
"Emit ECMAScript-standard-compliant class fields.": {
"category": "Message",
"code": 6712
},
"Enable verbose logging": {
"category": "Message",
"code": 6713
},
"Specify how directories are watched on systems that lack recursive file-watching functionality.": {
"category": "Message",
"code": 6714
},
"Specify how the TypeScript watch mode works.": {
"category": "Message",
"code": 6715
},
"Include 'undefined' in index signature results": {
"category": "Message",
"code": 6800
},
"Ensure overriding members in derived classes are marked with an 'override' modifier.": {
"category": "Message",
"code": 6801
"code": 6716
},
"Require undeclared properties from index signatures to use element accesses.": {
"category": "Message",
"code": 6802
"code": 6717
},
"Specify emit/checking behavior for imports that are only used for types": {
"category": "Message",
"code": 6718
},
"Type catch clause variables as 'unknown' instead of 'any'.": {
"category": "Message",
@@ -6148,10 +6575,6 @@
"category": "Message",
"code": 95075
},
"Allow accessing UMD globals from modules.": {
"category": "Message",
"code": 95076
},
"Extract type": {
"category": "Message",
"code": 95077