From 61eb3b048ee396674fe6eed66833d0d19b31bd68 Mon Sep 17 00:00:00 2001 From: Gleb Bahmutov Date: Fri, 3 Jul 2020 10:22:43 -0400 Subject: [PATCH] feat: instrument code coverage by default (#339) --- .gitignore | 1 + README.md | 12 ++++- circle.yml | 51 +++++++++++++++++- cypress/plugins/index.js | 22 ++------ cypress/support/index.js | 9 +--- docs/manual-install.md | 15 +++--- examples/cli/.gitignore | 22 ++++++++ examples/cli/.npmrc | 1 + examples/cli/README.md | 3 ++ examples/cli/babel.config.js | 5 ++ examples/cli/package.json | 42 +++++++++++++++ examples/cli/src/App.vue | 28 ++++++++++ examples/cli/src/assets/logo.png | Bin 0 -> 6849 bytes examples/cli/src/components/HelloWorld.vue | 58 +++++++++++++++++++++ examples/cli/src/main.js | 8 +++ package.json | 6 +-- plugins/webpack/index.js | 25 +++++++++ src/support.js | 3 ++ webpack.config.js | 3 +- 19 files changed, 273 insertions(+), 41 deletions(-) create mode 100644 examples/cli/.gitignore create mode 100644 examples/cli/.npmrc create mode 100644 examples/cli/README.md create mode 100644 examples/cli/babel.config.js create mode 100644 examples/cli/package.json create mode 100644 examples/cli/src/App.vue create mode 100644 examples/cli/src/assets/logo.png create mode 100644 examples/cli/src/components/HelloWorld.vue create mode 100644 examples/cli/src/main.js create mode 100644 plugins/webpack/index.js diff --git a/.gitignore b/.gitignore index b0825a0..6d387cd 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ cypress/videos/ cypress/screenshots .nyc_output coverage +*.tgz diff --git a/README.md b/README.md index 3cf58ce..d5ca077 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ > A little helper to unit test Vue components in the open source [Cypress.io](https://www.cypress.io/) E2E test runner **v4.5.0+** -**Jump to:** [Comparison](#comparison), [Blog posts](#blog-posts), Examples: [basic](#basic-examples), [advanced](#advanced-examples), [external](#external-examples), [Code coverage](#code-coverage) +**Jump to:** [Comparison](#comparison), [Blog posts](#blog-posts), Examples: [basic](#basic-examples), [advanced](#advanced-examples), [full](#full-examples), [external](#external-examples), [Code coverage](#code-coverage) ## TLDR @@ -598,6 +598,16 @@ Spec | Description [mocking-imports](cypress/component/advanced/mocking-imports) | Stub ES6 imports from the tests +### Full examples + +We have several subfolders in [examples](examples) folder. + + +Folder Name | Description +--- | --- +[cli](examples/cli) | An example app scaffolded using Vue CLI and the component testing added using `vue add cypress-experimental` command. + + ### External examples diff --git a/circle.yml b/circle.yml index f23888b..f25e031 100644 --- a/circle.yml +++ b/circle.yml @@ -11,7 +11,20 @@ workflows: - cypress/install: name: Install executor: cypress/base-12 - build: npm run build + # creates files in "dist" folder + build: | + npm run build + echo "" + echo "Build package archive πŸ“¦" + echo "" + # first show the contents to be packed + npm pack --dry + echo "" + echo "packing ..." + echo "" + npm pack + echo "" + ls -la post-steps: - run: name: Show info πŸ“Ί @@ -40,6 +53,41 @@ workflows: echo "Test files for this machine are $TESTFILES" npx cypress run --spec $TESTFILES + - cypress/run: + name: Example CLI + executor: cypress/base-12 + requires: + - Install + install-command: npm install + verify-command: echo 'Already verified' + no-workspace: true + working_directory: examples/cli + command: | + echo "🦢🏻 Scaffolding component tests" + echo "" + # scaffolds Babel + Webpack combo + npx --package @vue/cli vue add cypress-experimental + echo "" + echo "🦢🏻 test scaffolded project, should work" + echo "" + DEBUG=cypress-vue-unit-test npx cypress run --spec 'tests/components/**/*.js' + # let's inspect the scaffolded app + ls -la + echo "" + echo "🦢🏻 install the current cypress-vue-unit-test" + echo "" + npm install ../../cypress-vue-unit-test-0.0.0-development.tgz + echo "" + echo "🦢🏻 run component tests" + echo "" + DEBUG=cypress-vue-unit-test npx cypress run --spec 'tests/components/**/*.js' + echo "" + echo "🦢🏻 look at the generated files, should have coverage" + # (after updating cypress-experimental) + echo "" + ls -la + store_artifacts: true + # this job attaches the workspace left by the install job # so it is ready to run Cypress tests # only we will run semantic release script instead @@ -55,6 +103,7 @@ workflows: requires: - Install - Test + - Example CLI install-command: echo 'Already installed' verify-command: echo 'Already verified' no-workspace: true diff --git a/cypress/plugins/index.js b/cypress/plugins/index.js index 377200e..3fc2c04 100644 --- a/cypress/plugins/index.js +++ b/cypress/plugins/index.js @@ -1,22 +1,6 @@ -// default webpack file preprocessor is good for simple cases -const { onFileDefaultPreprocessor } = require('../../preprocessor/webpack') - +/// +const preprocessor = require('../../plugins/webpack') module.exports = (on, config) => { - require('@cypress/code-coverage/task')(on, config) - on('file:preprocessor', onFileDefaultPreprocessor(config)) - - // IMPORTANT to return the config object - // with the any changed environment variables + preprocessor(on, config) return config } - -/* - for more complex cases, when the project already includes webpack.config.js - - const { - onFilePreprocessor - } = require('cypress-vue-unit-test/preprocessor/webpack') - module.exports = on => { - on('file:preprocessor', onFilePreprocessor('../path/to/webpack.config')) - } -*/ diff --git a/cypress/support/index.js b/cypress/support/index.js index 64de925..a73d518 100644 --- a/cypress/support/index.js +++ b/cypress/support/index.js @@ -1,8 +1 @@ -require('@cypress/code-coverage/support') - -beforeEach(() => { - const container = document.getElementById('cypress-jsdom') - if (container) { - container.innerHTML = '' - } -}) +require('../../dist/support') diff --git a/docs/manual-install.md b/docs/manual-install.md index 4399750..0355117 100644 --- a/docs/manual-install.md +++ b/docs/manual-install.md @@ -8,19 +8,18 @@ npm install -D cypress cypress-vue-unit-test ``` -2. Include this plugin `cypress/plugin/index.js` +2. Include this plugin from your project's `cypress/plugin/index.js` file ```js -// default webpack file preprocessor is good for simple cases -// Required to temporarily patch async components, chunking, and inline image loading -import { onFileDefaultPreprocessor } from 'cypress-vue-unit-test/dist/preprocessor/webpack' - -module.exports = (on) => { - on('file:preprocessor', onFileDefaultPreprocessor) +const preprocessor = require('cypress-vue-unit-test/dist/plugins/webpack') +module.exports = (on, config) => { + preprocessor(on, config) + // IMPORTANT return the config object + return config } ``` -3. Include the support file `cypress/support/index.js` +3. Include the support file from your project's `cypress/support/index.js` file ```js import 'cypress-vue-unit-test/dist/support' diff --git a/examples/cli/.gitignore b/examples/cli/.gitignore new file mode 100644 index 0000000..11f5d71 --- /dev/null +++ b/examples/cli/.gitignore @@ -0,0 +1,22 @@ +.DS_Store +node_modules +/dist + +# local env files +.env.local +.env.*.local + +# Log files +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* + +# Editor directories and files +.idea +.vscode +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw? diff --git a/examples/cli/.npmrc b/examples/cli/.npmrc new file mode 100644 index 0000000..43c97e7 --- /dev/null +++ b/examples/cli/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/examples/cli/README.md b/examples/cli/README.md new file mode 100644 index 0000000..29f9f46 --- /dev/null +++ b/examples/cli/README.md @@ -0,0 +1,3 @@ +# cli-example + +Application scaffolded with Vue CLI v3 diff --git a/examples/cli/babel.config.js b/examples/cli/babel.config.js new file mode 100644 index 0000000..e955840 --- /dev/null +++ b/examples/cli/babel.config.js @@ -0,0 +1,5 @@ +module.exports = { + presets: [ + '@vue/cli-plugin-babel/preset' + ] +} diff --git a/examples/cli/package.json b/examples/cli/package.json new file mode 100644 index 0000000..6017018 --- /dev/null +++ b/examples/cli/package.json @@ -0,0 +1,42 @@ +{ + "name": "cli-example", + "version": "0.1.0", + "private": true, + "scripts": { + "serve": "vue-cli-service serve", + "build": "vue-cli-service build", + "lint": "vue-cli-service lint" + }, + "dependencies": { + "core-js": "^3.6.5", + "vue": "^2.6.11" + }, + "devDependencies": { + "@vue/cli-plugin-babel": "~4.4.0", + "@vue/cli-plugin-eslint": "~4.4.0", + "@vue/cli-service": "~4.4.0", + "babel-eslint": "^10.1.0", + "eslint": "^6.7.2", + "eslint-plugin-vue": "^6.2.2", + "vue-template-compiler": "^2.6.11" + }, + "eslintConfig": { + "root": true, + "env": { + "node": true + }, + "extends": [ + "plugin:vue/essential", + "eslint:recommended" + ], + "parserOptions": { + "parser": "babel-eslint" + }, + "rules": {} + }, + "browserslist": [ + "> 1%", + "last 2 versions", + "not dead" + ] +} diff --git a/examples/cli/src/App.vue b/examples/cli/src/App.vue new file mode 100644 index 0000000..55df315 --- /dev/null +++ b/examples/cli/src/App.vue @@ -0,0 +1,28 @@ + + + + + diff --git a/examples/cli/src/assets/logo.png b/examples/cli/src/assets/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f3d2503fc2a44b5053b0837ebea6e87a2d339a43 GIT binary patch literal 6849 zcmaKRcUV(fvo}bjDT-7nLI_nlK}sT_69H+`qzVWDA|yaU?}j417wLi^B1KB1SLsC& zL0ag7$U(XW5YR7p&Ux?sP$d4lvMt8C^+TcQu4F zQqv!UF!I+kw)c0jhd6+g6oCr9P?7)?!qX1ui*iL{p}sKCAGuJ{{W)0z1pLF|=>h}& zt(2Lr0Z`2ig8<5i%Zk}cO5Fm=LByqGWaS`oqChZdEFmc`0hSb#gg|Aap^{+WKOYcj zHjINK)KDG%&s?Mt4CL(T=?;~U@bU2x_mLKN!#GJuK_CzbNw5SMEJorG!}_5;?R>@1 zSl)jns3WlU7^J%=(hUtfmuUCU&C3%8B5C^f5>W2Cy8jW3#{Od{lF1}|?c61##3dzA zsPlFG;l_FzBK}8>|H_Ru_H#!_7$UH4UKo3lKOA}g1(R&|e@}GINYVzX?q=_WLZCgh z)L|eJMce`D0EIwgRaNETDsr+?vQknSGAi=7H00r`QnI%oQnFxm`G2umXso9l+8*&Q z7WqF|$p49js$mdzo^BXpH#gURy=UO;=IMrYc5?@+sR4y_?d*~0^YP7d+y0{}0)zBM zIKVM(DBvICK#~7N0a+PY6)7;u=dutmNqK3AlsrUU9U`d;msiucB_|8|2kY=(7XA;G zwDA8AR)VCA#JOkxm#6oHNS^YVuOU;8p$N)2{`;oF|rQ?B~K$%rHDxXs+_G zF5|-uqHZvSzq}L;5Kcy_P+x0${33}Ofb6+TX&=y;;PkEOpz%+_bCw_{<&~ zeLV|!bP%l1qxywfVr9Z9JI+++EO^x>ZuCK);=$VIG1`kxK8F2M8AdC$iOe3cj1fo(ce4l-9 z7*zKy3={MixvUk=enQE;ED~7tv%qh&3lR<0m??@w{ILF|e#QOyPkFYK!&Up7xWNtL zOW%1QMC<3o;G9_S1;NkPB6bqbCOjeztEc6TsBM<(q9((JKiH{01+Ud=uw9B@{;(JJ z-DxI2*{pMq`q1RQc;V8@gYAY44Z!%#W~M9pRxI(R?SJ7sy7em=Z5DbuDlr@*q|25V)($-f}9c#?D%dU^RS<(wz?{P zFFHtCab*!rl(~j@0(Nadvwg8q|4!}L^>d?0al6}Rrv9$0M#^&@zjbfJy_n!%mVHK4 z6pLRIQ^Uq~dnyy$`ay51Us6WaP%&O;@49m&{G3z7xV3dLtt1VTOMYl3UW~Rm{Eq4m zF?Zl_v;?7EFx1_+#WFUXxcK78IV)FO>42@cm@}2I%pVbZqQ}3;p;sDIm&knay03a^ zn$5}Q$G!@fTwD$e(x-~aWP0h+4NRz$KlnO_H2c< z(XX#lPuW_%H#Q+c&(nRyX1-IadKR-%$4FYC0fsCmL9ky3 zKpxyjd^JFR+vg2!=HWf}2Z?@Td`0EG`kU?{8zKrvtsm)|7>pPk9nu@2^z96aU2<#` z2QhvH5w&V;wER?mopu+nqu*n8p~(%QkwSs&*0eJwa zMXR05`OSFpfyRb!Y_+H@O%Y z0=K^y6B8Gcbl?SA)qMP3Z+=C(?8zL@=74R=EVnE?vY!1BQy2@q*RUgRx4yJ$k}MnL zs!?74QciNb-LcG*&o<9=DSL>1n}ZNd)w1z3-0Pd^4ED1{qd=9|!!N?xnXjM!EuylY z5=!H>&hSofh8V?Jofyd!h`xDI1fYAuV(sZwwN~{$a}MX^=+0TH*SFp$vyxmUv7C*W zv^3Gl0+eTFgBi3FVD;$nhcp)ka*4gSskYIqQ&+M}xP9yLAkWzBI^I%zR^l1e?bW_6 zIn{mo{dD=)9@V?s^fa55jh78rP*Ze<3`tRCN4*mpO$@7a^*2B*7N_|A(Ve2VB|)_o z$=#_=aBkhe(ifX}MLT()@5?OV+~7cXC3r!%{QJxriXo9I%*3q4KT4Xxzyd{ z9;_%=W%q!Vw$Z7F3lUnY+1HZ*lO;4;VR2+i4+D(m#01OYq|L_fbnT;KN<^dkkCwtd zF7n+O7KvAw8c`JUh6LmeIrk4`F3o|AagKSMK3))_5Cv~y2Bb2!Ibg9BO7Vkz?pAYX zoI=B}+$R22&IL`NCYUYjrdhwjnMx_v=-Qcx-jmtN>!Zqf|n1^SWrHy zK|MwJ?Z#^>)rfT5YSY{qjZ&`Fjd;^vv&gF-Yj6$9-Dy$<6zeP4s+78gS2|t%Z309b z0^fp~ue_}i`U9j!<|qF92_3oB09NqgAoehQ`)<)dSfKoJl_A6Ec#*Mx9Cpd-p#$Ez z={AM*r-bQs6*z$!*VA4|QE7bf@-4vb?Q+pPKLkY2{yKsw{&udv_2v8{Dbd zm~8VAv!G~s)`O3|Q6vFUV%8%+?ZSVUa(;fhPNg#vab@J*9XE4#D%)$UU-T5`fwjz! z6&gA^`OGu6aUk{l*h9eB?opVdrHK>Q@U>&JQ_2pR%}TyOXGq_6s56_`U(WoOaAb+K zXQr#6H}>a-GYs9^bGP2Y&hSP5gEtW+GVC4=wy0wQk=~%CSXj=GH6q z-T#s!BV`xZVxm{~jr_ezYRpqqIcXC=Oq`b{lu`Rt(IYr4B91hhVC?yg{ol4WUr3v9 zOAk2LG>CIECZ-WIs0$N}F#eoIUEtZudc7DPYIjzGqDLWk_A4#(LgacooD z2K4IWs@N`Bddm-{%oy}!k0^i6Yh)uJ1S*90>|bm3TOZxcV|ywHUb(+CeX-o1|LTZM zwU>dY3R&U)T(}5#Neh?-CWT~@{6Ke@sI)uSuzoah8COy)w)B)aslJmp`WUcjdia-0 zl2Y}&L~XfA`uYQboAJ1;J{XLhYjH){cObH3FDva+^8ioOQy%Z=xyjGLmWMrzfFoH; zEi3AG`_v+%)&lDJE;iJWJDI@-X9K5O)LD~j*PBe(wu+|%ar~C+LK1+-+lK=t# z+Xc+J7qp~5q=B~rD!x78)?1+KUIbYr^5rcl&tB-cTtj+e%{gpZZ4G~6r15+d|J(ky zjg@@UzMW0k9@S#W(1H{u;Nq(7llJbq;;4t$awM;l&(2s+$l!Ay9^Ge|34CVhr7|BG z?dAR83smef^frq9V(OH+a+ki#q&-7TkWfFM=5bsGbU(8mC;>QTCWL5ydz9s6k@?+V zcjiH`VI=59P-(-DWXZ~5DH>B^_H~;4$)KUhnmGo*G!Tq8^LjfUDO)lASN*=#AY_yS zqW9UX(VOCO&p@kHdUUgsBO0KhXxn1sprK5h8}+>IhX(nSXZKwlNsjk^M|RAaqmCZB zHBolOHYBas@&{PT=R+?d8pZu zUHfyucQ`(umXSW7o?HQ3H21M`ZJal+%*)SH1B1j6rxTlG3hx1IGJN^M7{$j(9V;MZ zRKybgVuxKo#XVM+?*yTy{W+XHaU5Jbt-UG33x{u(N-2wmw;zzPH&4DE103HV@ER86 z|FZEmQb|&1s5#`$4!Cm}&`^{(4V}OP$bk`}v6q6rm;P!H)W|2i^e{7lTk2W@jo_9q z*aw|U7#+g59Fv(5qI`#O-qPj#@_P>PC#I(GSp3DLv7x-dmYK=C7lPF8a)bxb=@)B1 zUZ`EqpXV2dR}B&r`uM}N(TS99ZT0UB%IN|0H%DcVO#T%L_chrgn#m6%x4KE*IMfjX zJ%4veCEqbXZ`H`F_+fELMC@wuy_ch%t*+Z+1I}wN#C+dRrf2X{1C8=yZ_%Pt6wL_~ zZ2NN-hXOT4P4n$QFO7yYHS-4wF1Xfr-meG9Pn;uK51?hfel`d38k{W)F*|gJLT2#T z<~>spMu4(mul-8Q3*pf=N4DcI)zzjqAgbE2eOT7~&f1W3VsdD44Ffe;3mJp-V@8UC z)|qnPc12o~$X-+U@L_lWqv-RtvB~%hLF($%Ew5w>^NR82qC_0FB z)=hP1-OEx?lLi#jnLzH}a;Nvr@JDO-zQWd}#k^an$Kwml;MrD&)sC5b`s0ZkVyPkb zt}-jOq^%_9>YZe7Y}PhW{a)c39G`kg(P4@kxjcYfgB4XOOcmezdUI7j-!gs7oAo2o zx(Ph{G+YZ`a%~kzK!HTAA5NXE-7vOFRr5oqY$rH>WI6SFvWmahFav!CfRMM3%8J&c z*p+%|-fNS_@QrFr(at!JY9jCg9F-%5{nb5Bo~z@Y9m&SHYV`49GAJjA5h~h4(G!Se zZmK{Bo7ivCfvl}@A-ptkFGcWXAzj3xfl{evi-OG(TaCn1FAHxRc{}B|x+Ua1D=I6M z!C^ZIvK6aS_c&(=OQDZfm>O`Nxsw{ta&yiYPA~@e#c%N>>#rq)k6Aru-qD4(D^v)y z*>Rs;YUbD1S8^D(ps6Jbj0K3wJw>L4m)0e(6Pee3Y?gy9i0^bZO?$*sv+xKV?WBlh zAp*;v6w!a8;A7sLB*g-^<$Z4L7|5jXxxP1}hQZ<55f9<^KJ>^mKlWSGaLcO0=$jem zWyZkRwe~u{{tU63DlCaS9$Y4CP4f?+wwa(&1ou)b>72ydrFvm`Rj-0`kBJgK@nd(*Eh!(NC{F-@=FnF&Y!q`7){YsLLHf0_B6aHc# z>WIuHTyJwIH{BJ4)2RtEauC7Yq7Cytc|S)4^*t8Va3HR zg=~sN^tp9re@w=GTx$;zOWMjcg-7X3Wk^N$n;&Kf1RgVG2}2L-(0o)54C509C&77i zrjSi{X*WV=%C17((N^6R4Ya*4#6s_L99RtQ>m(%#nQ#wrRC8Y%yxkH;d!MdY+Tw@r zjpSnK`;C-U{ATcgaxoEpP0Gf+tx);buOMlK=01D|J+ROu37qc*rD(w`#O=3*O*w9?biwNoq3WN1`&Wp8TvKj3C z3HR9ssH7a&Vr<6waJrU zdLg!ieYz%U^bmpn%;(V%%ugMk92&?_XX1K@mwnVSE6!&%P%Wdi7_h`CpScvspMx?N zQUR>oadnG17#hNc$pkTp+9lW+MBKHRZ~74XWUryd)4yd zj98$%XmIL4(9OnoeO5Fnyn&fpQ9b0h4e6EHHw*l68j;>(ya`g^S&y2{O8U>1*>4zR zq*WSI_2o$CHQ?x0!wl9bpx|Cm2+kFMR)oMud1%n2=qn5nE&t@Fgr#=Zv2?}wtEz^T z9rrj=?IH*qI5{G@Rn&}^Z{+TW}mQeb9=8b<_a`&Cm#n%n~ zU47MvCBsdXFB1+adOO)03+nczfWa#vwk#r{o{dF)QWya9v2nv43Zp3%Ps}($lA02*_g25t;|T{A5snSY?3A zrRQ~(Ygh_ebltHo1VCbJb*eOAr;4cnlXLvI>*$-#AVsGg6B1r7@;g^L zFlJ_th0vxO7;-opU@WAFe;<}?!2q?RBrFK5U{*ai@NLKZ^};Ul}beukveh?TQn;$%9=R+DX07m82gP$=}Uo_%&ngV`}Hyv8g{u z3SWzTGV|cwQuFIs7ZDOqO_fGf8Q`8MwL}eUp>q?4eqCmOTcwQuXtQckPy|4F1on8l zP*h>d+cH#XQf|+6c|S{7SF(Lg>bR~l(0uY?O{OEVlaxa5@e%T&xju=o1`=OD#qc16 zSvyH*my(dcp6~VqR;o(#@m44Lug@~_qw+HA=mS#Z^4reBy8iV?H~I;{LQWk3aKK8$bLRyt$g?- +
+

{{ msg }}

+

+ For a guide and recipes on how to configure / customize this project,
+ check out the + vue-cli documentation. +

+

Installed CLI Plugins

+ +

Essential Links

+ +

Ecosystem

+ +
+ + + + + + diff --git a/examples/cli/src/main.js b/examples/cli/src/main.js new file mode 100644 index 0000000..63eb05f --- /dev/null +++ b/examples/cli/src/main.js @@ -0,0 +1,8 @@ +import Vue from 'vue' +import App from './App.vue' + +Vue.config.productionTip = false + +new Vue({ + render: h => h(App), +}).$mount('#app') diff --git a/package.json b/package.json index 15d659e..f5c4333 100644 --- a/package.json +++ b/package.json @@ -25,15 +25,15 @@ "url": "https://github.com/bahmutov/cypress-vue-unit-test.git" }, "scripts": { - "build": "babel src --ignore src/*spec.js --out-dir dist && babel preprocessor --out-dir dist/preprocessor", + "build": "babel src --ignore src/*spec.js --out-dir dist && babel preprocessor --out-dir dist/preprocessor && babel plugins --out-dir dist/plugins", "ban": "ban", "deps": "echo skip deps-ok && dependency-check --no-dev .", "issues": "git-issues", "license": "license-checker --production --onlyunknown --csv", - "lint": "prettier --check '*.js' 'cypress/**/*.js' 'src/**/*.js' 'preprocessor/**/*.js'", + "lint": "prettier --check '*.js' 'cypress/**/*.js' 'src/**/*.js' 'preprocessor/**/*.js' 'plugins/**/*.js'", "prelint": "npm run pretty", "pretest": "npm run lint && npm run build", - "pretty": "prettier --write '*.js' 'cypress/**/*.js' 'src/**/*.js' 'preprocessor/**/*.js'", + "pretty": "prettier --write '*.js' 'cypress/**/*.js' 'src/**/*.js' 'preprocessor/**/*.js' 'plugins/**/*.js'", "size": "npm pack --dry", "test": "npm run cy:run", "unit": "mocha src/*-spec.js", diff --git a/plugins/webpack/index.js b/plugins/webpack/index.js new file mode 100644 index 0000000..aab6e71 --- /dev/null +++ b/plugins/webpack/index.js @@ -0,0 +1,25 @@ +/// +const { onFileDefaultPreprocessor } = require('../../preprocessor/webpack') + +/** + * Registers Cypress preprocessor for Vue component testing. + * IMPORTANT to return the config object with + * with the any changed environment variables. + * + * @param {Cypress.PluginConfigOptions} config Cypress config object. + * @example + * // in your project's plugins/index.js file + * const preprocessor = require('cypress-vue-unit-test/dist/plugins/webpack') + * module.exports = (on, config) => { + * preprocessor(on, config) + * // IMPORTANT return the config object + * return config + * } + */ +const cypressPluginsFn = (on, config) => { + require('@cypress/code-coverage/task')(on, config) + on('file:preprocessor', onFileDefaultPreprocessor(config)) + return config +} + +module.exports = cypressPluginsFn diff --git a/src/support.js b/src/support.js index c7970a7..25c5a6a 100644 --- a/src/support.js +++ b/src/support.js @@ -1,9 +1,12 @@ /* eslint-env mocha */ +require('@cypress/code-coverage/support') + /** Initialize an empty document with root element */ function renderTestingPlatform() { const document = cy.state('document') const el = document.getElementById('cypress-jsdom') if (el) { + // clean the element before each test while (el.hasChildNodes()) { el.removeChild(el.lastChild) } diff --git a/webpack.config.js b/webpack.config.js index dc5c096..e86a028 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -7,7 +7,8 @@ module.exports = { resolve: { extensions: ['.js', '.json', '.vue'], alias: { - 'cypress-vue-unit-test': path.join(__dirname, 'src'), + // point at the built file + 'cypress-vue-unit-test': path.join(__dirname, 'dist'), }, }, module: {