feat(msw): create an index file exporting msw for split tags mode

[AllieJonsson]

Status

READY/WIP

Description

Fixes #512
Is index.msw.ts a good name? Or should it be something like mocks.ts?

Steps to Test or Reproduce

1. yarn generate:mock
2. check generated/mock/petstore-tags-split and there is a index.msw.ts file which exports * from all .msw.ts files

[anymaniax]

it's not a fix for me but more a feature no? And for the file name I would index.mocks.ts instead to follow the logic of the packages no? @melloware @soartec-lab what do you think?

[melloware]

Agreed i think index.mock.ts would be good.

[soartec-lab]

I completely agree with index.msw.ts 👍
This is a great enhancement!

[soartec-lab]

If we don't support everything at once and continue to use it as before, this aggregated index will be unnecessary and just noise. How about making it optional?

[AllieJonsson]

If we don't support everything at once and continue to use it as before, this aggregated index will be unnecessary and just noise. How about making it optional?

I added a check for output.indexFiles, so you can set indexFiles: false in config to not generate this. Or did you have something else in mind?

[anymaniax]

indexFiles also handle the index.ts too so I would add another property like indexMockFiles (maybe there is something better). Like that we can have index.ts and index.(mocks|msw).ts handled separatly

[anymaniax]

@AllieJonsson also thanks for all you are doing!

[AllieJonsson]

indexFiles also handle the index.ts too so I would add another property like indexMockFiles (maybe there is something better). Like that we can have index.ts and index.(mocks|msw).ts handled separatly

True, I just thought that if you want to have index files for non-mock files, you probably want it for mock files as well. But maybe separating and allowing just having one of them is better. Should it be enabled or disabled by default? indexFiles is true by default

[anymaniax]

good point @soartec-lab @melloware I am ok with it either way so if you have thoughts

[AllieJonsson]

This is also really only valid for tags-split mode, right? So adding a whole new setting that only applies to this mode is maybe a bit overkill

[AllieJonsson]

Or maybe this should be added to mode tags as well?

[melloware]

yeah we have too many settings already @AllieJonsson 😄

[soartec-lab]

@AllieJonsson

It's exactly as @anymaniax wrote.
When using tags-split, there are cases where the schema needs indexing and mocking is not necessary, but we don't want to end up with exclusive control.

Also, reusing one option for different purposes will complicate things and confuse users. I agree that there are already too many configuration items, but I didn't think it was overkill to create one option for a new use case.

[soartec-lab]

Another comment I made was about the file extension. The only file type available is msw, so I would like to align them.

[AllieJonsson]

Wait, this setting should be in output.mock.indexMockFiles instead of output.indexMockFiles...

[soartec-lab]

@AllieJonsson
I made one comment to the docs. The rest are fine. Thanks for the great enhance!

[soartec-lab]

Great!