Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(recipes): update automock recipe for v2.0 #2874

Merged
merged 2 commits into from
Nov 8, 2023

Conversation

omermorad
Copy link
Contributor

PR Checklist

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

Description

As Automock releases version 2.0, it is recommended that the Automock recipe documentation be updated.

  • Since Automock now allows additional adapters, the '@automock/adapters.nestjs' package must be installed.
  • Provide more illustrative examples
  • Fix repository URL and link to online documentation.

@omermorad omermorad marked this pull request as draft October 5, 2023 13:49
Copy link
Member

@jmcdo29 jmcdo29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updates look nice, the example is very clear. So long as Kamil likes it, I'd say it's good to go!

@omermorad
Copy link
Contributor Author

Thanks 🚀

Kamil, I'd appreciate it if we could wait one or two days so I can publish the packages and release notes 🙏🏻

Copy link
Contributor

@Tony133 Tony133 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to be in line with the rest of the NestJS documentation 🙂, otherwise I would say it's fine.😉👍

content/recipes/automock.md Outdated Show resolved Hide resolved
content/recipes/automock.md Outdated Show resolved Hide resolved
@omermorad
Copy link
Contributor Author

@jmcdo29 With the release of v2.0, I'm almost there.

While revisiting the NestJS documentation, I had an idea. Unit testing is covered in the "Fundamentals > Testing" section (https://docs.nestjs.com/fundamentals/testing#unit-testing). Perhaps introducing Automock as an optional testing strategy (under "Auto Mocking" or "Utilities") makes sense?

Also, this is also an opportunity to introduce the new documentation website, which can be found at https://automock.dev/docs/ and https://automock.dev/docs/adapters/intro.

CC: @kamilmysliwiec

Thanks!

@omermorad omermorad marked this pull request as ready for review November 3, 2023 05:04
@kamilmysliwiec kamilmysliwiec merged commit 560719b into nestjs:master Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants