Add {root} helper for tsconfig.json (for avoiding multiple ../../)

[Yegorich555]

Search Terms

helper {root} {workspace} in tsconfig.json

Suggestion

I have the following project structure

tsconfig.json
>folder
 >folder
 >folder
 tsconfig.json => 
 {
 "extends": "../../../tsconfig.json"
 ... 
 }

I didn't find any path-helper that can replace "../../../" to {root} where the root is the current workspace folder

Use Cases

Avoiding using "../../../" because of this is a headache for refactoring

Examples

// folder/folder/folder/tsconfig.json
{
 "extends": "{rootOrWorkspaceFolder}/tsconfig.json"
 "paths": {
 "root/*": ["{rootOrWorkspaceFolder}/*"]
 }
}

Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

[MartinJohns]

What is the "current workspace folder"? How is that determined?

[Yegorich555]

• process.cwd() in NodeJs...
• package.json can point on the workspace folder. It always in the root

A lot of packages use similar logic for defining {root} (jest for example)

[karlhorky]

I guess this is pretty similar to my new issue #51213, wonder if I should close 51213 in favor of this... (or the other way around)

[karlhorky]

Thanks Sheetal Nandi (@sheetalkamat) for implementing the ${configDir} template variable 🎉🚀

• Issue: Add template variable ${configDir} (name to be determined) for file path substitution #57485
• PR: Add template variable ${configDir} for substitution of config files directory path #58042

Looks like will be a part of TS 5.5:

• https://devblogs.microsoft.com/typescript/announcing-typescript-5-5-beta/#the-configdir-template-variable-for-configuration-files