feat: convert npm to yarn commands on docs (#784)

semoal · Sergio Moreno · web-flow · commit 2978f4aef881 · 2022-08-09T19:55:26.000+02:00
Co-authored-by: Sergio Moreno &lt;sergio.moreno@flowable.com&gt;
diff --git a/docs/angular-testing-library/intro.mdx b/docs/angular-testing-library/intro.mdx
@@ -9,7 +9,7 @@ builds on top of
 [`DOM Testing Library`](https://github.com/testing-library/dom-testing-library)
 by adding APIs for working with Angular components.
 
-```bash
+```bash npm2yarn
 npm install --save-dev @testing-library/angular
 ```
 
diff --git a/docs/bs-react-testing-library/intro.mdx b/docs/bs-react-testing-library/intro.mdx
@@ -13,7 +13,7 @@ Bindings for several testing libraries have been ported to [ReasonML][re].
 [`bs-dom-testing-library`][gh-dom] contains [BuckleScript][bs] bindings for
 `DOM Testing Library`.
 
-```
+```bash npm2yarn
 npm install --save-dev bs-dom-testing-library
 npm install --save-dev bs-react-testing-library
 ```
@@ -49,7 +49,7 @@ _or_
 This is what [BuckleScript][bs] uses to compile the [Reason][re] code to JS. If
 it is not in your project you can install it like so:
 
-```
+```bash npm2yarn
 npm install --save-dev bs-platform
 ```
 
@@ -60,7 +60,7 @@ examples here will be using it.
 
 - [bs-jest on GitHub](https://github.com/glennsl/bs-jest)
 
-```
+```bash npm2yarn
 npm install --save-dev @glennsl/bs-jest
 ```
 
diff --git a/docs/cypress-testing-library/intro.mdx b/docs/cypress-testing-library/intro.mdx
@@ -6,7 +6,7 @@ title: Cypress Testing Library
 [`Cypress Testing Library`][gh] allows the use of dom-testing queries within
 [Cypress](https://cypress.io) end-to-end browser tests.
 
-```
+```bash npm2yarn
 npm install --save-dev cypress @testing-library/cypress
 ```
 
diff --git a/docs/dom-testing-library/install.mdx b/docs/dom-testing-library/install.mdx
@@ -7,7 +7,7 @@ sidebar_label: Install
 This module is distributed via [npm][npm] which is bundled with [node][node] and
 should be installed as one of your project's `devDependencies`:
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/dom
 ```
 
diff --git a/docs/dom-testing-library/setup.mdx b/docs/dom-testing-library/setup.mdx
@@ -24,7 +24,7 @@ to `jsdom` to achieve the same effect, you don't need global-jsdom.
 
 First, install jsdom and global-jsdom.
 
-```
+```bash npm2yarn
 npm install --save-dev jsdom global-jsdom
 ```
 
diff --git a/docs/ecosystem-bs-jest-dom.mdx b/docs/ecosystem-bs-jest-dom.mdx
@@ -8,7 +8,7 @@ title: bs-jest-dom
 custom DOM element matchers for Jest in [ReasonML][re] via
 [BuckleScript][bucklescript].
 
-```
+```bash npm2yarn
 npm install --save-dev bs-jest-dom
 ```
 
diff --git a/docs/ecosystem-jasmine-dom.mdx b/docs/ecosystem-jasmine-dom.mdx
@@ -6,7 +6,7 @@ title: jasmine-dom
 [`jasmine-dom`][gh] is a companion library for Testing Library that provides
 custom DOM element matchers for Jasmine
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/jasmine-dom
 ```
 
diff --git a/docs/ecosystem-jest-dom.mdx b/docs/ecosystem-jest-dom.mdx
@@ -6,7 +6,7 @@ title: jest-dom
 [`jest-dom`][gh] is a companion library for Testing Library that provides custom
 DOM element matchers for Jest
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/jest-dom
 ```
 
diff --git a/docs/ecosystem-jest-native.mdx b/docs/ecosystem-jest-native.mdx
@@ -8,7 +8,7 @@ sidebar_label: jest-native
 library for `React Native Testing Library` that provides custom element matchers
 for Jest.
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/jest-native
 ```
 
diff --git a/docs/ecosystem-query-extensions.mdx b/docs/ecosystem-query-extensions.mdx
@@ -7,7 +7,7 @@ title: query-extensions
 Library that mixes a higher-level API into the standard `@testing-library` core
 queries
 
-```
+```bash npm2yarn
 npm install --save-dev query-extensions
 ```
 
diff --git a/docs/ecosystem-react-select-event.mdx b/docs/ecosystem-react-select-event.mdx
@@ -7,7 +7,7 @@ title: react-select-event
 that provides helper methods for interacting with [`react-select`][react-select]
 elements.
 
-```
+```bash npm2yarn
 npm install --save-dev react-select-event
 ```
 
diff --git a/docs/ecosystem-riot-testing-library.mdx b/docs/ecosystem-riot-testing-library.mdx
@@ -7,7 +7,7 @@ title: riot-testing-library
 [DOM Testing Library](https://github.com/testing-library/dom-testing-library) by
 adding APIs for working with [Riot.js](https://riot.js.org/) components.
 
-```
+```bash npm2yarn
 npm install --save-dev riot-testing-library
 ```
 
diff --git a/docs/ecosystem-rtl-simple-queries.md b/docs/ecosystem-rtl-simple-queries.md
@@ -6,7 +6,7 @@ title: rtl-simple-queries
 [`rtl-simple-queries`][gh] is a companion library for `React Testing Library`
 that provides an alternative query API.
 
-```
+```bash npm2yarn
 npm install --save-dev rtl-simple-queries
 ```
 
diff --git a/docs/ecosystem-testing-library-selector.md b/docs/ecosystem-testing-library-selector.md
@@ -6,7 +6,7 @@ title: testing-library-selector
 [`testing-library-selector`][gh] is a library for `@testing-library` that
 provides reusable selectors. Written in typescript.
 
-```
+```bash npm2yarn
 npm install --save-dev testing-library-selector
 ```
 
diff --git a/docs/marko-testing-library/intro.mdx b/docs/marko-testing-library/intro.mdx
@@ -8,7 +8,7 @@ sidebar_label: Introduction
 top of [`DOM Testing Library`](dom-testing-library/intro.mdx) by adding APIs for
 working with Marko components.
 
-```
+```bash npm2yarn
 npm install --save-dev @marko/testing-library
 ```
 
diff --git a/docs/nightwatch-testing-library/intro.mdx b/docs/nightwatch-testing-library/intro.mdx
@@ -13,7 +13,7 @@ in [Nightwatch](https://nightwatchjs.org) for end-to-end web testing.
 
 then just
 
-```
+```bash npm2yarn
 npm install -D @testing-library/nightwatch
 ```
 
diff --git a/docs/pptr-testing-library/intro.mdx b/docs/pptr-testing-library/intro.mdx
@@ -6,7 +6,7 @@ title: Puppeteer Testing Library
 [`pptr-testing-library`][gh] is a lightweight adapter allowing
 `DOM Testing Library` to be used with [`puppeteer`][ghpuppeteer].
 
-```
+```bash npm2yarn
 npm install --save-dev puppeteer pptr-testing-library
 ```
 
diff --git a/docs/preact-testing-library/intro.mdx b/docs/preact-testing-library/intro.mdx
@@ -8,7 +8,7 @@ sidebar_label: Introduction
 
 [gh]: https://github.com/testing-library/preact-testing-library
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/preact
 ```
 
diff --git a/docs/react-native-testing-library/intro.mdx b/docs/react-native-testing-library/intro.mdx
@@ -21,7 +21,7 @@ active throughout the React Native Community.
 
 ## Quickstart
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/react-native
 ```
 
diff --git a/docs/react-testing-library/intro.mdx b/docs/react-testing-library/intro.mdx
@@ -11,7 +11,7 @@ APIs for working with React components.
 > out of the box support for **React Testing Library**. If that is not the case,
 > you can add it via `npm` like so:
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/react
 ```
 
diff --git a/docs/react-testing-library/migrate-from-enzyme.mdx b/docs/react-testing-library/migrate-from-enzyme.mdx
@@ -67,7 +67,7 @@ the work can be done collaboratively and spread out over time.
 First, install React Testing Library and the `jest-dom` helper library (you can
 check [this page](setup.mdx) for the complete installation and setup guide).
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/react @testing-library/jest-dom
 ```
 
@@ -296,7 +296,7 @@ resemble the way your software is actually used.
 
 To use the `@testing-library/user-event` module, first install it:
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/user-event @testing-library/dom
 ```
 
diff --git a/docs/react-testing-library/setup.mdx b/docs/react-testing-library/setup.mdx
@@ -288,10 +288,10 @@ using Create React App without TypeScript, save this to `jsconfig.json` instead.
 ### Jest 28
 
 If you're using Jest 28 or later, jest-environment-jsdom package now must be installed separately. 
-```
+```bash npm2yarn
 npm install --save-dev jest-environment-jsdom
 ```
-    
+
 `jsdom` is also no longer the default environment. You can enable `jsdom` globally by editing `jest.config.js`:
 
 ```diff title="jest.config.js"
@@ -340,7 +340,7 @@ fixes, required by React Testing Library.
 
 First, install `jest-environment-jsdom-fifteen`.
 
-```
+```bash npm2yarn
 npm install --save-dev jest-environment-jsdom-fifteen
 ```
 
@@ -369,7 +369,7 @@ browser APIs.
 
 First, install `jsdom` and `global-jsdom`.
 
-```
+```bash npm2yarn
 npm install --save-dev jsdom global-jsdom
 ```
 
diff --git a/docs/svelte-testing-library/intro.mdx b/docs/svelte-testing-library/intro.mdx
@@ -8,7 +8,7 @@ sidebar_label: Introduction
 
 [gh]: https://github.com/testing-library/svelte-testing-library
 
-```
+```bash npm2yarn
 npm install --save-dev @testing-library/svelte
 ```
 
diff --git a/docs/svelte-testing-library/setup.mdx b/docs/svelte-testing-library/setup.mdx
@@ -101,7 +101,7 @@ You can take a look at the [`vitest-svelte-kit` configuration docs](https://gith
     we need to install
     [svelte-jester](https://github.com/mihar-22/svelte-jester)
 
-    ```
+    ```bash npm2yarn
     npm install --save-dev svelte-jester
     ```
 
@@ -125,7 +125,7 @@ You can take a look at the [`vitest-svelte-kit` configuration docs](https://gith
 
     5.1 Install `babel-jest`
 
-    ```bash
+    ```bash npm2yarn
     npm install --save-dev babel-jest
     ```
 
@@ -152,7 +152,7 @@ You can take a look at the [`vitest-svelte-kit` configuration docs](https://gith
 
     6.1 Install `jest-dom`
 
-    ```
+    ```bash npm2yarn
     npm install --save-dev @testing-library/jest-dom
     ```
 
@@ -167,7 +167,7 @@ You can take a look at the [`vitest-svelte-kit` configuration docs](https://gith
 7.  Create your component + test file (checkout the rest of the docs to see how)
     and run it
 
-    ```
+    ```bash npm2yarn
     npm run test
     ```
 
diff --git a/docs/testcafe-testing-library/intro.mdx b/docs/testcafe-testing-library/intro.mdx
@@ -15,7 +15,7 @@ If you are new to the testing-library approach for writing tests, check out the
 
 ## Install
 
-```
+```bash npm2yarn
 npm install --save-dev testcafe @testing-library/testcafe
 ```
 
diff --git a/docs/vue-testing-library/intro.mdx b/docs/vue-testing-library/intro.mdx
@@ -21,11 +21,14 @@ In short, Vue Testing Library does three things:
 ## Quickstart
 
 If using Vue2
-```
+
+```bash npm2yarn
 npm install --save-dev @testing-library/vue@5
 ```
+
 If using Vue3
-```
+
+```bash npm2yarn
 npm install --save-dev @testing-library/vue
 ```
 
diff --git a/docs/webdriverio-testing-library/intro.mdx b/docs/webdriverio-testing-library/intro.mdx
@@ -13,7 +13,7 @@ queries in [WebdriverIO](https://webdriver.io/) for end-to-end web testing.
 
 then just
 
-```
+```bash npm2yarn
 npm install -D @testing-library/webdriverio
 ```
 
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -212,6 +212,9 @@ module.exports = {
         docs: {
           showLastUpdateAuthor: true,
           showLastUpdateTime: true,
+          remarkPlugins: [
+            [require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }],
+          ],
           editUrl:
             'https://github.com/testing-library/testing-library-docs/edit/main/',
           path: './docs',
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
