feat: Add vue2 package from npm/vue/v2 branch (#21026)

* Add vue2 package from npm/vue/v2 branch

* Add vue2 as automatic export

* remove npm/vue2/examples

* remove cypress directory from vue2

* fix: ordering of build scripts

* remove unneeded files from output, name module cypress-vue2 / CypressVue2

* fix types package resolution

Co-authored-by: Lachlan Miller <[email protected]>
Co-authored-by: Tim Griesser <[email protected]>

.eslintignore

@@ -41,6 +41,7 @@ cli/types
 # cli/react, cli/vue, and cli/mount-utils are all copied from dist'd builds
 cli/react
 cli/vue
+cli/vue2
 cli/mount-utils
 
 # packages/example is not linted (think about changing this)
@@ -69,6 +70,9 @@ npm/cypress-schematic/src/**/*.js
 /npm/create-cypress-tests/initial-template
 /npm/create-cypress-tests/**/*.template.*
 
+# The global eslint configuration is not set up to parse vue@2 files
+/npm/vue2/**/*.vue
+
 packages/data-context/test/unit/codegen/files
 
 # community templates we test against, no need to lint

.releaserc.base.js

@@ -15,5 +15,6 @@ module.exports = {
   ],
   extends: 'semantic-release-monorepo',
   branches: [
+    'master',
   ],
 }

circle.yml

@@ -956,7 +956,7 @@ commands:
           command: ls -la types
           working_directory: cli/build
       - run:
-          command: ls -la vue mount-utils react
+          command: ls -la vue vue2 mount-utils react
           working_directory: cli/build
       - unless:
           condition:

cli/.gitignore

@@ -16,5 +16,6 @@ build
 # ignore packages synced at build-time via
 # the sync-exported-npm-with-cli.js script
 vue
+vue2
 react
-mount-utils
+mount-utils

cli/package.json

@@ -106,7 +106,8 @@
     "types/net-stubbing.ts",
     "mount-utils",
     "vue",
-    "react"
+    "react",
+    "vue2"
   ],
   "bin": {
     "cypress": "bin/cypress"
@@ -124,6 +125,10 @@
       "import": "./vue/dist/cypress-vue.esm-bundler.js",
       "require": "./vue/dist/cypress-vue.cjs.js"
     },
+    "./vue2": {
+      "import": "./vue2/dist/cypress-vue2.esm-bundler.js",
+      "require": "./vue2/dist/cypress-vue2.cjs.js"
+    },
     "./package.json": {
       "import": "./package.json",
       "require": "./package.json"

cli/scripts/post-build.js

@@ -10,6 +10,7 @@ const npmModulesToCopy = [
   'mount-utils',
   'react',
   'vue',
+  'vue2',
 ]
 
 npmModulesToCopy.forEach((folder) => {

cli/scripts/post-install.js

@@ -23,7 +23,7 @@ shell.set('-e') // any error is fatal
 fs.ensureDirSync(join(__dirname, '..', 'types'))
 
 includeTypes.forEach((folder) => {
-  const source = resolvePkg(`@types/${folder}`, { cwd: join(__dirname, '..', '..') })
+  const source = resolvePkg(`@types/${folder}`, { cwd: __dirname })
 
   fs.copySync(source, join(__dirname, '..', 'types', folder))
 })

npm/create-cypress-tests/src/component-testing/init-component-testing.test.ts

@@ -226,7 +226,7 @@ describe('init component tests script', () => {
     }) as any)
 
     await initComponentTesting({ config: {}, cypressConfigPath, useYarn: true })
-    expect(execStub).to.be.calledWith('yarn add @cypress/vue@3 --dev')
+    expect(execStub).to.be.calledWith('yarn add @cypress/vue --dev')
   })
 
   it('suggest the right instruction based on user template choice', async () => {

npm/create-cypress-tests/src/component-testing/installFrameworkAdapter.ts

@@ -48,10 +48,16 @@ type InstallAdapterOptions = {
   useYarn: boolean
 }
 
+const frameworkDependencies = {
+  react: '@cypress/react',
+  'vue@2': '@cypress/vue2',
+  'vue@3': '@cypress/vue',
+}
+
 export async function installFrameworkAdapter (cwd: string, options: InstallAdapterOptions) {
   const framework = await guessOrAskForFramework(cwd)
 
-  await installDependency(`@cypress/${framework}`, options)
+  await installDependency(frameworkDependencies[framework], options)
 
   return framework
 }

npm/vue/package.json

@@ -4,11 +4,11 @@
   "description": "Browser-based Component Testing for Vue.js with Cypress.io ✌️🌲",
   "main": "dist/cypress-vue.cjs.js",
   "scripts": {
-    "build": "rimraf dist && rollup -c rollup.config.js",
-    "postbuild": "node ../../scripts/sync-exported-npm-with-cli.js",
     "build-prod": "yarn build",
     "cy:open": "node ../../scripts/cypress.js open --component --project ${PWD}",
     "cy:run": "node ../../scripts/cypress.js run --component --project ${PWD}",
+    "build": "rimraf dist && rollup -c rollup.config.js",
+    "postbuild": "node ../../scripts/sync-exported-npm-with-cli.js",
     "typecheck": "vue-tsc --noEmit",
     "test": "yarn cy:run",
     "watch": "yarn build --watch --watch.exclude ./dist/**/*",

npm/vue2/.eslintrc

@@ -0,0 +1,17 @@
+{
+  "plugins": [
+    "cypress"
+  ],
+  "extends": [
+    "plugin:@cypress/dev/tests"
+  ],
+  "env": {
+    "cypress/globals": true
+  },
+  "rules": {
+    "mocha/no-global-tests": "off",
+    "no-unused-vars": "off",
+    "no-console": "off",
+    "@typescript-eslint/no-unused-vars": "off"
+  }
+}

npm/vue2/.npmrc

@@ -0,0 +1,4 @@
+registry=http://registry.npmjs.org/
+save-exact=true
+progress=false
+package-lock=true

npm/vue2/.releaserc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  ...require('../../.releaserc.base'),
+  branches: [
+    // this one releases v3 on master on the latest channel
+    'master',
+  ],
+}

npm/vue2/CHANGELOG.md

@@ -0,0 +1,5 @@
+# @cypress/vue2-v1.0.0 (2021-06-17)
+
+### Features
+
+* Split out as separate package from `@cypress/vue`, based on the `npm/vue/v2` branch.