docs(recipes): change automock recipe to suites [WIP] #3046
+359
−237
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Description and Background
This pull request adds "Suites" (previously Automock) to NestJS's "Recipes" section. Suites supports socialble unit testing, as well as other mocking libraries like Vitest (see Automock Discussions #158). This recipe is intended to guide NestJS users through using NestJS testing tools and Suites for various testing methodologies, making it easier to build reliable and maintainable tests.
Key Features
Detailed Documentation
To ensure that NestJS users can fully use both the built-in testing tools and the extra features of Suites, I have carefully written the documentation to describe the different approaches offered by Suites. Offering precise instructions on when and how to use solitary, social, integration, and e2e tests, the aim is to make testing more organized and less confusing.
Content Summary
I'm submitting this pull request now because it will take time to review it, and we plan to release Suites and redirect the repo from
automock/automock
once this pull request is ready, as we don't want to cause confusion.Things you might need to know:
We're getting Suites ready to go live and have made a website with instructions (that includes this recipe as well).
We will release a migration tool under
@suites/cli
that will switch the code from Automock to Suites.There will be no new features added to Automock, but we will help and fix bugs.
I would love to hear your feedback to make the docs as clear as possible. It is important for me personally that NestJS users benefit from both worlds. I hope this contribution will help in making the testing process more seamless and effective for everyone.