feat(remix-dev): add tsconfigPath config option to RemixConfig
#3936
Conversation
This patch addresses an issue[1] in which Remix looks for a tsconfig outside the root directory. We fix this behavior by looking for a tsconfig where it should be (in the rootDirectory itself) and passing its absolute path to `tsconfig-paths`. `tsconfig-paths` will then treat the given path as a tsconfig file path and won't crawl further. If no tsconfig file is found by us in our root directory, we simply won't call `tsconfig-paths` at all. Note that crawling up is `tsconfig-path`s intended behavior, but not Remix's. A secondary bug that causes this same issue is due to esbuild[2]. When no tsconfig is passed to esbuild, it will crawl the filesystem up looking for any tsconfig available and will load it. When tsconfig is explicitly set to `undefined`, it does the crawling anyways. Unfortunately, this is a fix that has to be done in `esbuild`, but a few alternatives to manage this unwanted behavior for now can be: 1. Create an empty tsconfig in the build directory and pass it to esbuild so it doesn't crawl outside rootDir; 2. Show a warning to let the user know why the crawling is happening. Fixes remix-run#3210 [1] remix-run#3210 [2] evanw/esbuild#2440 Signed-off-by: Juliana Oliveira <juliana@uma.ni>
|
|
( |
MichaelDeBoey
changed the title
tsconfigPath config option
packages/remix-dev/config.ts
Outdated
| @@ -450,6 +455,15 @@ export async function readConfig( | |||
|
|
|||
| let serverDependenciesToBundle = appConfig.serverDependenciesToBundle || []; | |||
|
|
|||
| // When tsconfigPath is undefined, the default "tsconfig.json" is not | |||
| // found in the root directory. | |||
| let tsconfigDefaultFilename = "tsconfig.json" | |||
There was a problem hiding this comment.
do you happen to know if this all works as expected if you use a jsconfig.json file and pass that to esbuild?
There was a problem hiding this comment.
it appears that it does, can you update this to also check for jsconfig.json? i think something like this should be sufficient https://github.com/remix-run/remix/pull/3012/files#diff-852e3f3cc491a6fcc66706c94417be59f4c12569e0f367354613bfc103df7b38R299-R307
Now we not only consider tsconfig.json, but also `jsconfig.json`. Signed-off-by: Juliana Oliveira <juliana@uma.ni>
|
Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳 |
|
@mcansh I can't merge this. How is this done? |
getting this over the finish line now :) going to update the pr with dev to make sure everything is still swimming along |
mcansh
changed the title
tsconfigPath config optiontsconfigPath config option to RemixConfig
MichaelDeBoey
added
the
awaiting release
This patch addresses an issue[1] in which Remix looks for a tsconfig
outside the root directory.
We fix this behavior by looking for a tsconfig where it should be
(in the root directory itself) and passing its absolute path to
tsconfig-paths.tsconfig-pathswill then treat the given path as atsconfig file path and won't crawl further. If no tsconfig file is
found by us in our root directory, we simply won't call
tsconfig-pathsat all. Note that crawling up is
tsconfig-paths intended behavior,but not Remix's.
A secondary bug that causes this same issue is due to esbuild[2]. When
no tsconfig is passed to esbuild, it will crawl the filesystem up looking
for any tsconfig available and will load it. When tsconfig is explicitly
set to
undefined, it does the crawling anyways. Unfortunately,this is a fix that has to be done in
esbuild, but a few alternativesto manage this unwanted behavior for now can be:
so it doesn't crawl outside rootDir;
Closes #3210
[1] #3210
[2] evanw/esbuild#2440
Signed-off-by: Juliana Oliveira juliana@uma.ni