#1526: Fixed missing import of the Cheerio type

[sk-pub]

What kind of change does this PR introduce? (check at least one)

• Bugfix
• Feature
• Code style update
• Refactor
• Build-related changes
• Other, please describe:

Does this PR introduce a breaking change? (check one)

• Yes
• No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

• It's submitted to the dev branch.
• When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)
• All tests are passing: https://github.com/vuejs/vue-test-utils/blob/dev/.github/CONTRIBUTING.md#development-setup
• New/updated tests are included

If adding a new feature, the PR's description includes:

• A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information:

[lmiller1990]

Are you sure this is necessary? I am not seeing this typing error in dev in VSCode.

[sk-pub]

Are you sure this is necessary? I am not seeing this typing error in dev in VSCode.

Yes. I cannot compile my project, which depends on @vue/server-test-utils, because of this.

And VS Code shows the error:

[lmiller1990]

I don't get this one.

I will ask someone with more TS knowledge, please wait a moment.

[sk-pub]

Probably, you have Cheerio registered globally somehow.

[pikax]

@unicrus works fine for me, can you run yarn --check-files?

If that doesn't work, can you check if you have the file node_modules/@types/cheerio/index.d.ts?

EDIT: If still doesn't work, please remove node_modules folder and do a fresh install.

[sk-pub]

@lmiller1990, @pikax please take a look at the example to reproduce the bug: https://github.com/unicrus/vue-server-test-utils-1526.

TypeScript is a strictly typed language, all types must be defined before usage.

[pikax]

@vue/server-test-utils has cheerio and @types/cheerio has dependencies.

Your repo is overriding the types in tsconfig.json

  "types": [
      "@types/node"
    ]

Making typescript only load those types! As per the documentation

If types is specified, only packages listed will be included

If you remove the types option, it will pick up the types by default. Or you can add Cheerio to your types

    "types": [
      "@types/node", 
      "@types/cheerio"
    ]

[sk-pub]

That's right. But @vue/test-utils does not rely on global types for everything else, like Vue or Vuex. They're explicitly imported. Why should Cheerio be different? It's not a well-known type.

[seyfer]

I cannot build my TS project because of this issue.

#571 (comment)

so I was forced to do this
yarn remove @vue/server-test-utils @types/cheerio cheerio

and rewrite my tests...

[lmiller1990]

@pikax any down sides to merge this types PR? I don't know TS super well, seems like it's blocking a few people - I don't see any downsides to the extra import (right?)

[pikax]

Sorry, got side tracked and this went under the radar.

My requested changes are not required, is just less code, if you want you can merge this.

The explanation is, cheerio types don't expose a default import, but when you import with typescript it expects to have the default export, the flag on the the script tells typescript to basically do import * as if no default module is available.

[lmiller1990]

@unicrus if you can make those changes we can get this merged and released - we have a release in a day or two.

[sk-pub]

@lmiller1990, done. Thanks.