Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(runner): add docs to @vitest/runner, remove barrel files #6126

Merged
merged 17 commits into from
Jul 15, 2024

Conversation

sheremet-va
Copy link
Member

@sheremet-va sheremet-va commented Jul 14, 2024

Description

This PR adds JSDOC to the public runner API and removes barrel files from @vitest/runner package

To generate jsdocs, I used Copilot Chat with a prompt for every method:

generate jsdocs for "<method>" with examples

Some jsdocs were updated after the prompt.

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

@sheremet-va sheremet-va force-pushed the refactor/runner-docs branch from 77cc764 to b1787d0 Compare July 15, 2024 15:17
@sheremet-va sheremet-va merged commit f1ef2f6 into vitest-dev:main Jul 15, 2024
16 checks passed
@sheremet-va sheremet-va deleted the refactor/runner-docs branch July 15, 2024 15:43
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.

1 participant