(feat): exclude co-located stories by default from build

[kylemh]

A brute attempt to resolve the issue I'm encountering in #663

Resolves #663

[kylemh]

I wonder if we need to do

...(!!opts.tsconfig.exclude ? [opts.tsconfig.exclude] : [])

[kylemh]

I tested the logic in rpts2:

I don't see an issue... it should work fine.

Although strangely enough a different merge loses some options which I'm surprised get lost...

[kylemh]

There exists a few lines after L44 in that rpts2 file I linked which I believe also do some merging.

[agilgur5]

That's not because of rpts2 -- that's how _.merge works with arrays. exclude is an array, so your custom exclude would just override the same indices.
In your first "test", **/*.stories.tsx also overrides the first entry, **/*.spec.ts

I think this jogged my brain a bit -- I'm pretty sure that line in rpts2 is around where the bug is.
TSDX has similar logic as rpts2 using TS's custom parsers to read a tsconfig and then get its compilerOptions through all extends chains. But that's only for compilerOptions, meaning exclude etc from an extends aren't actually parsed.

Problem there is that I don't know if there's a way to get the rest. This part of the TS API isn't documented but is used in lots of places in the wild for parsing, it took me a while to figure out how to do it myself, c.f. #489

[agilgur5]

Ah, the original config gets mutated with the new include/exclude, while compilerOptions is unchanged and returned per facebook/create-react-app#5537

I'll have to look into rpts2 config and see if there's actually a bug or not, I'm not sure. I still haven't repro'd #663

[agilgur5]

I still need to repro the bug, investigate, and then possibly investigate upstream, but I was thinking this feature is good to have in any case for simplifying config for those who have co-located stories. But this entire default exclude wouldn't be needed if we could use file: ['src/index.ts'] instead, but that's blocked on ezolenko/rollup-plugin-typescript2#211.

In any case, this would need tests if it were to be merged. Would have to add an empty story file to the build-default fixture (similar to the empty test/ files that just have comments in them) and then check that it's not output to dist/ after build

[kylemh]

Sounds like I should just wait for ezolenko/rollup-plugin-typescript2#211

Thanks for diving deep! Love having you on this project. ❤️

[agilgur5]

Sounds like I should just wait for ezolenko/rollup-plugin-typescript2#211

I don't think that'll be fixed any time soon, especially not if it requires parsing declarations.

Hence why I'd be fine with this going in, as, for the time-being we have to use include instead of file (even if we changed to the latter, we'd still have older users of the former).

[kylemh]

I see. My guess is a relevant test would be considered e2e? I can do a default build with a Storybook file. Make a uniquely named type, and assert that none of the file contents in dist include the type name?

[agilgur5]

Yea you'd like create e2e/fixtures/build-default/src/story-test.stories.tsx that's empty other than a comment (see the build-default/test/ for what that would look like) and then use the same style tests as in the e2e/tsdx-build-default.test.ts except you'd have a toBeFalsy() for this file instead of toBeTruthy()