test/ dir is in `include`, non-spec TS files (e.g. test utils) break build with v0.13 rootDir: `./src`

[lookfirst]

Current Behavior

Prior to v0.13 #504 , I could put a file into my test folder that contained utility code for tests and it would get compiled without a problem.

test/TestUtils.tsx

Now, when I tsdx build, I see this error:

rpt2: options error TS6059: File '/mui-rff/test/TestUtils.tsx' is not under 'rootDir' '/mui-rff/src'. 'rootDir' is expected to contain all source files.

Expected behavior

I have a place to put utility code for tests.

Suggested solution(s)

No idea, but you have a list of 3rd parties using this project and it would be nice if you would start to test future versions of tsdx against these projects to see if you break peoples stuff and can then use that to find out how to tell people how to fix their broken stuff.

Your environment

Software	Version(s)
TSDX	v0.13
TypeScript	3.8.3
npm/Yarn	6.13.7 / 1.22.4
Node	v13.11.0
Operating System	OSX Catalina

[agilgur5]

You don't need to (and probably shouldn't) compile it during build if it's just test code (the error says "source files" and this is a test file), you can just import it in your tests and ts-jest will handle it fine.

EDIT: for tl;dr for other readers, remove "test" from your tsconfig.json include similar to what the templates in v0.13.1 have:

tsconfig.json:

{
  "include": ["src", "types"],
   // ...
}

to see if you break peoples stuff and can then use that to find out how to tell people how to fix their broken stuff.

It is listed very clearly as a deprecation in the release and clearly prints a warning. I very much know it can break many people's code, that is the exact reason it is a deprecation with a warning instead of a full breaking change.

The warning says the previous behavior was very buggy (so much so that the more tests we added, the more frequently CI would fail) and tells you how to change. This was a necessary change.

I also do know a good number of the TSDX configs out there, but there are thousands using this, it's impossible to test against all possible uses. I did create #627 recently however.

In the future we could more formally test against some big projects, but keep in mind TSDX is still very young, it is v0.x and will still have many breaking changes ahead. The API surface will evolve and the point of v0.x is to make that clear to consumers that it's still being ironed out and breaking changes will happen more frequently.

Not that it's necessarily a good thing, but plenty of stable v1+ libraries much bigger than TSDX accidentally break things in patches, minors, etc (this occurs in some of TSDX's own dependencies no less like in #511) or make very hard breaking changes that require big migrations. But that'll happen, and every project will fix bugs and learn.

[lookfirst]

You don't need to (and probably shouldn't) compile it during build if it's just test code, you can just import it in your tests and ts-jest will handle it fine.

It doesn't 'handle it fine', hence this issue.

[agilgur5]

It doesn't 'handle it fine', hence this issue

You clearly wrote this issue is about tsdx build with an error message from build. I said you don't need to build test files. You did not mention tsdx test in your issue what-so-ever.

[lookfirst]

tsdx build is failing for me because I have a file in my test directory called test/TestUtils.tsx.

[agilgur5]

Like I said, you don't need to build that file.

I think I see what the issue is though -- the default template include contains the test dir.
That should either be removed (I don't use it like that) or added to the default exclude for builds:

tsdx/src/createRollupConfig.ts

Lines 151 to 162 in e84e8d6

	exclude: [
	// all TS test files, regardless whether co-located or in test/ etc
	'**/*.spec.ts',
	'**/*.test.ts',
	'**/*.spec.tsx',
	'**/*.test.tsx',
	// TS defaults below
	'node_modules',
	'bower_components',
	'jspm_packages',
	paths.appDist,
	],

That also meant test files were being read by rpts2/TS before and excluding them might improve performance of build a bit (.spec and .test were added to excludes in v0.13 as well).

Related to #464 / #472

[lookfirst]

I do notice that the build is faster now. =)

[lookfirst]

If I remove test folder from include and put TestUtils.tsx back into test, then I get other errors around that file. =(

[lookfirst]

Error:(6, 35) TS6059: File '/test/TestUtils.tsx' is not under 'rootDir' '/mui-rff/src'. 'rootDir' is expected to contain all source files.

[agilgur5]

Huh, even when it's not imported by any src/ files?

Not sure if that's because of an upstream bug like ezolenko/rollup-plugin-typescript2#211 or if it's because rpts2's Rollup include passes all *.ts files in.
I'll have to play around with it and see how tsc behaves. Maybe we'll have to exclude test (and __tests__) from build in any case.

You can also override TSDX's default exclude with your own exclude in tsconfig.json. Keep in mind you'll have to add node_modules and dist as the defaults do in the code linked above.

EDIT: when "test" was removed from include, tsdx build stopped giving errors and this was indeed resolved.
The error OP listed above is apparently not from tsdx build but from the IDEA IDE, which OP did not mention until much later...

[lookfirst]

Yea... just try making a non-test file that is only included by test files (and not used by anything in src) work. ;-)

[agilgur5]

ok so I created a test dir with one file in it testUtil.ts and it:

1. Errors once per build format when include has test.
2. Does not error when include only has ['src', 'types'] (annnd turns out the tests all use a tsconfig.json that doesn't include test so I had to add it there)
3. Does not error when include has test, and exclude has **/test/**

So either of the workarounds work. Now the question is whether to change the default exclude or remove test from include...

include also interacts with the linter; without test there, you'll need a separate tsconfig.json for linting, which is suboptimal.
I've also seen the pattern of having test (or __tests__) dir inside of src/, so a default exclude would be helpful for that pattern too.
This would be a performance improvement too, not including files that don't need to be built.

Buuut, it seems that tsc --noEmit, useful for type-checking, will error out regardless if rootDir is ./src, and will do so for any .ts file in test... 😕
Removing test from include means that it won't be type-checked by tsc --noEmit either, which we don't exactly want.
Could do something about both of these with the build exclude as a quick fix...

I also found microsoft/TypeScript#9858, which validates that rootDir is only meant to control the structure of outDir (exactly how it's being used).
In microsoft/TypeScript#9858 (comment), says "Which files are part of your compilation is a separate question that is answered by files and/or include/exclude", so we shouldn't have test since it's not compiled.
But it does need to be type-checked and linted, and it might interact with storybook too...

But it also says in microsoft/TypeScript#9858 (comment) that "[include and rootDir] don't interact: The settings do not affect each other at all." which seems to be quite inaccurate as rootDir throws an error if it's not the include directory or parent of all include directories...

Guh, I'm not sure there's an easy way of reverting #504 without introducing bugs. The only way it'd work is if all package.json main, module, etc were changed to dist/src/ (which is super breaking) or we handled it internally with a tsdx publish command