Skip to content

refactor!: remove EnhancedSpy type, deprecate SpyInstance, improve mocks and vi documentation#4400

Merged
sheremet-va merged 6 commits intovitest-dev:mainfrom
sheremet-va:docs/improve-some-docs
Oct 31, 2023
Merged

refactor!: remove EnhancedSpy type, deprecate SpyInstance, improve mocks and vi documentation#4400
sheremet-va merged 6 commits intovitest-dev:mainfrom
sheremet-va:docs/improve-some-docs

Conversation

@sheremet-va
Copy link
Member

Description

This PR

  • removes EnhancedSpy because it is an implementation detail and is no longer needed
  • deprecates SpyInstance in favor of MockInstance
  • adds inline documentation to "vi" object
  • adds inline documentation to mock instance
  • adds more documentation in general
  • updates vitepress to the latest version which changes design a little bit

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Loading
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.

2 participants