docs: add note in testing SFCs with Jest for Vue CLI users #1556
Conversation
Add a note to help people know which instructions to follow when testing SFCs using the Jest and Vue CLI. Current instructions assume webpack setup.
| @@ -10,6 +10,12 @@ Jest is a test runner developed by Facebook, aiming to deliver a battery-include | |||
|
|
|||
| We will assume you are starting with a setup that already has webpack, vue-loader and Babel properly configured - e.g. the `webpack-simple` template scaffolded by `vue-cli`. | |||
|
|
|||
| > Alternatively, if you are using the Vue CLI rather than webpack to build your project, you can use the plugin [cli-plugin-unit-jest](https://cli.vuejs.org/core-plugins/unit-jest.html#injected-commands) to run Jest tests. | |||
There was a problem hiding this comment.
Vue CLI does use webpack internally to build the project, though. I think this is a bit confusing. Maybe I misunderstood - can you potentially reword this?
There was a problem hiding this comment.
For sure, I was aware of that and it is partly where I got confused as I just followed the instructions on my first try.
I could take it out:
Alternatively, if you are using the Vue CLI to build your project , you...
Or, making it more explicit:
Alternatively, if you are using the Vue CLI to build your project (where you don't have a separate webpack config and your babel config is using the preset
@vue/cli-plugin-babel/preset), you....
As I understand it, the guide is written from the perspective of having used a preset that defaults to using webpack/you have ejected from the Vue CLI and so you would doing something like npm webpack... rather than npm vue-cli-service...? But if you are using the CLI Service you get some of the config essentially for free and you can skip those sections. Which could lead to another way of explaning:
Alternatively, if you are using the Vue CLI to build your project (your scripts section in your package.json looks something like
vue-cli-service buildrather thanwebpack build), you...
Do you have any preferences?
There was a problem hiding this comment.
I am definitely in favor of encouraging people to use the cli. I see two groups of users:
- beginner/intermediate, who just want to test their components. They should use the CLI.
- advanced users, who want to configure things for more control. They are experienced with the toolchain, they will figure it out. It's unlikely they need significant docs or guidance.
There was a problem hiding this comment.
So following that, we could go for the most straight forward option:
Alternatively, if you are using the Vue CLI to build your project , you...
People should know if they are using the CLI and so read on and advanced users can work out what applies to them. I'll push that in, but please let me know if you would like further changes.
Edit: all done!
P.s. thanks for the really helpful utils!
There was a problem hiding this comment.
Thank you for your contribution!
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
devbranch.fix #xxx[,#xxx], where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information:
Add a note to help people know which instructions to follow when testing SFCs using the Jest and Vue CLI. Current instructions assume webpack setup and so it is unclear which should be followed and which should be skipped when using the Vue CLI.