2022-01-07 22:09:52 -05:00
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
2020-08-31 14:12:24 -04:00
2020-11-16 14:48:50 -05:00
use crate ::fs_util ::canonicalize_path ;
2021-11-24 15:14:19 -05:00
use crate ::fs_util ::specifier_parent ;
use crate ::fs_util ::specifier_to_file_path ;
2021-11-08 20:26:39 -05:00
2021-11-16 09:02:28 -05:00
use deno_core ::anyhow ::anyhow ;
2021-11-24 15:14:19 -05:00
use deno_core ::anyhow ::bail ;
2021-11-16 09:02:28 -05:00
use deno_core ::anyhow ::Context ;
2021-11-08 20:26:39 -05:00
use deno_core ::error ::custom_error ;
2020-09-14 12:48:57 -04:00
use deno_core ::error ::AnyError ;
2021-02-25 15:18:35 -05:00
use deno_core ::serde ::Deserialize ;
use deno_core ::serde ::Serialize ;
use deno_core ::serde ::Serializer ;
2020-09-21 12:36:37 -04:00
use deno_core ::serde_json ;
2020-10-26 09:03:03 -04:00
use deno_core ::serde_json ::json ;
2020-09-21 12:36:37 -04:00
use deno_core ::serde_json ::Value ;
2021-10-10 17:26:22 -04:00
use deno_core ::ModuleSpecifier ;
2020-10-29 06:18:18 -04:00
use std ::collections ::BTreeMap ;
2020-08-31 14:12:24 -04:00
use std ::collections ::HashMap ;
use std ::fmt ;
2020-09-29 03:16:12 -04:00
use std ::path ::Path ;
2020-08-31 14:12:24 -04:00
2021-11-08 20:26:39 -05:00
pub ( crate ) type MaybeImportsResult =
Result < Option < Vec < ( ModuleSpecifier , Vec < String > ) > > , AnyError > ;
2020-09-29 03:16:12 -04:00
/// The transpile options that are significant out of a user provided tsconfig
/// file, that we want to deserialize out of the final config for a transpile.
#[ derive(Debug, Deserialize) ]
#[ serde(rename_all = " camelCase " ) ]
2020-10-19 23:10:42 -04:00
pub struct EmitConfigOptions {
2020-09-29 03:16:12 -04:00
pub check_js : bool ,
pub emit_decorator_metadata : bool ,
2021-03-07 15:40:11 -05:00
pub imports_not_used_as_values : String ,
2020-10-26 09:03:03 -04:00
pub inline_source_map : bool ,
2021-09-08 00:05:34 -04:00
pub inline_sources : bool ,
2021-05-19 00:18:01 -04:00
pub source_map : bool ,
2020-09-29 03:16:12 -04:00
pub jsx : String ,
pub jsx_factory : String ,
pub jsx_fragment_factory : String ,
2021-11-08 20:26:39 -05:00
pub jsx_import_source : Option < String > ,
2020-09-29 03:16:12 -04:00
}
2021-06-21 17:18:32 -04:00
/// There are certain compiler options that can impact what modules are part of
/// a module graph, which need to be deserialized into a structure for analysis.
#[ derive(Debug, Deserialize) ]
#[ serde(rename_all = " camelCase " ) ]
pub struct CompilerOptions {
2021-11-08 20:26:39 -05:00
pub jsx : Option < String > ,
pub jsx_import_source : Option < String > ,
2021-06-21 17:18:32 -04:00
pub types : Option < Vec < String > > ,
}
2020-09-29 03:16:12 -04:00
/// A structure that represents a set of options that were ignored and the
/// path those options came from.
#[ derive(Debug, Clone, PartialEq) ]
pub struct IgnoredCompilerOptions {
pub items : Vec < String > ,
2021-11-24 15:14:19 -05:00
pub maybe_specifier : Option < ModuleSpecifier > ,
2020-09-29 03:16:12 -04:00
}
2020-08-31 14:12:24 -04:00
impl fmt ::Display for IgnoredCompilerOptions {
fn fmt ( & self , f : & mut fmt ::Formatter ) -> fmt ::Result {
2020-09-29 03:16:12 -04:00
let mut codes = self . items . clone ( ) ;
2020-08-31 14:12:24 -04:00
codes . sort ( ) ;
2021-11-24 15:14:19 -05:00
if let Some ( specifier ) = & self . maybe_specifier {
write! ( f , " Unsupported compiler options in \" {} \" . \n The following options were ignored: \n {} " , specifier , codes . join ( " , " ) )
2020-10-26 09:03:03 -04:00
} else {
write! ( f , " Unsupported compiler options provided. \n The following options were ignored: \n {} " , codes . join ( " , " ) )
}
2020-08-31 14:12:24 -04:00
}
}
2020-12-31 16:43:54 -05:00
impl Serialize for IgnoredCompilerOptions {
fn serialize < S > ( & self , serializer : S ) -> Result < S ::Ok , S ::Error >
where
S : Serializer ,
{
Serialize ::serialize ( & self . items , serializer )
}
}
2020-08-31 14:12:24 -04:00
/// A static slice of all the compiler options that should be ignored that
/// either have no effect on the compilation or would cause the emit to not work
/// in Deno.
2020-12-07 05:46:39 -05:00
pub const IGNORED_COMPILER_OPTIONS : & [ & str ] = & [
2020-08-31 14:12:24 -04:00
" allowSyntheticDefaultImports " ,
2020-11-01 21:51:56 -05:00
" allowUmdGlobalAccess " ,
" baseUrl " ,
" declaration " ,
" declarationMap " ,
" downlevelIteration " ,
2020-10-26 09:03:03 -04:00
" esModuleInterop " ,
2020-11-01 21:51:56 -05:00
" emitDeclarationOnly " ,
" importHelpers " ,
2020-10-26 09:03:03 -04:00
" inlineSourceMap " ,
" inlineSources " ,
" module " ,
2020-11-01 21:51:56 -05:00
" noEmitHelpers " ,
2021-01-19 17:28:58 -05:00
" noErrorTruncation " ,
2020-10-26 09:03:03 -04:00
" noLib " ,
2020-11-01 21:51:56 -05:00
" noResolve " ,
" outDir " ,
" paths " ,
2020-10-26 09:03:03 -04:00
" preserveConstEnums " ,
" reactNamespace " ,
2021-12-15 13:22:36 -05:00
" resolveJsonModule " ,
2020-11-01 21:51:56 -05:00
" rootDir " ,
" rootDirs " ,
" skipLibCheck " ,
2020-10-26 09:03:03 -04:00
" sourceMap " ,
2020-11-01 21:51:56 -05:00
" sourceRoot " ,
2020-10-26 09:03:03 -04:00
" target " ,
2020-11-01 21:51:56 -05:00
" useDefineForClassFields " ,
2020-10-26 09:03:03 -04:00
] ;
2020-12-07 05:46:39 -05:00
pub const IGNORED_RUNTIME_COMPILER_OPTIONS : & [ & str ] = & [
2020-08-31 14:12:24 -04:00
" assumeChangesOnlyAffectDirectDependencies " ,
" build " ,
2020-11-01 21:51:56 -05:00
" charset " ,
2020-08-31 14:12:24 -04:00
" composite " ,
" diagnostics " ,
2020-11-01 21:51:56 -05:00
" disableSizeLimit " ,
2020-08-31 14:12:24 -04:00
" emitBOM " ,
" extendedDiagnostics " ,
" forceConsistentCasingInFileNames " ,
" generateCpuProfile " ,
" help " ,
" incremental " ,
" init " ,
2020-12-31 16:43:54 -05:00
" isolatedModules " ,
2020-08-31 14:12:24 -04:00
" listEmittedFiles " ,
" listFiles " ,
" mapRoot " ,
" maxNodeModuleJsDepth " ,
" moduleResolution " ,
" newLine " ,
" noEmit " ,
" noEmitOnError " ,
" out " ,
" outDir " ,
" outFile " ,
" preserveSymlinks " ,
" preserveWatchOutput " ,
" pretty " ,
2020-11-01 21:51:56 -05:00
" project " ,
2020-08-31 14:12:24 -04:00
" resolveJsonModule " ,
" showConfig " ,
" skipDefaultLibCheck " ,
" stripInternal " ,
" traceResolution " ,
" tsBuildInfoFile " ,
" typeRoots " ,
2021-04-10 17:56:40 -04:00
" useDefineForClassFields " ,
2020-08-31 14:12:24 -04:00
" version " ,
" watch " ,
] ;
/// A function that works like JavaScript's `Object.assign()`.
pub fn json_merge ( a : & mut Value , b : & Value ) {
match ( a , b ) {
( & mut Value ::Object ( ref mut a ) , & Value ::Object ( ref b ) ) = > {
for ( k , v ) in b {
json_merge ( a . entry ( k . clone ( ) ) . or_insert ( Value ::Null ) , v ) ;
}
}
( a , b ) = > {
* a = b . clone ( ) ;
}
}
}
2020-10-26 09:03:03 -04:00
fn parse_compiler_options (
compiler_options : & HashMap < String , Value > ,
2021-11-24 15:14:19 -05:00
maybe_specifier : Option < ModuleSpecifier > ,
2020-10-26 09:03:03 -04:00
is_runtime : bool ,
) -> Result < ( Value , Option < IgnoredCompilerOptions > ) , AnyError > {
let mut filtered : HashMap < String , Value > = HashMap ::new ( ) ;
let mut items : Vec < String > = Vec ::new ( ) ;
for ( key , value ) in compiler_options . iter ( ) {
let key = key . as_str ( ) ;
if ( ! is_runtime & & IGNORED_COMPILER_OPTIONS . contains ( & key ) )
| | IGNORED_RUNTIME_COMPILER_OPTIONS . contains ( & key )
{
items . push ( key . to_string ( ) ) ;
} else {
filtered . insert ( key . to_string ( ) , value . to_owned ( ) ) ;
}
}
let value = serde_json ::to_value ( filtered ) ? ;
let maybe_ignored_options = if ! items . is_empty ( ) {
2021-11-24 15:14:19 -05:00
Some ( IgnoredCompilerOptions {
items ,
maybe_specifier ,
} )
2020-10-26 09:03:03 -04:00
} else {
None
} ;
Ok ( ( value , maybe_ignored_options ) )
}
2020-09-29 03:16:12 -04:00
/// A structure for managing the configuration of TypeScript
#[ derive(Debug, Clone) ]
2020-10-19 23:10:42 -04:00
pub struct TsConfig ( pub Value ) ;
2020-09-29 03:16:12 -04:00
impl TsConfig {
/// Create a new `TsConfig` with the base being the `value` supplied.
pub fn new ( value : Value ) -> Self {
TsConfig ( value )
}
2020-09-30 07:46:42 -04:00
pub fn as_bytes ( & self ) -> Vec < u8 > {
2020-10-29 06:18:18 -04:00
let map = self . 0. as_object ( ) . unwrap ( ) ;
let ordered : BTreeMap < _ , _ > = map . iter ( ) . collect ( ) ;
let value = json! ( ordered ) ;
value . to_string ( ) . as_bytes ( ) . to_owned ( )
2020-09-30 07:46:42 -04:00
}
2020-10-22 20:50:15 -04:00
/// Return the value of the `checkJs` compiler option, defaulting to `false`
/// if not present.
pub fn get_check_js ( & self ) -> bool {
if let Some ( check_js ) = self . 0. get ( " checkJs " ) {
check_js . as_bool ( ) . unwrap_or ( false )
} else {
false
}
}
2020-12-31 16:43:54 -05:00
pub fn get_declaration ( & self ) -> bool {
if let Some ( declaration ) = self . 0. get ( " declaration " ) {
declaration . as_bool ( ) . unwrap_or ( false )
} else {
false
}
}
2020-10-22 20:50:15 -04:00
/// Merge a serde_json value into the configuration.
pub fn merge ( & mut self , value : & Value ) {
json_merge ( & mut self . 0 , value ) ;
}
2021-05-10 12:16:39 -04:00
/// Take an optional user provided config file
/// which was passed in via the `--config` flag and merge `compilerOptions` with
2020-09-29 03:16:12 -04:00
/// the configuration. Returning the result which optionally contains any
/// compiler options that were ignored.
2021-05-10 12:16:39 -04:00
pub fn merge_tsconfig_from_config_file (
2020-09-29 03:16:12 -04:00
& mut self ,
2021-05-10 12:16:39 -04:00
maybe_config_file : Option < & ConfigFile > ,
2020-09-29 03:16:12 -04:00
) -> Result < Option < IgnoredCompilerOptions > , AnyError > {
2021-05-10 12:16:39 -04:00
if let Some ( config_file ) = maybe_config_file {
2021-09-03 11:01:58 -04:00
let ( value , maybe_ignored_options ) = config_file . to_compiler_options ( ) ? ;
2021-05-10 12:16:39 -04:00
self . merge ( & value ) ;
2020-09-29 03:16:12 -04:00
Ok ( maybe_ignored_options )
} else {
Ok ( None )
}
}
2020-10-26 09:03:03 -04:00
/// Take a map of compiler options, filtering out any that are ignored, then
/// merge it with the current configuration, returning any options that might
/// have been ignored.
pub fn merge_user_config (
& mut self ,
user_options : & HashMap < String , Value > ,
) -> Result < Option < IgnoredCompilerOptions > , AnyError > {
let ( value , maybe_ignored_options ) =
parse_compiler_options ( user_options , None , true ) ? ;
2021-05-10 12:16:39 -04:00
self . merge ( & value ) ;
2020-10-26 09:03:03 -04:00
Ok ( maybe_ignored_options )
}
2020-09-29 03:16:12 -04:00
}
impl Serialize for TsConfig {
/// Serializes inner hash map which is ordered by the key
fn serialize < S > ( & self , serializer : S ) -> std ::result ::Result < S ::Ok , S ::Error >
where
S : Serializer ,
{
Serialize ::serialize ( & self . 0 , serializer )
}
}
2021-09-03 11:01:58 -04:00
#[ derive(Clone, Debug, Default, Deserialize) ]
#[ serde(default, deny_unknown_fields) ]
pub struct LintRulesConfig {
pub tags : Option < Vec < String > > ,
pub include : Option < Vec < String > > ,
pub exclude : Option < Vec < String > > ,
}
#[ derive(Clone, Debug, Default, Deserialize) ]
#[ serde(default, deny_unknown_fields) ]
2021-11-23 10:38:11 -05:00
struct SerializedFilesConfig {
2021-09-03 11:01:58 -04:00
pub include : Vec < String > ,
pub exclude : Vec < String > ,
}
2021-11-23 10:38:11 -05:00
impl SerializedFilesConfig {
2021-11-24 15:14:19 -05:00
pub fn into_resolved (
self ,
config_file_specifier : & ModuleSpecifier ,
) -> Result < FilesConfig , AnyError > {
let config_dir = specifier_parent ( config_file_specifier ) ;
Ok ( FilesConfig {
2021-11-23 10:38:11 -05:00
include : self
. include
. into_iter ( )
2021-11-24 15:14:19 -05:00
. map ( | p | config_dir . join ( & p ) )
. collect ::< Result < Vec < ModuleSpecifier > , _ > > ( ) ? ,
2021-11-23 10:38:11 -05:00
exclude : self
. exclude
. into_iter ( )
2021-11-24 15:14:19 -05:00
. map ( | p | config_dir . join ( & p ) )
. collect ::< Result < Vec < ModuleSpecifier > , _ > > ( ) ? ,
} )
2021-11-23 10:38:11 -05:00
}
}
#[ derive(Clone, Debug, Default) ]
pub struct FilesConfig {
2021-11-24 15:14:19 -05:00
pub include : Vec < ModuleSpecifier > ,
pub exclude : Vec < ModuleSpecifier > ,
}
impl FilesConfig {
/// Gets if the provided specifier is allowed based on the includes
/// and excludes in the configuration file.
pub fn matches_specifier ( & self , specifier : & ModuleSpecifier ) -> bool {
// Skip files which is in the exclude list.
let specifier_text = specifier . as_str ( ) ;
if self
. exclude
. iter ( )
. any ( | i | specifier_text . starts_with ( i . as_str ( ) ) )
{
return false ;
}
// Ignore files not in the include list if it's not empty.
self . include . is_empty ( )
| | self
. include
. iter ( )
. any ( | i | specifier_text . starts_with ( i . as_str ( ) ) )
}
2021-11-23 10:38:11 -05:00
}
2021-09-03 11:01:58 -04:00
#[ derive(Clone, Debug, Default, Deserialize) ]
#[ serde(default, deny_unknown_fields) ]
2021-11-23 10:38:11 -05:00
struct SerializedLintConfig {
pub rules : LintRulesConfig ,
pub files : SerializedFilesConfig ,
}
impl SerializedLintConfig {
2021-11-24 15:14:19 -05:00
pub fn into_resolved (
self ,
config_file_specifier : & ModuleSpecifier ,
) -> Result < LintConfig , AnyError > {
Ok ( LintConfig {
2021-11-23 10:38:11 -05:00
rules : self . rules ,
2021-11-24 15:14:19 -05:00
files : self . files . into_resolved ( config_file_specifier ) ? ,
} )
2021-11-23 10:38:11 -05:00
}
}
#[ derive(Clone, Debug, Default) ]
2021-09-03 11:01:58 -04:00
pub struct LintConfig {
pub rules : LintRulesConfig ,
2021-09-13 14:19:10 -04:00
pub files : FilesConfig ,
}
#[ derive(Clone, Copy, Debug, Deserialize) ]
#[ serde(deny_unknown_fields, rename_all = " camelCase " ) ]
pub enum ProseWrap {
Always ,
Never ,
Preserve ,
}
#[ derive(Clone, Debug, Default, Deserialize) ]
#[ serde(default, deny_unknown_fields, rename_all = " camelCase " ) ]
pub struct FmtOptionsConfig {
pub use_tabs : Option < bool > ,
pub line_width : Option < u32 > ,
pub indent_width : Option < u8 > ,
pub single_quote : Option < bool > ,
pub prose_wrap : Option < ProseWrap > ,
}
#[ derive(Clone, Debug, Default, Deserialize) ]
#[ serde(default, deny_unknown_fields) ]
2021-11-23 10:38:11 -05:00
struct SerializedFmtConfig {
pub options : FmtOptionsConfig ,
pub files : SerializedFilesConfig ,
}
impl SerializedFmtConfig {
2021-11-24 15:14:19 -05:00
pub fn into_resolved (
self ,
config_file_specifier : & ModuleSpecifier ,
) -> Result < FmtConfig , AnyError > {
Ok ( FmtConfig {
2021-11-23 10:38:11 -05:00
options : self . options ,
2021-11-24 15:14:19 -05:00
files : self . files . into_resolved ( config_file_specifier ) ? ,
} )
2021-11-23 10:38:11 -05:00
}
}
#[ derive(Clone, Debug, Default) ]
2021-09-13 14:19:10 -04:00
pub struct FmtConfig {
pub options : FmtOptionsConfig ,
pub files : FilesConfig ,
2021-09-03 11:01:58 -04:00
}
2021-05-10 12:16:39 -04:00
#[ derive(Clone, Debug, Deserialize) ]
#[ serde(rename_all = " camelCase " ) ]
pub struct ConfigFileJson {
pub compiler_options : Option < Value > ,
2021-09-03 11:01:58 -04:00
pub lint : Option < Value > ,
2021-09-13 14:19:10 -04:00
pub fmt : Option < Value > ,
2021-05-10 12:16:39 -04:00
}
#[ derive(Clone, Debug) ]
pub struct ConfigFile {
2021-11-24 15:14:19 -05:00
pub specifier : ModuleSpecifier ,
2021-05-10 12:16:39 -04:00
pub json : ConfigFileJson ,
}
impl ConfigFile {
2021-08-11 10:20:47 -04:00
pub fn read ( path_ref : impl AsRef < Path > ) -> Result < Self , AnyError > {
let path = Path ::new ( path_ref . as_ref ( ) ) ;
2021-05-13 17:56:30 -04:00
let config_file = if path . is_absolute ( ) {
path . to_path_buf ( )
} else {
2021-08-11 10:20:47 -04:00
std ::env ::current_dir ( ) ? . join ( path_ref )
2021-05-13 17:56:30 -04:00
} ;
2021-05-10 12:16:39 -04:00
let config_path = canonicalize_path ( & config_file ) . map_err ( | _ | {
std ::io ::Error ::new (
std ::io ::ErrorKind ::InvalidInput ,
format! (
" Could not find the config file: {} " ,
config_file . to_string_lossy ( )
) ,
)
} ) ? ;
2021-11-24 15:14:19 -05:00
let config_specifier = ModuleSpecifier ::from_file_path ( & config_path )
. map_err ( | _ | {
anyhow! (
" Could not convert path to specifier. Path: {} " ,
config_path . display ( )
)
} ) ? ;
Self ::from_specifier ( & config_specifier )
}
pub fn from_specifier ( specifier : & ModuleSpecifier ) -> Result < Self , AnyError > {
let config_path = specifier_to_file_path ( specifier ) ? ;
let config_text = match std ::fs ::read_to_string ( & config_path ) {
Ok ( text ) = > text ,
Err ( err ) = > bail! (
" Error reading config file {}: {} " ,
specifier ,
err . to_string ( )
) ,
} ;
Self ::new ( & config_text , specifier )
2021-05-10 12:16:39 -04:00
}
2021-11-24 15:14:19 -05:00
pub fn new (
text : & str ,
specifier : & ModuleSpecifier ,
) -> Result < Self , AnyError > {
2021-05-27 02:33:33 -04:00
let jsonc = match jsonc_parser ::parse_to_serde_value ( text ) {
Ok ( None ) = > json! ( { } ) ,
Ok ( Some ( value ) ) if value . is_object ( ) = > value ,
Ok ( Some ( _ ) ) = > {
return Err ( anyhow! (
" config file JSON {:?} should be an object " ,
2021-11-24 15:14:19 -05:00
specifier ,
2021-05-27 02:33:33 -04:00
) )
}
Err ( e ) = > {
return Err ( anyhow! (
" Unable to parse config file JSON {:?} because of {} " ,
2021-11-24 15:14:19 -05:00
specifier ,
2021-05-27 02:33:33 -04:00
e . to_string ( )
) )
}
} ;
2021-05-10 12:16:39 -04:00
let json : ConfigFileJson = serde_json ::from_value ( jsonc ) ? ;
Ok ( Self {
2021-11-24 15:14:19 -05:00
specifier : specifier . to_owned ( ) ,
2021-05-10 12:16:39 -04:00
json ,
} )
}
2021-12-22 08:25:06 -05:00
/// Returns true if the configuration indicates that JavaScript should be
/// type checked, otherwise false.
pub fn get_check_js ( & self ) -> bool {
self
. json
. compiler_options
. as_ref ( )
. map ( | co | co . get ( " checkJs " ) . map ( | v | v . as_bool ( ) ) . flatten ( ) )
. flatten ( )
. unwrap_or ( false )
}
2021-05-10 12:16:39 -04:00
/// Parse `compilerOptions` and return a serde `Value`.
/// The result also contains any options that were ignored.
2021-09-03 11:01:58 -04:00
pub fn to_compiler_options (
2021-05-10 12:16:39 -04:00
& self ,
) -> Result < ( Value , Option < IgnoredCompilerOptions > ) , AnyError > {
if let Some ( compiler_options ) = self . json . compiler_options . clone ( ) {
let options : HashMap < String , Value > =
serde_json ::from_value ( compiler_options )
. context ( " compilerOptions should be an object " ) ? ;
2021-11-24 15:14:19 -05:00
parse_compiler_options ( & options , Some ( self . specifier . to_owned ( ) ) , false )
2021-05-10 12:16:39 -04:00
} else {
Ok ( ( json! ( { } ) , None ) )
}
}
2021-09-03 11:01:58 -04:00
pub fn to_lint_config ( & self ) -> Result < Option < LintConfig > , AnyError > {
if let Some ( config ) = self . json . lint . clone ( ) {
2021-11-23 10:38:11 -05:00
let lint_config : SerializedLintConfig = serde_json ::from_value ( config )
2021-09-03 11:01:58 -04:00
. context ( " Failed to parse \" lint \" configuration " ) ? ;
2021-11-24 15:14:19 -05:00
Ok ( Some ( lint_config . into_resolved ( & self . specifier ) ? ) )
2021-09-03 11:01:58 -04:00
} else {
Ok ( None )
}
}
2021-09-13 14:19:10 -04:00
2021-10-10 17:26:22 -04:00
/// If the configuration file contains "extra" modules (like TypeScript
/// `"types"`) options, return them as imports to be added to a module graph.
2021-11-08 20:26:39 -05:00
pub fn to_maybe_imports ( & self ) -> MaybeImportsResult {
let mut imports = Vec ::new ( ) ;
let compiler_options_value =
if let Some ( value ) = self . json . compiler_options . as_ref ( ) {
value
} else {
return Ok ( None ) ;
} ;
let compiler_options : CompilerOptions =
serde_json ::from_value ( compiler_options_value . clone ( ) ) ? ;
if let Some ( types ) = compiler_options . types {
imports . extend ( types ) ;
}
if compiler_options . jsx = = Some ( " react-jsx " . to_string ( ) ) {
imports . push ( format! (
" {}/jsx-runtime " ,
compiler_options . jsx_import_source . ok_or_else ( | | custom_error ( " TypeError " , " Compiler option 'jsx' set to 'react-jsx', but no 'jsxImportSource' defined. " ) ) ?
) ) ;
} else if compiler_options . jsx = = Some ( " react-jsxdev " . to_string ( ) ) {
imports . push ( format! (
" {}/jsx-dev-runtime " ,
compiler_options . jsx_import_source . ok_or_else ( | | custom_error ( " TypeError " , " Compiler option 'jsx' set to 'react-jsxdev', but no 'jsxImportSource' defined. " ) ) ?
) ) ;
}
if ! imports . is_empty ( ) {
2021-11-24 15:14:19 -05:00
let referrer = self . specifier . clone ( ) ;
2021-11-08 20:26:39 -05:00
Ok ( Some ( vec! [ ( referrer , imports ) ] ) )
} else {
Ok ( None )
}
}
/// Based on the compiler options in the configuration file, return the
/// implied JSX import source module.
pub fn to_maybe_jsx_import_source_module ( & self ) -> Option < String > {
2021-10-10 17:26:22 -04:00
let compiler_options_value = self . json . compiler_options . as_ref ( ) ? ;
let compiler_options : CompilerOptions =
serde_json ::from_value ( compiler_options_value . clone ( ) ) . ok ( ) ? ;
2021-11-08 20:26:39 -05:00
match compiler_options . jsx . as_deref ( ) {
Some ( " react-jsx " ) = > Some ( " jsx-runtime " . to_string ( ) ) ,
Some ( " react-jsxdev " ) = > Some ( " jsx-dev-runtime " . to_string ( ) ) ,
_ = > None ,
}
2021-10-10 17:26:22 -04:00
}
2021-09-13 14:19:10 -04:00
pub fn to_fmt_config ( & self ) -> Result < Option < FmtConfig > , AnyError > {
if let Some ( config ) = self . json . fmt . clone ( ) {
2021-11-23 10:38:11 -05:00
let fmt_config : SerializedFmtConfig = serde_json ::from_value ( config )
2021-09-13 14:19:10 -04:00
. context ( " Failed to parse \" fmt \" configuration " ) ? ;
2021-11-24 15:14:19 -05:00
Ok ( Some ( fmt_config . into_resolved ( & self . specifier ) ? ) )
2021-09-13 14:19:10 -04:00
} else {
Ok ( None )
}
}
2021-05-10 12:16:39 -04:00
}
2020-08-31 14:12:24 -04:00
#[ cfg(test) ]
mod tests {
use super ::* ;
2020-09-21 12:36:37 -04:00
use deno_core ::serde_json ::json ;
2020-08-31 14:12:24 -04:00
2021-05-10 12:16:39 -04:00
#[ test ]
2021-05-13 17:56:30 -04:00
fn read_config_file_relative ( ) {
2021-08-11 10:20:47 -04:00
let config_file =
ConfigFile ::read ( " tests/testdata/module_graph/tsconfig.json " )
. expect ( " Failed to load config file " ) ;
2021-05-10 12:16:39 -04:00
assert! ( config_file . json . compiler_options . is_some ( ) ) ;
}
2021-05-13 17:56:30 -04:00
#[ test ]
fn read_config_file_absolute ( ) {
2021-08-11 10:20:47 -04:00
let path = test_util ::testdata_path ( ) . join ( " module_graph/tsconfig.json " ) ;
2021-05-13 17:56:30 -04:00
let config_file = ConfigFile ::read ( path . to_str ( ) . unwrap ( ) )
. expect ( " Failed to load config file " ) ;
assert! ( config_file . json . compiler_options . is_some ( ) ) ;
}
2021-05-18 16:48:11 -04:00
#[ test ]
fn include_config_path_on_error ( ) {
let error = ConfigFile ::read ( " 404.json " ) . err ( ) . unwrap ( ) ;
assert! ( error . to_string ( ) . contains ( " 404.json " ) ) ;
}
2020-08-31 14:12:24 -04:00
#[ test ]
fn test_json_merge ( ) {
let mut value_a = json! ( {
" a " : true ,
" b " : " c "
} ) ;
let value_b = json! ( {
" b " : " d " ,
" e " : false ,
} ) ;
json_merge ( & mut value_a , & value_b ) ;
assert_eq! (
value_a ,
json! ( {
" a " : true ,
" b " : " d " ,
" e " : false ,
} )
) ;
}
#[ test ]
fn test_parse_config ( ) {
let config_text = r #" {
" compilerOptions " : {
" build " : true ,
// comments are allowed
" strict " : true
2021-09-03 11:01:58 -04:00
} ,
" lint " : {
" files " : {
" include " : [ " src/ " ] ,
" exclude " : [ " src/testdata/ " ]
} ,
" rules " : {
" tags " : [ " recommended " ] ,
" include " : [ " ban-untagged-todo " ]
}
2021-09-13 14:19:10 -04:00
} ,
" fmt " : {
" files " : {
" include " : [ " src/ " ] ,
" exclude " : [ " src/testdata/ " ]
} ,
" options " : {
" useTabs " : true ,
" lineWidth " : 80 ,
" indentWidth " : 4 ,
" singleQuote " : true ,
" proseWrap " : " preserve "
}
2020-08-31 14:12:24 -04:00
}
} " #;
2021-11-24 15:14:19 -05:00
let config_dir = ModuleSpecifier ::parse ( " file:///deno/ " ) . unwrap ( ) ;
let config_specifier = config_dir . join ( " tsconfig.json " ) . unwrap ( ) ;
let config_file = ConfigFile ::new ( config_text , & config_specifier ) . unwrap ( ) ;
2020-08-31 14:12:24 -04:00
let ( options_value , ignored ) =
2021-09-03 11:01:58 -04:00
config_file . to_compiler_options ( ) . expect ( " error parsing " ) ;
2020-08-31 14:12:24 -04:00
assert! ( options_value . is_object ( ) ) ;
let options = options_value . as_object ( ) . unwrap ( ) ;
assert! ( options . contains_key ( " strict " ) ) ;
assert_eq! ( options . len ( ) , 1 ) ;
assert_eq! (
ignored ,
2020-09-29 03:16:12 -04:00
Some ( IgnoredCompilerOptions {
items : vec ! [ " build " . to_string ( ) ] ,
2021-11-24 15:14:19 -05:00
maybe_specifier : Some ( config_specifier ) ,
2020-09-29 03:16:12 -04:00
} ) ,
2020-08-31 14:12:24 -04:00
) ;
2021-09-03 11:01:58 -04:00
let lint_config = config_file
. to_lint_config ( )
. expect ( " error parsing lint object " )
. expect ( " lint object should be defined " ) ;
2021-11-24 15:14:19 -05:00
assert_eq! (
lint_config . files . include ,
vec! [ config_dir . join ( " src/ " ) . unwrap ( ) ]
) ;
2021-11-23 10:38:11 -05:00
assert_eq! (
lint_config . files . exclude ,
2021-11-24 15:14:19 -05:00
vec! [ config_dir . join ( " src/testdata/ " ) . unwrap ( ) ]
2021-11-23 10:38:11 -05:00
) ;
2021-09-03 11:01:58 -04:00
assert_eq! (
lint_config . rules . include ,
Some ( vec! [ " ban-untagged-todo " . to_string ( ) ] )
) ;
assert_eq! (
lint_config . rules . tags ,
Some ( vec! [ " recommended " . to_string ( ) ] )
) ;
assert! ( lint_config . rules . exclude . is_none ( ) ) ;
2021-09-13 14:19:10 -04:00
let fmt_config = config_file
. to_fmt_config ( )
. expect ( " error parsing fmt object " )
. expect ( " fmt object should be defined " ) ;
2021-11-24 15:14:19 -05:00
assert_eq! (
fmt_config . files . include ,
vec! [ config_dir . join ( " src/ " ) . unwrap ( ) ]
) ;
2021-11-23 10:38:11 -05:00
assert_eq! (
fmt_config . files . exclude ,
2021-11-24 15:14:19 -05:00
vec! [ config_dir . join ( " src/testdata/ " ) . unwrap ( ) ]
2021-11-23 10:38:11 -05:00
) ;
2021-09-13 14:19:10 -04:00
assert_eq! ( fmt_config . options . use_tabs , Some ( true ) ) ;
assert_eq! ( fmt_config . options . line_width , Some ( 80 ) ) ;
assert_eq! ( fmt_config . options . indent_width , Some ( 4 ) ) ;
assert_eq! ( fmt_config . options . single_quote , Some ( true ) ) ;
2020-08-31 14:12:24 -04:00
}
2021-05-27 02:33:33 -04:00
#[ test ]
fn test_parse_config_with_empty_file ( ) {
let config_text = " " ;
2021-11-24 15:14:19 -05:00
let config_specifier =
ModuleSpecifier ::parse ( " file:///deno/tsconfig.json " ) . unwrap ( ) ;
let config_file = ConfigFile ::new ( config_text , & config_specifier ) . unwrap ( ) ;
2021-05-27 02:33:33 -04:00
let ( options_value , _ ) =
2021-09-03 11:01:58 -04:00
config_file . to_compiler_options ( ) . expect ( " error parsing " ) ;
2021-05-27 02:33:33 -04:00
assert! ( options_value . is_object ( ) ) ;
}
#[ test ]
fn test_parse_config_with_commented_file ( ) {
let config_text = r # "//{"foo":"bar"}"# ;
2021-11-24 15:14:19 -05:00
let config_specifier =
ModuleSpecifier ::parse ( " file:///deno/tsconfig.json " ) . unwrap ( ) ;
let config_file = ConfigFile ::new ( config_text , & config_specifier ) . unwrap ( ) ;
2021-05-27 02:33:33 -04:00
let ( options_value , _ ) =
2021-09-03 11:01:58 -04:00
config_file . to_compiler_options ( ) . expect ( " error parsing " ) ;
2021-05-27 02:33:33 -04:00
assert! ( options_value . is_object ( ) ) ;
}
#[ test ]
fn test_parse_config_with_invalid_file ( ) {
let config_text = " {foo:bar} " ;
2021-11-24 15:14:19 -05:00
let config_specifier =
ModuleSpecifier ::parse ( " file:///deno/tsconfig.json " ) . unwrap ( ) ;
2021-05-27 02:33:33 -04:00
// Emit error: Unable to parse config file JSON "<config_path>" because of Unexpected token on line 1 column 6.
2021-11-24 15:14:19 -05:00
assert! ( ConfigFile ::new ( config_text , & config_specifier ) . is_err ( ) ) ;
2021-05-27 02:33:33 -04:00
}
#[ test ]
fn test_parse_config_with_not_object_file ( ) {
let config_text = " [] " ;
2021-11-24 15:14:19 -05:00
let config_specifier =
ModuleSpecifier ::parse ( " file:///deno/tsconfig.json " ) . unwrap ( ) ;
2021-05-27 02:33:33 -04:00
// Emit error: config file JSON "<config_path>" should be an object
2021-11-24 15:14:19 -05:00
assert! ( ConfigFile ::new ( config_text , & config_specifier ) . is_err ( ) ) ;
2021-05-27 02:33:33 -04:00
}
2020-10-26 09:03:03 -04:00
#[ test ]
fn test_tsconfig_merge_user_options ( ) {
let mut tsconfig = TsConfig ::new ( json! ( {
" target " : " esnext " ,
" module " : " esnext " ,
} ) ) ;
let user_options = serde_json ::from_value ( json! ( {
" target " : " es6 " ,
" build " : true ,
" strict " : false ,
} ) )
. expect ( " could not convert to hashmap " ) ;
let maybe_ignored_options = tsconfig
. merge_user_config ( & user_options )
. expect ( " could not merge options " ) ;
assert_eq! (
tsconfig . 0 ,
json! ( {
" module " : " esnext " ,
" target " : " es6 " ,
" strict " : false ,
} )
) ;
assert_eq! (
maybe_ignored_options ,
Some ( IgnoredCompilerOptions {
items : vec ! [ " build " . to_string ( ) ] ,
2021-11-24 15:14:19 -05:00
maybe_specifier : None
2020-10-26 09:03:03 -04:00
} )
) ;
}
2020-10-29 06:18:18 -04:00
#[ test ]
fn test_tsconfig_as_bytes ( ) {
let mut tsconfig1 = TsConfig ::new ( json! ( {
" strict " : true ,
" target " : " esnext " ,
} ) ) ;
tsconfig1 . merge ( & json! ( {
" target " : " es5 " ,
" module " : " amd " ,
} ) ) ;
let mut tsconfig2 = TsConfig ::new ( json! ( {
" target " : " esnext " ,
" strict " : true ,
} ) ) ;
tsconfig2 . merge ( & json! ( {
" module " : " amd " ,
" target " : " es5 " ,
} ) ) ;
assert_eq! ( tsconfig1 . as_bytes ( ) , tsconfig2 . as_bytes ( ) ) ;
}
2020-08-31 14:12:24 -04:00
}