feat: migrate to pure ESM (#1030)

- feat(cli): support .mjs config file
- feat(bundler-vite): support vite 3
- test: migrate from jest to vitest
- build: split ecosystem packages

BREAKING CHANGE: VuePress is now published as pure ESM packages
BREAKING CHANGE: CommonJS config file is not supported anymore

Author: meteorlxy

.commitlintrc.js renamed to .commitlintrc.cjs

@@ -1,15 +1,16 @@
 const fs = require('fs')
 const path = require('path')
 
-const packages = fs.readdirSync(path.resolve(__dirname, 'packages/@vuepress'))
+const corePackages = fs.readdirSync(path.resolve(__dirname, 'packages'))
+const ecosystemPackages = fs.readdirSync(path.resolve(__dirname, 'ecosystem'))
 
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
     'scope-enum': [
       2,
       'always',
-      ['vuepress', 'vuepress-vite', 'vuepress-webpack', ...packages],
+      [...corePackages, ...ecosystemPackages],
     ],
     'footer-max-line-length': [0],
   },

.eslintrc.js renamed to .eslintrc.cjs

@@ -11,16 +11,14 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['*.ts', '*.vue'],
+      files: ['*.ts', '*.vue', '*.cts'],
       extends: 'vuepress-typescript',
       parserOptions: {
         project: ['tsconfig.json'],
       },
       rules: {
-        '@typescript-eslint/ban-ts-comment': 'off',
         '@typescript-eslint/no-explicit-any': 'off',
         '@typescript-eslint/no-non-null-assertion': 'off',
-        '@typescript-eslint/no-var-requires': 'off',
         'vue/multi-word-component-names': 'off',
       },
     },
@@ -31,12 +29,10 @@ module.exports = {
       },
     },
     {
-      files: ['**/__tests__/**/*.ts'],
-      env: {
-        jest: true,
-      },
+      files: ['**/tests/**/*.ts', 'tsup.config.ts'],
       rules: {
         '@typescript-eslint/explicit-function-return-type': 'off',
+        'import/no-extraneous-dependencies': 'off',
         'vue/one-component-per-file': 'off',
       },
     },

.github/workflows/check.yml

@@ -37,11 +37,11 @@ jobs:
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
-      - name: Lint
-        run: pnpm lint
-
       - name: Build
         run: pnpm build
 
+      - name: Lint
+        run: pnpm lint
+
       - name: Test
         run: pnpm test

.github/workflows/coverage.yml

@@ -38,7 +38,7 @@ jobs:
         run: pnpm build
 
       - name: Test coverage
-        run: pnpm run test --coverage
+        run: pnpm test:cov
 
       - name: Coveralls
         uses: coverallsapp/github-action@master

docs/.vuepress/config.ts

@@ -1,3 +1,4 @@
+import process from 'node:process'
 import { viteBundler } from '@vuepress/bundler-vite'
 import { webpackBundler } from '@vuepress/bundler-webpack'
 import { defineUserConfig } from '@vuepress/cli'
@@ -6,9 +7,16 @@ import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics'
 import { registerComponentsPlugin } from '@vuepress/plugin-register-components'
 import { shikiPlugin } from '@vuepress/plugin-shiki'
 import { defaultTheme } from '@vuepress/theme-default'
-import { path } from '@vuepress/utils'
-import { head, navbarEn, navbarZh, sidebarEn, sidebarZh } from './configs'
+import { getDirname, path } from '@vuepress/utils'
+import {
+  head,
+  navbarEn,
+  navbarZh,
+  sidebarEn,
+  sidebarZh,
+} from './configs/index.js'
 
+const __dirname = getDirname(import.meta.url)
 const isProd = process.env.NODE_ENV === 'production'
 
 export default defineUserConfig({
@@ -105,10 +113,7 @@ export default defineUserConfig({
   markdown: {
     importCode: {
       handleImportPath: (str) =>
-        str.replace(
-          /^@vuepress/,
-          path.resolve(__dirname, '../../packages/@vuepress')
-        ),
+        str.replace(/^@vuepress/, path.resolve(__dirname, '../../ecosystem')),
     },
   },
 

docs/.vuepress/configs/index.ts

@@ -1,3 +1,3 @@
-export * from './head'
-export * from './navbar'
-export * from './sidebar'
+export * from './head.js'
+export * from './navbar/index.js'
+export * from './sidebar/index.js'

docs/.vuepress/configs/meta.ts

@@ -1 +1,8 @@
-export const { version } = require('@vuepress/core/package.json')
+import { createRequire } from 'node:module'
+import { fs } from '@vuepress/utils'
+
+const require = createRequire(import.meta.url)
+
+export const version = fs.readJSONSync(
+  require.resolve('@vuepress/core/package.json')
+).version

docs/.vuepress/configs/navbar/en.ts

@@ -1,5 +1,5 @@
 import type { NavbarConfig } from '@vuepress/theme-default'
-import { version } from '../meta'
+import { version } from '../meta.js'
 
 export const navbarEn: NavbarConfig = [
   {

docs/.vuepress/configs/navbar/index.ts

@@ -1,2 +1,2 @@
-export * from './en'
-export * from './zh'
+export * from './en.js'
+export * from './zh.js'

docs/.vuepress/configs/navbar/zh.ts

@@ -1,5 +1,5 @@
 import type { NavbarConfig } from '@vuepress/theme-default'
-import { version } from '../meta'
+import { version } from '../meta.js'
 
 export const navbarZh: NavbarConfig = [
   {