### `nr test-dts`
-Runs `nr build-dts` first, then verify the type tests in `packages/dts-test` are working correctly against the actual built type declarations.
+Runs `nr build-dts` first, then verify the type tests in `packages-private/dts-test` are working correctly against the actual built type declarations.
## Project Structure
### Testing Type Definition Correctness
-Type tests are located in the `packages/dts-test` directory. To run the dts tests, run `nr test-dts`. Note that the type test requires all relevant `*.d.ts` files to be built first (and the script does it for you). Once the `d.ts` files are built and up-to-date, the tests can be re-run by running `nr test-dts-only`.
+Type tests are located in the `packages-private/dts-test` directory. To run the dts tests, run `nr test-dts`. Note that the type test requires all relevant `*.d.ts` files to be built first (and the script does it for you). Once the `d.ts` files are built and up-to-date, the tests can be re-run by running `nr test-dts-only`.
## Financial Contribution
{
groupName: 'playground',
matchFileNames: [
- 'packages/sfc-playground/package.json',
- 'packages/template-explorer/package.json',
+ 'packages-private/sfc-playground/package.json',
+ 'packages-private/template-explorer/package.json',
],
},
{
// tests, no restrictions (runs in Node / Vitest with jsdom)
{
- files: ['**/__tests__/**', 'packages/dts-test/**'],
+ files: [
+ '**/__tests__/**',
+ 'packages-private/dts-test/**',
+ 'packages-private/dts-build-test/**',
+ ],
plugins: { vitest },
languageOptions: {
globals: {
// Private package, browser only + no syntax restrictions
{
- files: ['packages/template-explorer/**', 'packages/sfc-playground/**'],
+ files: [
+ 'packages-private/template-explorer/**',
+ 'packages-private/sfc-playground/**',
+ ],
rules: {
'no-restricted-globals': ['error', ...NodeGlobals],
'no-restricted-syntax': ['error', banConstEnum],
"test-unit": "vitest -c vitest.unit.config.ts",
"test-e2e": "node scripts/build.js vue -f global -d && vitest -c vitest.e2e.config.ts",
"test-dts": "run-s build-dts test-dts-only",
- "test-dts-only": "tsc -p packages/dts-built-test/tsconfig.json && tsc -p ./packages/dts-test/tsconfig.test.json",
+ "test-dts-only": "tsc -p packages-private/dts-built-test/tsconfig.json && tsc -p ./packages-private/dts-test/tsconfig.test.json",
"test-coverage": "vitest -c vitest.unit.config.ts --coverage",
"test-bench": "vitest bench",
"release": "node scripts/release.js",
"dev-compiler": "run-p \"dev template-explorer\" serve",
"dev-sfc": "run-s dev-sfc-prepare dev-sfc-run",
"dev-sfc-prepare": "node scripts/pre-dev-sfc.js || npm run build-all-cjs",
- "dev-sfc-serve": "vite packages/sfc-playground --host",
+ "dev-sfc-serve": "vite packages-private/sfc-playground --host",
"dev-sfc-run": "run-p \"dev compiler-sfc -f esm-browser\" \"dev vue -if esm-bundler-runtime\" \"dev vue -ipf esm-browser-runtime\" \"dev server-renderer -if esm-bundler\" dev-sfc-serve",
"serve": "serve",
"open": "open http://localhost:3000/packages/template-explorer/local.html",
"build-runtime-esm": "node scripts/build.js runtime reactivity shared -af esm-bundler && node scripts/build.js vue -f esm-bundler-runtime && node scripts/build.js vue -f esm-browser-runtime",
"build-browser-esm": "node scripts/build.js runtime reactivity shared -af esm-bundler && node scripts/build.js vue -f esm-bundler && node scripts/build.js vue -f esm-browser",
"build-ssr-esm": "node scripts/build.js compiler-sfc server-renderer -f esm-browser",
- "build-sfc-playground-self": "cd packages/sfc-playground && npm run build",
+ "build-sfc-playground-self": "cd packages-private/sfc-playground && npm run build",
"preinstall": "npx only-allow pnpm",
"postinstall": "simple-git-hooks"
},
This package is private and for testing only. It is used to verify edge cases for external libraries that build their types using Vue core types - e.g. Vuetify as in [#8376](https://github.com/vuejs/core/issues/8376).
-When running the `build-dts` task, this package's types are built alongside other packages. Then, during `test-dts-only` it is imported and used in [`packages/dts-test/built.test-d.ts`](https://github.com/vuejs/core/blob/main/packages/dts-test/built.test-d.ts) to verify that the built types work correctly.
+When running the `build-dts` task, this package's types are built alongside other packages. Then, during `test-dts-only` it is imported and used in [`packages-private/dts-test/built.test-d.ts`](https://github.com/vuejs/core/blob/main/packages-private/dts-test/built.test-d.ts) to verify that the built types work correctly.
{
- "name": "@vue/dts-built-test",
+ "name": "dts-built-test",
"private": true,
"version": "0.0.0",
"types": "dist/index.d.ts",
- This directory is included in the root `tsconfig.json`, where package imports are aliased to `src` directories, so in IDEs and the `pnpm check` script the types are validated against source code.
-- When running `tsc` with `packages/dts-test/tsconfig.test.json`, packages are resolved using normal `node` resolution, so the types are validated against actual **built** types. This requires the types to be built first via `pnpm build-dts`.
+- When running `tsc` with `packages-private/dts-test/tsconfig.test.json`, packages are resolved using normal `node` resolution, so the types are validated against actual **built** types. This requires the types to be built first via `pnpm build-dts`.
-import { CustomPropsNotErased } from '@vue/dts-built-test'
+import { CustomPropsNotErased } from 'dts-built-test/src/index'
import { describe, expectType } from './utils'
declare module 'vue' {
"version": "0.0.0",
"dependencies": {
"vue": "workspace:*",
- "@vue/dts-built-test": "workspace:*"
+ "dts-built-test": "workspace:*"
}
}
"serve": "vite preview"
},
"devDependencies": {
- "@vitejs/plugin-vue": "^5.1.2",
+ "@vitejs/plugin-vue": "catalog:",
"vite": "catalog:"
},
"dependencies": {
<Download />
</button>
<a
- href="https://github.com/vuejs/core/tree/main/packages/sfc-playground"
+ href="https://github.com/vuejs/core/tree/main/packages-private/sfc-playground"
target="_blank"
title="View on GitHub"
class="github"
name: 'copy-vue',
generateBundle() {
const copyFile = (file: string) => {
- const filePath = path.resolve(__dirname, file)
+ const filePath = path.resolve(__dirname, '../../packages', file)
const basename = path.basename(file)
if (!fs.existsSync(filePath)) {
throw new Error(
})
}
- copyFile(`../vue/dist/vue.esm-browser.js`)
- copyFile(`../vue/dist/vue.esm-browser.prod.js`)
- copyFile(`../vue/dist/vue.runtime.esm-browser.js`)
- copyFile(`../vue/dist/vue.runtime.esm-browser.prod.js`)
- copyFile(`../server-renderer/dist/server-renderer.esm-browser.js`)
+ copyFile(`vue/dist/vue.esm-browser.js`)
+ copyFile(`vue/dist/vue.esm-browser.prod.js`)
+ copyFile(`vue/dist/vue.runtime.esm-browser.js`)
+ copyFile(`vue/dist/vue.runtime.esm-browser.prod.js`)
+ copyFile(`server-renderer/dist/server-renderer.esm-browser.js`)
},
}
}
--- /dev/null
+<script setup>
+import { ref } from 'vue'
+
+const count = ref(0)
+</script>
+
+<template>
+ <button @click="count++">{{ count }}</button>
+</template>
+
+<style>
+button {
+ color: red;
+}
+</style>
--- /dev/null
+This package is used for debugging issues that are related to `@vitejs/plugin-vue`, or can only be reproduced in a Vite-based setup. It aims to be as close to production as possible so Vue packages are resolved to the dist files instead of source.
--- /dev/null
+<script type="module" src="./main.ts"></script>
+<div id="app"></div>
--- /dev/null
+import { createApp } from 'vue'
+import App from './App.vue'
+
+const app = createApp(App)
+
+app.mount('#app')
--- /dev/null
+{
+ "name": "vite-debug",
+ "private": true,
+ "type": "module",
+ "scripts": {
+ "dev": "vite",
+ "build": "vite build",
+ "serve": "vite preview"
+ },
+ "devDependencies": {
+ "@vitejs/plugin-vue": "catalog:",
+ "vite": "catalog:",
+ "vue": "workspace:*"
+ }
+}
--- /dev/null
+{
+ "compilerOptions": {
+ "module": "esnext",
+ "moduleResolution": "bundler"
+ },
+ "include": ["./*"]
+}
--- /dev/null
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+
+export default defineConfig({
+ plugins: [vue()],
+})
'@babel/types':
specifier: ^7.25.2
version: 7.25.2
+ '@vitejs/plugin-vue':
+ specifier: ^5.1.2
+ version: 5.1.2
estree-walker:
specifier: ^2.0.2
version: 2.0.2
specifier: ^2.0.0
version: 2.0.5(@types/node@20.14.14)(jsdom@24.1.1)(sass@1.77.8)
+ packages-private/dts-built-test:
+ dependencies:
+ '@vue/reactivity':
+ specifier: workspace:*
+ version: link:../../packages/reactivity
+ '@vue/shared':
+ specifier: workspace:*
+ version: link:../../packages/shared
+ vue:
+ specifier: workspace:*
+ version: link:../../packages/vue
+
+ packages-private/dts-test:
+ dependencies:
+ dts-built-test:
+ specifier: workspace:*
+ version: link:../dts-built-test
+ vue:
+ specifier: workspace:*
+ version: link:../../packages/vue
+
+ packages-private/sfc-playground:
+ dependencies:
+ '@vue/repl':
+ specifier: ^4.3.1
+ version: 4.3.1
+ file-saver:
+ specifier: ^2.0.5
+ version: 2.0.5
+ jszip:
+ specifier: ^3.10.1
+ version: 3.10.1
+ vue:
+ specifier: workspace:*
+ version: link:../../packages/vue
+ devDependencies:
+ '@vitejs/plugin-vue':
+ specifier: 'catalog:'
+ version: 5.1.2(vite@5.4.0(@types/node@20.14.14)(sass@1.77.8))(vue@packages+vue)
+ vite:
+ specifier: 'catalog:'
+ version: 5.4.0(@types/node@20.14.14)(sass@1.77.8)
+
+ packages-private/template-explorer:
+ dependencies:
+ monaco-editor:
+ specifier: ^0.50.0
+ version: 0.50.0
+ source-map-js:
+ specifier: ^1.2.0
+ version: 1.2.0
+
+ packages-private/vite-debug:
+ devDependencies:
+ '@vitejs/plugin-vue':
+ specifier: 'catalog:'
+ version: 5.1.2(vite@5.4.0(@types/node@20.14.14)(sass@1.77.8))(vue@packages+vue)
+ vite:
+ specifier: 'catalog:'
+ version: 5.4.0(@types/node@20.14.14)(sass@1.77.8)
+ vue:
+ specifier: workspace:*
+ version: link:../../packages/vue
+
packages/compiler-core:
dependencies:
'@babel/parser':
specifier: workspace:*
version: link:../shared
- packages/dts-built-test:
- dependencies:
- '@vue/reactivity':
- specifier: workspace:*
- version: link:../reactivity
- '@vue/shared':
- specifier: workspace:*
- version: link:../shared
- vue:
- specifier: workspace:*
- version: link:../vue
-
- packages/dts-test:
- dependencies:
- '@vue/dts-built-test':
- specifier: workspace:*
- version: link:../dts-built-test
- vue:
- specifier: workspace:*
- version: link:../vue
-
packages/reactivity:
dependencies:
'@vue/shared':
specifier: workspace:*
version: link:../vue
- packages/sfc-playground:
- dependencies:
- '@vue/repl':
- specifier: ^4.3.1
- version: 4.3.1
- file-saver:
- specifier: ^2.0.5
- version: 2.0.5
- jszip:
- specifier: ^3.10.1
- version: 3.10.1
- vue:
- specifier: workspace:*
- version: link:../vue
- devDependencies:
- '@vitejs/plugin-vue':
- specifier: ^5.1.2
- version: 5.1.2(vite@5.4.0(@types/node@20.14.14)(sass@1.77.8))(vue@packages+vue)
- vite:
- specifier: 'catalog:'
- version: 5.4.0(@types/node@20.14.14)(sass@1.77.8)
-
packages/shared: {}
- packages/template-explorer:
- dependencies:
- monaco-editor:
- specifier: ^0.50.0
- version: 0.50.0
- source-map-js:
- specifier: ^1.2.0
- version: 1.2.0
-
packages/vue:
dependencies:
'@vue/compiler-dom':
packages:
- 'packages/*'
+ - 'packages-private/*'
catalog:
'@babel/parser': ^7.25.3
'magic-string': ^0.30.11
'source-map-js': ^1.2.0
'vite': ^5.4.0
+ '@vitejs/plugin-vue': ^5.1.2
import assert from 'node:assert/strict'
import { createRequire } from 'node:module'
import { fileURLToPath } from 'node:url'
+import fs from 'node:fs'
import path from 'node:path'
import replace from '@rollup/plugin-replace'
import json from '@rollup/plugin-json'
const masterVersion = require('./package.json').version
const consolidatePkg = require('@vue/consolidate/package.json')
-const packagesDir = path.resolve(__dirname, 'packages')
+const privatePackages = fs.readdirSync('packages-private')
+const pkgBase = privatePackages.includes(process.env.TARGET)
+ ? `packages-private`
+ : `packages`
+const packagesDir = path.resolve(__dirname, pkgBase)
const packageDir = path.resolve(packagesDir, process.env.TARGET)
const resolve = (/** @type {string} */ p) => path.resolve(packageDir, p)
```
*/
-import fs from 'node:fs/promises'
+import fs from 'node:fs'
import { parseArgs } from 'node:util'
import { existsSync, readFileSync } from 'node:fs'
import path from 'node:path'
run()
async function run() {
- if (writeSize) await fs.mkdir(sizeDir, { recursive: true })
+ if (writeSize) fs.mkdirSync(sizeDir, { recursive: true })
const removeCache = scanEnums()
try {
const resolvedTargets = targets.length
return Promise.all(ret)
}
+const privatePackages = fs.readdirSync('packages-private')
+
/**
* Builds the target.
* @param {string} target - The target to build.
* @returns {Promise<void>} - A promise representing the build process.
*/
async function build(target) {
- const pkgDir = path.resolve(`packages/${target}`)
+ const pkgBase = privatePackages.includes(target)
+ ? `packages-private`
+ : `packages`
+ const pkgDir = path.resolve(`${pkgBase}/${target}`)
const pkg = JSON.parse(readFileSync(`${pkgDir}/package.json`, 'utf-8'))
// if this is a full build (no specific targets), ignore private packages
// if building a specific format, do not remove dist.
if (!formats && existsSync(`${pkgDir}/dist`)) {
- await fs.rm(`${pkgDir}/dist`, { recursive: true })
+ fs.rmSync(`${pkgDir}/dist`, { recursive: true })
}
const env =
if (!existsSync(filePath)) {
return
}
- const file = await fs.readFile(filePath)
+ const file = fs.readFileSync(filePath)
const fileName = path.basename(filePath)
const gzipped = gzipSync(file)
)
if (writeSize)
- await fs.writeFile(
+ fs.writeFileSync(
path.resolve(sizeDir, `${fileName}.json`),
JSON.stringify({
file: fileName,
const require = createRequire(import.meta.url)
-export const targets = fs.readdirSync('packages').filter(f => {
- if (
- !fs.statSync(`packages/${f}`).isDirectory() ||
- !fs.existsSync(`packages/${f}/package.json`)
- ) {
- return false
- }
- const pkg = require(`../packages/${f}/package.json`)
- if (pkg.private && !pkg.buildOptions) {
- return false
- }
- return true
-})
+export const targets = fs
+ .readdirSync('packages')
+ .filter(f => {
+ if (
+ !fs.statSync(`packages/${f}`).isDirectory() ||
+ !fs.existsSync(`packages/${f}/package.json`)
+ ) {
+ return false
+ }
+ const pkg = require(`../packages/${f}/package.json`)
+ if (pkg.private && !pkg.buildOptions) {
+ return false
+ }
+ return true
+ })
+ .concat('template-explorer')
/**
*
"include": [
"packages/global.d.ts",
"packages/*/src",
+ "packages-private/*/src",
"packages/runtime-dom/types/jsx.d.ts",
"packages/*/__tests__",
- "packages/dts-test",
+ "packages-private/dts-test",
"packages/vue/jsx-runtime",
"scripts/*",
"rollup.*.js"
],
- "exclude": ["packages/sfc-playground/src/vue-dev-proxy*"]
+ "exclude": ["packages-private/sfc-playground/src/vue-dev-proxy*"]
}
'packages/runtime-dom/src/components/Transition*',
// mostly entries
'packages/vue-compat/**',
- 'packages/sfc-playground/**',
+ 'packages-private/**',
'scripts/**',
],
},
projects / thirdparty / vuejs / core.git / commitdiff
