docs: use tooling convention across docs (#10512)

This commit is contained in:
Shahed Nasser
2024-12-09 19:15:29 +02:00
committed by GitHub
parent 7c76ee24cb
commit 3409953c4f
76 changed files with 283 additions and 265 deletions
@@ -6,7 +6,7 @@ export const metadata = {
# {metadata.title}
In this chapter, you'll learn how to write integration tests for API routes using the [medusaIntegrationTestRunner utility function](../page.mdx).
In this chapter, you'll learn how to write integration tests for API routes using [medusaIntegrationTestRunner](../page.mdx) from Medusa's Testing Framework.
<Prerequisites
items={[
@@ -6,7 +6,7 @@ export const metadata = {
# {metadata.title}
In this chapter, you'll learn about the `medusaIntegrationTestRunner` utility function used to write integration tests.
In this chapter, you'll learn about `medusaIntegrationTestRunner` from Medusa's Testing Framework and how to use it to write integration tests.
<Prerequisites
items={[
@@ -19,7 +19,7 @@ In this chapter, you'll learn about the `medusaIntegrationTestRunner` utility fu
## medusaIntegrationTestRunner Utility
The `medusaIntegrationTestRunner` utility function is provided by the `@medusajs/test-utils` package to create integration tests in your Medusa project. It runs a full Medusa application, allowing you test API routes, workflows, or other customizations.
The `medusaIntegrationTestRunner` is from Medusa's Testing Framework and it's used to create integration tests in your Medusa project. It runs a full Medusa application, allowing you test API routes, workflows, or other customizations.
For example:
@@ -6,7 +6,7 @@ export const metadata = {
# {metadata.title}
In this chapter, you'll learn how to write integration tests for workflows using the [medusaIntegrationTestRunner utility function](../page.mdx).
In this chapter, you'll learn how to write integration tests for workflows using [medusaIntegrationTestRunner](../page.mdx) from Medusa's Testing Framwork.
<Prerequisites
items={[
@@ -6,7 +6,7 @@ export const metadata = {
# {metadata.title}
In this chapter, find an example of writing an integration test for a module using the [moduleIntegrationTestRunner utility function](../page.mdx).
In this chapter, find an example of writing an integration test for a module using [moduleIntegrationTestRunner](../page.mdx) from Medusa's Testing Framework.
<Prerequisites
items={[
@@ -6,7 +6,7 @@ export const metadata = {
# {metadata.title}
In this chapter, you'll learn about the `moduleIntegrationTestRunner` utility function and how to use it to write integration tests for a module's main service.
In this chapter, you'll learn about `moduleIntegrationTestRunner` from Medusa's Testing Framework and how to use it to write integration tests for a module's main service.
<Prerequisites
items={[
@@ -19,7 +19,7 @@ In this chapter, you'll learn about the `moduleIntegrationTestRunner` utility fu
## moduleIntegrationTestRunner Utility
The `moduleIntegrationTestRunner` utility function is provided by the `@medusajs/test-utils` package to create integration tests for a module. The integration tests run on a test Medusa application with only the specified module enabled.
`moduleIntegrationTestRunner` creates integration tests for a module. The integration tests run on a test Medusa application with only the specified module enabled.
For example, assuming you have a `hello` module, create a test file at `src/modules/hello/__tests__/service.spec.ts`:
@@ -8,11 +8,9 @@ In this chapter, you'll learn about Medusa's testing tools and how to install an
## @medusajs/test-utils Package
Medusa provides a `@medusajs/test-utils` package with utility tools to create integration tests for your custom API routes, modules, or other Medusa customizations.
Medusa provides a Testing Framework to create integration tests for your custom API routes, modules, or other Medusa customizations.
### Install @medusajs/test-utils
To use the `@medusajs/test-utils` package, install it as a `devDependency`:
To use the Testing Framework, install `@medusajs/test-utils` as a `devDependency`:
```bash npm2yarn
npm install --save-dev @medusajs/test-utils@latest
@@ -92,7 +90,7 @@ You now have two commands:
<Note>
Medusa provides utility tools for integration tests only. You can write unit tests using Jest.
Medusa's Testing Framework works for integration tests only. You can write unit tests using Jest.
</Note>