docs: use npm2yarn in all versions of Getting Started page (#13893)

jestjs · Feb 10, 2023 · fa1930d · fa1930d
1 parent 4fbec41
commit fa1930d
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 63 deletions.
diff --git a/website/versioned_docs/version-25.x/GettingStarted.md b/website/versioned_docs/version-25.x/GettingStarted.md
@@ -3,20 +3,12 @@ id: getting-started
 title: Getting Started
 ---
 
-Install Jest using [`yarn`](https://yarnpkg.com/en/package/jest):
+Install Jest using your favorite package manager:
 
-```bash
-yarn add --dev jest
-```
-
-Or [`npm`](https://www.npmjs.com/package/jest):
-
-```bash
+```bash npm2yarn
 npm install --save-dev jest
 ```
 
-Note: Jest documentation uses `yarn` commands, but `npm` will also work. You can compare `yarn` and `npm` commands in the [yarn docs, here](https://yarnpkg.com/en/docs/migrating-from-npm#toc-cli-commands-comparison).
-
 Let's get started by writing a test for a hypothetical function that adds two numbers. First, create a `sum.js` file:
 
 ```javascript
@@ -46,7 +38,7 @@ Add the following section to your `package.json`:
 }
 ```
 
-Finally, run `yarn test` or `npm run test` and Jest will print this message:
+Finally, run `yarn test` or `npm test` and Jest will print this message:
 
 ```bash
 PASS  ./sum.test.js
@@ -81,10 +73,10 @@ jest --init
 
 ### Using Babel
 
-To use [Babel](https://babeljs.io/), install required dependencies via `yarn`:
+To use [Babel](https://babeljs.io/), install required dependencies:
 
-```bash
-yarn add --dev babel-jest @babel/core @babel/preset-env
+```bash npm2yarn
+npm install --save-dev babel-jest @babel/core @babel/preset-env
 ```
 
 Configure Babel to target your current version of Node by creating a `babel.config.js` file in the root of your project:
@@ -138,10 +130,10 @@ Jest can be used in projects that use [parcel-bundler](https://parceljs.org/) to
 
 #### Via `babel`
 
-Jest supports TypeScript, via Babel. First, make sure you followed the instructions on [using Babel](#using-babel) above. Next, install the `@babel/preset-typescript` via `yarn`:
+Jest supports TypeScript, via Babel. First, make sure you followed the instructions on [using Babel](#using-babel) above. Next, install the `@babel/preset-typescript`:
 
-```bash
-yarn add --dev @babel/preset-typescript
+```bash npm2yarn
+npm install --save-dev @babel/preset-typescript
 ```
 
 Then add `@babel/preset-typescript` to the list of presets in your `babel.config.js`.
@@ -162,8 +154,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
 
 [ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
 
-```bash
-yarn add --dev ts-jest
+```bash npm2yarn
+npm install --save-dev ts-jest
 ```
 
 In order for Jest to transpile TypeScript with `ts-jest`, you may also need to create a [configuration](https://kulshekhar.github.io/ts-jest/docs/getting-started/installation#jest-config-file) file.
@@ -178,6 +170,6 @@ For `@types/*` modules it's recommended to try to match the version of the assoc
 
 :::
 
-```bash
-yarn add --dev @types/jest
+```bash npm2yarn
+npm install --save-dev @types/jest
 ```
diff --git a/website/versioned_docs/version-26.x/GettingStarted.md b/website/versioned_docs/version-26.x/GettingStarted.md
@@ -3,20 +3,12 @@ id: getting-started
 title: Getting Started
 ---
 
-Install Jest using [`yarn`](https://yarnpkg.com/en/package/jest):
+Install Jest using your favorite package manager:
 
-```bash
-yarn add --dev jest
-```
-
-Or [`npm`](https://www.npmjs.com/package/jest):
-
-```bash
+```bash npm2yarn
 npm install --save-dev jest
 ```
 
-Note: Jest documentation uses `yarn` commands, but `npm` will also work. You can compare `yarn` and `npm` commands in the [yarn docs, here](https://yarnpkg.com/en/docs/migrating-from-npm#toc-cli-commands-comparison).
-
 Let's get started by writing a test for a hypothetical function that adds two numbers. First, create a `sum.js` file:
 
 ```javascript
@@ -46,7 +38,7 @@ Add the following section to your `package.json`:
 }
 ```
 
-Finally, run `yarn test` or `npm run test` and Jest will print this message:
+Finally, run `yarn test` or `npm test` and Jest will print this message:
 
 ```bash
 PASS  ./sum.test.js
@@ -81,10 +73,10 @@ jest --init
 
 ### Using Babel
 
-To use [Babel](https://babeljs.io/), install required dependencies via `yarn`:
+To use [Babel](https://babeljs.io/), install required dependencies:
 
-```bash
-yarn add --dev babel-jest @babel/core @babel/preset-env
+```bash npm2yarn
+npm install --save-dev babel-jest @babel/core @babel/preset-env
 ```
 
 Configure Babel to target your current version of Node by creating a `babel.config.js` file in the root of your project:
@@ -138,10 +130,10 @@ Jest can be used in projects that use [parcel-bundler](https://parceljs.org/) to
 
 #### Via `babel`
 
-Jest supports TypeScript, via Babel. First, make sure you followed the instructions on [using Babel](#using-babel) above. Next, install the `@babel/preset-typescript` via `yarn`:
+Jest supports TypeScript, via Babel. First, make sure you followed the instructions on [using Babel](#using-babel) above. Next, install the `@babel/preset-typescript`:
 
-```bash
-yarn add --dev @babel/preset-typescript
+```bash npm2yarn
+npm install --save-dev @babel/preset-typescript
 ```
 
 Then add `@babel/preset-typescript` to the list of presets in your `babel.config.js`.
@@ -162,8 +154,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
 
 [ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
 
-```bash
-yarn add --dev ts-jest
+```bash npm2yarn
+npm install --save-dev ts-jest
 ```
 
 ### Using TypeScript: type definitions
@@ -178,6 +170,6 @@ For `@types/*` modules it's recommended to try to match the version of the assoc
 
 :::
 
-```bash
-yarn add --dev @types/jest
+```bash npm2yarn
+npm install --save-dev @types/jest
 ```
diff --git a/website/versioned_docs/version-27.x/GettingStarted.md b/website/versioned_docs/version-27.x/GettingStarted.md
@@ -3,20 +3,12 @@ id: getting-started
 title: Getting Started
 ---
 
-Install Jest using [`yarn`](https://yarnpkg.com/en/package/jest):
+Install Jest using your favorite package manager:
 
-```bash
-yarn add --dev jest
-```
-
-Or [`npm`](https://www.npmjs.com/package/jest):
-
-```bash
+```bash npm2yarn
 npm install --save-dev jest
 ```
 
-Note: Jest documentation uses `yarn` commands, but `npm` will also work. You can compare `yarn` and `npm` commands in the [yarn docs, here](https://yarnpkg.com/en/docs/migrating-from-npm#toc-cli-commands-comparison).
-
 Let's get started by writing a test for a hypothetical function that adds two numbers. First, create a `sum.js` file:
 
 ```javascript
@@ -46,7 +38,7 @@ Add the following section to your `package.json`:
 }
 ```
 
-Finally, run `yarn test` or `npm run test` and Jest will print this message:
+Finally, run `yarn test` or `npm test` and Jest will print this message:
 
 ```bash
 PASS  ./sum.test.js
@@ -81,10 +73,10 @@ jest --init
 
 ### Using Babel
 
-To use [Babel](https://babeljs.io/), install required dependencies via `yarn`:
+To use [Babel](https://babeljs.io/), install required dependencies:
 
-```bash
-yarn add --dev babel-jest @babel/core @babel/preset-env
+```bash npm2yarn
+npm install --save-dev babel-jest @babel/core @babel/preset-env
 ```
 
 Configure Babel to target your current version of Node by creating a `babel.config.js` file in the root of your project:
@@ -138,10 +130,10 @@ Jest can be used in projects that use [parcel-bundler](https://parceljs.org/) to
 
 ### Using TypeScript via Babel
 
-Jest supports TypeScript, via Babel. First, make sure you followed the instructions on [using Babel](#using-babel) above. Next, install the `@babel/preset-typescript` via `yarn`:
+Jest supports TypeScript, via Babel. First, make sure you followed the instructions on [using Babel](#using-babel) above. Next, install the `@babel/preset-typescript`:
 
-```bash
-yarn add --dev @babel/preset-typescript
+```bash npm2yarn
+npm install --save-dev @babel/preset-typescript
 ```
 
 Then add `@babel/preset-typescript` to the list of presets in your `babel.config.js`.
@@ -162,8 +154,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
 
 [ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
 
-```bash
-yarn add --dev ts-jest
+```bash npm2yarn
+npm install --save-dev ts-jest
 ```
 
 You may also want to install the [`@types/jest`](https://www.npmjs.com/package/@types/jest) module for the version of Jest you're using. This will help provide full typing when writing your tests with TypeScript.
@@ -176,6 +168,6 @@ For `@types/*` modules it's recommended to try to match the version of the assoc
 
 :::
 
-```bash
-yarn add --dev @types/jest
+```bash npm2yarn
+npm install --save-dev @types/jest
 ```