test: add e2e case for conditional exports

Author: meteorlxy

.eslintrc.cjs

@@ -17,6 +17,9 @@ module.exports = {
     {
       files: ['**/e2e/**/*.cy.ts', '**/e2e/cypress/**/*.ts'],
       extends: 'plugin:cypress/recommended',
+      rules: {
+        '@typescript-eslint/no-namespace': 'off',
+      },
     },
     {
       files: ['**/tests/**/*.ts', 'tsup.config.ts'],

.github/workflows/e2e.yml

@@ -64,13 +64,15 @@ jobs:
         env:
           E2E_BASE: ${{ matrix.base }}
           E2E_BUNDLER: ${{ matrix.bundler }}
+          E2E_COMMAND: dev
 
       - name: E2E build
         working-directory: ./e2e
         run: pnpm e2e:ci:build
         env:
           E2E_BASE: ${{ matrix.base }}
           E2E_BUNDLER: ${{ matrix.bundler }}
+          E2E_COMMAND: build
 
   e2e-result:
     if: ${{ always() }}

e2e/cypress.config.ts

@@ -7,5 +7,6 @@ export default defineConfig({
   },
   env: {
     E2E_BASE: process.env.E2E_BASE ?? '/',
+    E2E_COMMAND: process.env.E2E_COMMAND ?? 'dev',
   },
 })

e2e/cypress/support/commands.ts

@@ -1,8 +1,34 @@
 const URL_PREFIX = Cypress.env('E2E_BASE').replace(/\/$/, '')
 
 // override the default cy.visit command to prepend base
-// @ts-expect-error: could not type this method correctly
-Cypress.Commands.overwrite('visit', (originalFn, url, options) =>
-  // @ts-expect-error: could not type this method correctly
-  originalFn(`${URL_PREFIX}${url}`, options),
+Cypress.Commands.overwrite('visit', (originalFn, ...args) => {
+  // cy.visit(url, options)
+  if (typeof args[0] === 'string') {
+    // @ts-expect-error: could not type this correctly
+    return originalFn(`${URL_PREFIX}${args[0]}`, args[1])
+  }
+
+  // cy.visit(options)
+  return originalFn({
+    ...args[0],
+    url: `${URL_PREFIX}${args[0].url}`,
+  })
+})
+
+// add a custom request command to prepend base
+Cypress.Commands.add('requestWithBase', (url, options) =>
+  cy.request(`${URL_PREFIX}${url}`, options),
 )
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      requestWithBase: <T = any>(
+        url: string,
+        options?: Partial<Cypress.RequestOptions>,
+      ) => Chainable<Cypress.Response<T>>
+    }
+  }
+}
+
+export {}

e2e/docs/imports/conditional-exports.md

@@ -0,0 +1,5 @@
+<script setup>
+import str from '@vuepress-e2e/conditional-exports'
+</script>
+
+{{ str }}

e2e/modules/conditional-exports/browser.mjs

@@ -0,0 +1 @@
+export default 'browser-mjs'

e2e/modules/conditional-exports/node.cjs

@@ -0,0 +1 @@
+module.exports = 'node-cjs'

e2e/modules/conditional-exports/node.mjs

@@ -0,0 +1 @@
+export default 'node-mjs'

e2e/modules/conditional-exports/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@vuepress-e2e/conditional-exports",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./types.d.ts",
+      "browser": "./browser.mjs",
+      "node": "./node.mjs",
+      "module": "./node.mjs",
+      "import": "./node.mjs",
+      "require": "./node.cjs",
+      "default": "./node.cjs"
+    },
+    "./*": "./*"
+  },
+  "main": "cjs.js",
+  "module": "esm.js",
+  "types": "types.d.ts"
+}

e2e/modules/conditional-exports/types.d.ts

@@ -0,0 +1,2 @@
+declare const str: string
+export default str

e2e/package.json

@@ -4,18 +4,19 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "e2e:build": "vuepress build docs --clean-cache --clean-temp",
+    "e2e:build": "E2E_COMMAND=build vuepress build docs --clean-cache --clean-temp",
     "e2e:build-webpack": "E2E_BUNDLER=webpack pnpm e2e:build",
     "e2e:ci:build": "pnpm e2e:build && start-server-and-test e2e:serve http-get://localhost:9080 e2e:run",
     "e2e:ci:dev": "start-server-and-test e2e:dev http-get://127.0.0.1:9080 e2e:run",
     "e2e:clean": "rimraf docs/.vuepress/.temp docs/.vuepress/.cache docs/.vuepress/dist",
-    "e2e:dev": "vuepress dev docs --clean-cache --clean-temp",
+    "e2e:dev": "E2E_COMMAND=dev vuepress dev docs --clean-cache --clean-temp",
     "e2e:dev-webpack": "E2E_BUNDLER=webpack pnpm e2e:dev",
     "e2e:open": "cypress open",
     "e2e:run": "cypress run",
     "e2e:serve": "anywhere -s -h localhost -p 9080 -d docs/.vuepress/dist"
   },
   "dependencies": {
+    "@vuepress-e2e/conditional-exports": "file:./modules/conditional-exports",
     "@vuepress/bundler-vite": "workspace:*",
     "@vuepress/bundler-webpack": "workspace:*",
     "sass": "^1.70.0",

e2e/tests/imports/conditional-exports.cy.ts

@@ -0,0 +1,13 @@
+it('should support visiting non-ASCII paths directly', () => {
+  const E2E_COMMAND = Cypress.env('E2E_COMMAND')
+
+  cy.visit('/imports/conditional-exports.html')
+
+  cy.get('.e2e-theme-content p').should('have.text', 'browser-mjs')
+
+  if (E2E_COMMAND === 'build') {
+    cy.requestWithBase('/imports/conditional-exports.html')
+      .its('body')
+      .should('include', '<p>node-mjs</p>')
+  }
+})