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.

Sign up for GitHub

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

Jump to bottom

fix(vitest,runner): simplify test.extend type exports #6707

Merged
merged 8 commits into from
Oct 15, 2024
Merged

fix(vitest,runner): simplify test.extend type exports #6707

merged 8 commits into from
Oct 15, 2024

Conversation

hi-ogawa
Copy link
Contributor

@hi-ogawa hi-ogawa commented Oct 15, 2024 •
edited
Loading

Description

I'm not sure if we can ensure to not break these typing forever for user land dts, but just testing some simplification.
Either we can re-export CustomAPI from vitest or we can eliminate CustomAPI in favor of TestAPI since they are just alias now.

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

@netlify Netlify
Copy link

netlify bot commented Oct 15, 2024 •
edited
Loading

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7f5ad9a
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/670e3227169ed80008a74f7f
😎 Deploy Preview https://deploy-preview-6707--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pkg-pr-new pkg.pr.new

This comment was marked as resolved.

Sign in to view
@hi-ogawa hi-ogawa changed the title fix(vitest,runner): tweak test.extend type exports fix(vitest,runner): simplify test.extend type exports Oct 15, 2024
@hi-ogawa hi-ogawa marked this pull request as ready for review October 15, 2024 02:44
AriPerkkio
AriPerkkio reviewed Oct 15, 2024
View reviewed changes
Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we can ensure to not break these typing forever for user land dts

Yep, adding tests inside Vitest monorepo might not work the same as they do when npm package is downloaded and installed. But maybe test case in ecosystem-ci could catch these? Though there we are using locally linked packages too so I'm not sure 🤔

@hi-ogawa
Copy link
Contributor Author

Yeah, coming up with a nice test inside this repo is probably hard. Let me think about putting my reproduction https://github.com/hi-ogawa/reproductions/tree/main/vitest-6660-test-extend-dts as ecosystem ci tests. Maybe I can try something like Vite's tsconfig.check.json, which type checks its own dts output https://github.com/vitejs/vite/blob/5552583a2272cd4208b30ad60e99d984e34645f0/packages/vite/tsconfig.check.json#L14

@hi-ogawa
Copy link
Contributor Author

Oh, I moved the repro to test/dts-fixture and this looks functioning as tests. It fails on main and passes on this PR.

sheremet-va
sheremet-va previously approved these changes Oct 15, 2024
View reviewed changes
@sheremet-va sheremet-va merged commit e5c388f into vitest-dev:main Oct 15, 2024
17 of 18 checks passed
@hi-ogawa hi-ogawa deleted the fix-test-extend-type branch October 15, 2024 09:52
renovate bot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull request Oct 28, 2024
@renovate
chore(deps): update dependency vitest to v2.1.4
fe9cbc6 
##### [v2.1.4](https://github.com/vitest-dev/vitest/releases/tag/v2.1.4)

#####    🚀 Features

-   **browser**: Allow custom HTML path, respect plugins `transformIndexHtml`  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6725 [<samp>(16902)</samp>](vitest-dev/vitest@169028f0)

#####    🐞 Bug Fixes

-   Don't normalize drive case letter in root  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6792 [<samp>(b28cd)</samp>](vitest-dev/vitest@b28cd2e3)
-   **browser**:
    -   Fix default browser port  -  by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6700 [<samp>(9c518)</samp>](vitest-dev/vitest@9c518c14)
    -   Optimize expect-type  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6713 [<samp>(07918)</samp>](vitest-dev/vitest@07918538)
    -   Don't polyfill process.env  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6718 [<samp>(da6d2)</samp>](vitest-dev/vitest@da6d2ea7)
    -   Increment browser port automatically if there are several projects with browser.enabled  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6717 [<samp>(a9397)</samp>](vitest-dev/vitest@a939779f)
    -   Cleanup keyboard state  -  by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6731 [<samp>(19278)</samp>](vitest-dev/vitest@19278f4c)
    -   Don't add `v=` queries to setup files imports  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6759 [<samp>(b8258)</samp>](vitest-dev/vitest@b82584c9)
    -   User event cleanup on retry  -  by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6764 [<samp>(bdd15)</samp>](vitest-dev/vitest@bdd15dd1)
    -   Ignore non mocked msw requests  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6770 [<samp>(9d9ba)</samp>](vitest-dev/vitest@9d9bad5b)
    -   Initiate MSW in the same frame as tests  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6772 [<samp>(2444f)</samp>](vitest-dev/vitest@2444ff22)
-   **deps**:
    -   Update dependency sirv to v3  -  in vitest-dev/vitest#6701 [<samp>(fde5d)</samp>](vitest-dev/vitest@fde5d509)
-   **expect**:
    -   Correct behavior of `toThrowError` with empty string parameter  -  by [@shulaoda](https://github.com/shulaoda) in vitest-dev/vitest#6710 [<samp>(a6129)</samp>](vitest-dev/vitest@a61293e9)
-   **mocker**:
    -   Remove spy from peer dependencies  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6777 [<samp>(3a8b5)</samp>](vitest-dev/vitest@3a8b56bf)
-   **vitest**:
    -   Clarify slowTestThreshold, print slow tests in non-TTY mode  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6715 [<samp>(2e6aa)</samp>](vitest-dev/vitest@2e6aa647)
    -   Print warnings form Vite plugins  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6724 [<samp>(121b1)</samp>](vitest-dev/vitest@121b161f)
    -   Don't fail if the working directory starts with a lowercase drive letter  -  by [@sheremet-va](https://github.com/sheremet-va) in vitest-dev/vitest#6779 [<samp>(df6d7)</samp>](vitest-dev/vitest@df6d750b)
    -   Silence import analysis warning  -  by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6785 [<samp>(39041)</samp>](vitest-dev/vitest@39041ee5)
-   **vitest,runner**:
    -   Simplify `test.extend` type exports  -  by [@hi-ogawa](https://github.com/hi-ogawa) in vitest-dev/vitest#6707 [<samp>(e5c38)</samp>](vitest-dev/vitest@e5c388f0)

#####    🏎 Performance

-   Use `hash` to replace `createHash`  -  by [@btea](https://github.com/btea) in vitest-dev/vitest#6703 [<samp>(5d07b)</samp>](vitest-dev/vitest@5d07bba6)

#####     [View changes on GitHub](vitest-dev/vitest@v2.1.3...v2.1.4)
@renovate renovate bot mentioned this pull request Nov 3, 2024
Merged
1 task
@hi-ogawa hi-ogawa mentioned this pull request Nov 3, 2024
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AriPerkkio AriPerkkio AriPerkkio left review comments

@sheremet-va sheremet-va sheremet-va approved these changes

Assignees
No one assigned
Labels
cr-tracked
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Broken types for extended test context
3 participants
@hi-ogawa @AriPerkkio @sheremet-va