refactor: migrate jest to vitest (#1998)

Author: tatomyr

.github/workflows/tests.yaml

@@ -56,13 +56,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - name: Coverage Report
-        uses: artiomtr/[email protected]
-        continue-on-error: true
-        with:
-          skip-step: none
-          annotations: none
-          test-script: npm run jest
+      # FIXME: add vitest coverage report
 
   code-style-check:
     runs-on: ubuntu-latest

.husky/pre-commit

@@ -6,3 +6,4 @@ packages/core/src/rules/__tests__/fixtures/invalid-yaml.yaml
 packages/respect-core/src/modules/runtime-expressions/abnf-parser.js
 benchmark/api-definitions/
 LICENSE.md
+__tests__/**/*snapshot*.js

.prettierignore

@@ -37,7 +37,7 @@ Before submitting a pull request, please make sure the following is done:
 
 ## Development setup
 
-[Node.js](http://nodejs.org) at v18.17.0+ and NPM v10.8.2+ are required.
+[Node.js](http://nodejs.org) at v22.13.0+ and NPM v10.9.2+ are required.
 
 After forking the repo, run:
 
@@ -47,7 +47,7 @@ npm install # or npm i
 
 ### Commonly used NPM scripts
 
-To compile the code, run `npm run compile`. To do that on the fly, run `npm run watch` in a separate thread.
+To compile the code, run `npm run compile`.
 
 To run a specific CLI command, use `npm run cli`, e.g. `npm run cli -- lint resources/museum.yaml --format=stylish`.
 Please notice that the extra `--` is required to pass arguments to the CLI rather than to NPM itself.
@@ -170,18 +170,18 @@ The application maintains the following exit codes.
 
 ## Tests
 
-When running tests, make sure the code is compiled (`npm run compile` or `npm run watch`).
+When running tests, make sure the code is compiled (`npm run compile`).
 Having `redocly.yaml` in the root of the project affects the unit tests, and console logs affect the e2e tests, so make sure to get rid of both before running tests.
+Run `npm test` to start both unit and e2e tests (and additionally typecheck the code).
 
 ### Unit tests
 
 Run unit tests with this command: `npm run unit`.
 
 Unit tests in the **cli** package are sensitive to top-level configuration file (**redocly.yaml**).
 
+To run tests from a single file, run: `npm run unit -- <path/to/your/file.test.ts>`
 To run a specific test, use this command: `npm run unit -- -t 'Test name'`.
-To run tests in watch mode, run: `npm run unit:watch`
-To run single file in watch mode, run: `npm run unit:watch -- <path/to/your/file.test.ts>`
 To update snapshots, run `npm run unit -- -u`.
 
 To get coverage per package run `npm run coverage:cli` or `npm run coverage:core`.
@@ -196,6 +196,16 @@ To update snapshots, run `npm run e2e -- -u`.
 
 If you made any changes, make sure to compile the code before running the tests.
 
+The e2e tests are written and run with [Vitest](https://vitest.dev/).
+Most of them are encapsulated inside the `commands.test.ts` file.
+However, when adding new e2e tests, it's best to follow the approach of the `respect` command tests.
+
+### Smoke tests
+
+Smokes are for testing the CLI in different environments.
+
+To run them locally, please follow the steps described in the smoke GitHub actions: [smoke](.github/workflows/smoke.yaml), [smoke-plugins](.github/workflows/smoke-plugins.yaml), [smoke-rebilly](.github/workflows/smoke-rebilly.yaml).
+
 ### Performance benchmark
 
 To run the performance benchmark locally, you should have `hyperfine` (v1.16.1+) installed on your machine.
@@ -209,19 +219,18 @@ You might need to adjust the CLI versions that need to be tested in the `benchma
 
 ## Project structure
 
-- **`__mocks__`**: contains basic mocks for e2e tests.
+- **`__tests__`**: contains e2e and smoke tests.
 
-- **`__tests__`**: contains e2e tests. The e2e tests are written and run with [Jest](https://jestjs.io/).
+- **`benchmark`**: contains the performance benchmark. <!-- TODO: move it under the __tests__ folder -->
 
 - **`docs`**: contains the documentation source files. When changes to the documentation are merged, they automatically get published on the [Redocly docs website](https://redocly.com/docs/cli/).
 
-- **`packages`**: contains the source code. Сonsists of two packages - CLI and core. The codebase is written in Typescript.
+- **`packages`**: contains the source code. It consists of three packages - CLI, core, and respect-core. The codebase is written in Typescript.
 
   - **`packages/cli`**: contains Redocly CLI commands and utils. More details [here](../packages/cli/README.md).
 
     - **`packages/cli/src`**: contains CLI package source code.
 
-      - **`packages/cli/src/__mocks__`**: contains basic mocks for unit tests.
       - **`packages/cli/src/__tests__`**: contains unit tests.
       - **`packages/cli/src/commands`**: contains CLI commands functions.
 
@@ -231,12 +240,10 @@ You might need to adjust the CLI versions that need to be tested in the `benchma
     - **`packages/cli/core`**: contains core package source code.
 
       - **`packages/core/src/__tests__`**: contains unit tests.
-      - **`packages/core/src/benchmark`**: contains basic perf benchmark. Not fully ready yet.
       - **`packages/core/src/config`**: contains the base configuration options.
       - **`packages/core/src/decorators`**: contains the built-in [decorators](../docs/resources/built-in-decorators.md) code.
       - **`packages/core/src/format`**: contains the format options.
       - **`packages/core/src/js-yaml`**: contains the [JS-YAML](https://www.npmjs.com/package/js-yaml) based functions.
-      <!-- - **`packages/core/src/redocly`**: contains the Redocly API registry integration setup. FIXME: update the structure description -->
       - **`packages/core/src/rules`**: contains the built-in [rules](../docs/resources/built-in-rules.md) code.
       - **`packages/core/src/types`**: contains the common types for several OpenAPI versions.
       - **`packages/core/src/typings`**: contains the common Typescript typings.
@@ -266,7 +273,7 @@ Merge the PR and cut a release according to the [Release flow](#release-flow).
 To release an experimental version to the **NPM** registry, follow these steps:
 
 1. Create a new PR to **main**.
-2. Add the `snapshot` label to the PR. This creates a new PR with to the `snapshot` branch (which is a copy of the `main` branch).
-3. Merging the second PR triggers release to the **NPM** registry under the `snapshot` tag.
+2. Add the `snapshot` label to the PR.
+   This triggers a release of the current branch changes to the **NPM** registry under the `snapshot` tag.
 
 The released version can be installed with `npm install @redocly/cli@snapshot`.

CONTRIBUTING.md

@@ -1,10 +1,5 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`E2E build-docs build docs with config option 1`] = `
 Found nested/redocly.yaml and using theme.openapi options
 Prerendering docs
 
 🎉 bundled successfully in: nested/redoc-static.html (36 KiB) [⏱ <test>ms].
 
-
-`;

__tests__/build-docs/build-docs-with-config-option/snapshot.js

@@ -1,10 +1,5 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`E2E build-docs simple build-docs 1`] = `
 Found undefined and using theme.openapi options
 Prerendering docs
 
 🎉 bundled successfully in: redoc-static.html (330 KiB) [⏱ <test>ms].
 
-
-`;

__tests__/build-docs/simple-build-docs/snapshot.js

@@ -1,6 +1,3 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`E2E bundle async3 1`] = `
 info:
   title: Account Service
   version: 1.0.0
@@ -56,5 +53,3 @@ operations:
 
 bundling simple.yml...
 📦 Created a bundle for simple.yml at stdout <test>ms.
-
-`;

__tests__/bundle/async3/snapshot.js

@@ -1,6 +1,3 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`E2E bundle bundle-anchor 1`] = `
 openapi: 3.1.0
 paths:
   /test-api:
@@ -30,5 +27,3 @@ components: {}
 
 bundling test.yaml...
 📦 Created a bundle for test.yaml at stdout <test>ms.
-
-`;

__tests__/bundle/bundle-anchor/snapshot.js

@@ -1,6 +1,3 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`E2E bundle bundle-arazzo-valid-test-description 1`] = `
 info:
   title: Redocly Museum API Tickets
   description: A part of imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.
@@ -36,5 +33,3 @@ workflows:
 
 bundling museum.yaml...
 📦 Created a bundle for museum.yaml at stdout <test>ms.
-
-`;

__tests__/bundle/bundle-arazzo-valid-test-description/snapshot.js

@@ -1,6 +1,3 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`E2E bundle bundle-description-dereferenced 1`] = `
 openapi: 3.1.0
 security: []
 paths:
@@ -38,47 +35,3 @@ components:
 
 bundling test.yaml...
 📦 Created a bundle for test.yaml at stdout <test>ms.
-
-`;
-
-exports[`E2E bundle with option: dereferenced description should not be from $ref 1`] = `
-openapi: 3.1.0
-security: []
-paths:
-  /users:
-    post:
-      summary: user
-      description: User.
-      operationId: createUser
-      responses:
-        '200':
-          description: OK
-      requestBody:
-        description: Updated user object
-        content:
-          application/json:
-            schema:
-              description: Names (specific)
-              type: object
-              properties: &ref_0
-                oneName:
-                  description: One name (specific).
-                  type: string
-                otherName:
-                  description: Other name (specific).
-                  type: string
-        required: true
-components:
-  schemas:
-    Name:
-      type: string
-      description: Generic Name.
-    Names:
-      type: object
-      description: names description
-      properties: *ref_0
-
-bundling test.yaml...
-📦 Created a bundle for test.yaml at stdout <test>ms.
-
-`;