Investigate the use of readConfigFile() and friends

Its documentation states that it reads tsconfig.json files
It appears to have the same functionality and level of abstraction as readJsonConfigFile()
The function is not marked with /* internal */ despite it lacking consumer-level documentation

TypeScript/src/compiler/commandLineParser.ts

Lines 1657 to 1664 in 147d721

    
               /** 
        
                * Read tsconfig.json file 
        
                * @param fileName The path to the config file 
        
                */ 
        
               export function readConfigFile(fileName: string, readFile: (path: string) => string | undefined): { config?: any; error?: Diagnostic } { 
        
                   const textOrDiagnostic = tryReadFile(fileName, readFile); 
        
                   return isString(textOrDiagnostic) ? parseConfigFileTextToJson(fileName, textOrDiagnostic) : { config: {}, error: textOrDiagnostic }; 
        
               }

In at least one area, it's used in a manner contradictory of its own documentation (see PackageJson)

TypeScript/src/jsTyping/jsTyping.ts

Line 210 in 147d721

    
           const jsonConfig: PackageJson = readConfigFile(jsonPath, path => host.readFile(path)).config;

The related parseJsonConfigFileContent() appears to only be used for testing but is not marked as internal

This is more of a set of observations than a bug report. Since these are now public APIs, I'm not sure what you'd like to see happen here -- at best, we could break some consumers. The documentation comments could be a bit better but the same is true of every comment 😉

This is certainly more of an observation than anything. I suppose the goal of this was to have a clear understanding of that area in order to update the documentation accordingly.

This issue has been marked as 'Not a Defect' and has seen no recent activity. It has been automatically closed for house-keeping purposes.

Navigation Menu

Repository navigation

Investigate the use of `readConfigFile()` and friends #44516

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	/**
	* Read tsconfig.json file
	* @param fileName The path to the config file
	*/
	export function readConfigFile(fileName: string, readFile: (path: string) => string \| undefined): { config?: any; error?: Diagnostic } {
	const textOrDiagnostic = tryReadFile(fileName, readFile);
	return isString(textOrDiagnostic) ? parseConfigFileTextToJson(fileName, textOrDiagnostic) : { config: {}, error: textOrDiagnostic };
	}

Investigate the use of readConfigFile() and friends #44516

Description

Activity

RyanCavanaugh commented on Jun 9, 2021

RA80533 commented on Jun 9, 2021

github-actions commented on Jun 8, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Investigate the use of `readConfigFile()` and friends #44516