feat!: rework dist file names

Author: antfu

docs/kit/rpc.md

@@ -115,9 +115,12 @@ When using `vite devtools build` to create a static DevTools build, the server c
 #### How It Works
 
 1. At build time, `dumpFunctions()` executes your RPC handlers with predefined arguments
-2. Results are stored in `.vdt-rpc-dump.json` in the build output
+2. Results are stored in `.rpc-dump/index.json` in the build output
 3. The static client reads from this JSON file instead of making live RPC calls
 
+Dump shard files are written to `.rpc-dump/*.json`. Function names in shard file keys replace `:` with `~` (for example `my-plugin:get-data` -> `my-plugin~get-data`).
+Query record maps are embedded directly in `.rpc-dump/index.json`; no per-function index files are generated.
+
 #### Static Functions (Recommended)
 
 Functions with `type: 'static'` are **automatically dumped** with no arguments:

packages/core/src/node/__tests__/static-dump.test.ts

@@ -1,11 +1,5 @@
 import { defineRpcFunction } from '@vitejs/devtools-kit'
-import {
-  DEVTOOLS_RPC_DUMP_QUERY_DIR,
-  DEVTOOLS_RPC_DUMP_QUERY_FALLBACK_FILENAME,
-  DEVTOOLS_RPC_DUMP_QUERY_INDEX_FILENAME,
-  DEVTOOLS_RPC_DUMP_QUERY_RECORDS_DIRNAME,
-  DEVTOOLS_RPC_DUMP_STATIC_DIR,
-} from '@vitejs/devtools-kit/constants'
+import { DEVTOOLS_RPC_DUMP_DIRNAME } from '@vitejs/devtools-kit/constants'
 import { describe, expect, it } from 'vitest'
 import { collectStaticRpcDump } from '../static-dump'
 
@@ -18,7 +12,7 @@ describe('collectStaticRpcDump', () => {
     })
 
     const result = await collectStaticRpcDump([getVersion], {})
-    const expectedPath = `${DEVTOOLS_RPC_DUMP_STATIC_DIR}/test%3Aget-version.json`
+    const expectedPath = `${DEVTOOLS_RPC_DUMP_DIRNAME}/test~get-version.static.json`
 
     expect(result.manifest['test:get-version']).toEqual({
       type: 'static',
@@ -44,26 +38,28 @@ describe('collectStaticRpcDump', () => {
     })
 
     const result = await collectStaticRpcDump([getItem], {})
-    const basePath = `${DEVTOOLS_RPC_DUMP_QUERY_DIR}/test%3Aget-item`
-    const queryRecordsPath = `${basePath}/${DEVTOOLS_RPC_DUMP_QUERY_RECORDS_DIRNAME}/`
-    const manifest = result.manifest['test:get-item'] as { type: 'query', index: string }
-    const index = result.files[manifest.index] as {
+    const basePath = `${DEVTOOLS_RPC_DUMP_DIRNAME}/test~get-item`
+    const manifest = result.manifest['test:get-item'] as {
+      type: 'query'
       records: Record<string, string>
       fallback?: string
     }
 
     expect(manifest).toEqual({
       type: 'query',
-      index: `${basePath}/${DEVTOOLS_RPC_DUMP_QUERY_INDEX_FILENAME}`,
+      records: expect.any(Object),
+      fallback: `${basePath}.fallback.json`,
     })
-    expect(Object.keys(index.records)).toHaveLength(2)
-    expect(index.fallback).toBe(`${basePath}/${DEVTOOLS_RPC_DUMP_QUERY_FALLBACK_FILENAME}`)
+    expect(Object.keys(manifest.records)).toHaveLength(2)
 
-    const recordPaths = Object.values(index.records)
+    const recordPaths = Object.values(manifest.records)
     for (const path of recordPaths) {
-      expect(path.startsWith(queryRecordsPath)).toBe(true)
+      expect(path.startsWith(`${basePath}.record.`)).toBe(true)
+      expect(path.endsWith('.json')).toBe(true)
       expect(path in result.files).toBe(true)
     }
+
+    expect(Object.keys(result.files).some(path => path.endsWith('.index.json'))).toBe(false)
   })
 
   it('skips query functions without dump config', async () => {

packages/core/src/node/cli-commands.ts

@@ -8,7 +8,7 @@ import {
   DEVTOOLS_DIRNAME,
   DEVTOOLS_DOCK_IMPORTS_FILENAME,
   DEVTOOLS_MOUNT_PATH,
-  DEVTOOLS_RPC_DUMP_API_DIRNAME,
+  DEVTOOLS_RPC_DUMP_DIRNAME,
   DEVTOOLS_RPC_DUMP_MANIFEST_FILENAME,
 } from '@vitejs/devtools-kit/constants'
 import c from 'ansis'
@@ -104,7 +104,7 @@ export async function build(options: BuildOptions) {
     await fs.cp(distDir, join(outDir, baseUrl), { recursive: true })
   }
 
-  await fs.mkdir(resolve(devToolsRoot, DEVTOOLS_RPC_DUMP_API_DIRNAME), { recursive: true })
+  await fs.mkdir(resolve(devToolsRoot, DEVTOOLS_RPC_DUMP_DIRNAME), { recursive: true })
   await fs.writeFile(resolve(devToolsRoot, DEVTOOLS_CONNECTION_META_FILENAME), JSON.stringify({ backend: 'static' }, null, 2), 'utf-8')
   await fs.writeFile(resolve(devToolsRoot, DEVTOOLS_DOCK_IMPORTS_FILENAME), renderDockImportsMap(devtools.context.docks.values()), 'utf-8')
 

packages/core/src/node/static-dump.ts

@@ -1,10 +1,6 @@
 import type { RpcDumpRecord, RpcFunctionDefinitionAny } from '@vitejs/devtools-rpc'
 import {
-  DEVTOOLS_RPC_DUMP_QUERY_DIR,
-  DEVTOOLS_RPC_DUMP_QUERY_FALLBACK_FILENAME,
-  DEVTOOLS_RPC_DUMP_QUERY_INDEX_FILENAME,
-  DEVTOOLS_RPC_DUMP_QUERY_RECORDS_DIRNAME,
-  DEVTOOLS_RPC_DUMP_STATIC_DIR,
+  DEVTOOLS_RPC_DUMP_DIRNAME,
 } from '@vitejs/devtools-kit/constants'
 import { dumpFunctions, getRpcHandler } from '@vitejs/devtools-rpc'
 
@@ -15,7 +11,8 @@ export interface StaticRpcDumpManifestStaticEntry {
 
 export interface StaticRpcDumpManifestQueryEntry {
   type: 'query'
-  index: string
+  records: Record<string, string>
+  fallback?: string
 }
 
 export type StaticRpcDumpManifestValue
@@ -30,24 +27,20 @@ export interface StaticRpcDumpCollection {
   files: Record<string, any>
 }
 
-function encodeName(name: string): string {
-  return encodeURIComponent(name)
+function makeDumpKey(name: string): string {
+  return encodeURIComponent(name.replaceAll(':', '~'))
 }
 
 function makeStaticPath(name: string): string {
-  return `${DEVTOOLS_RPC_DUMP_STATIC_DIR}/${encodeName(name)}.json`
-}
-
-function makeQueryIndexPath(name: string): string {
-  return `${DEVTOOLS_RPC_DUMP_QUERY_DIR}/${encodeName(name)}/${DEVTOOLS_RPC_DUMP_QUERY_INDEX_FILENAME}`
+  return `${DEVTOOLS_RPC_DUMP_DIRNAME}/${makeDumpKey(name)}.static.json`
 }
 
 function makeQueryRecordPath(name: string, hash: string): string {
-  return `${DEVTOOLS_RPC_DUMP_QUERY_DIR}/${encodeName(name)}/${DEVTOOLS_RPC_DUMP_QUERY_RECORDS_DIRNAME}/${hash}.json`
+  return `${DEVTOOLS_RPC_DUMP_DIRNAME}/${makeDumpKey(name)}.record.${hash}.json`
 }
 
 function makeQueryFallbackPath(name: string): string {
-  return `${DEVTOOLS_RPC_DUMP_QUERY_DIR}/${encodeName(name)}/${DEVTOOLS_RPC_DUMP_QUERY_FALLBACK_FILENAME}`
+  return `${DEVTOOLS_RPC_DUMP_DIRNAME}/${makeDumpKey(name)}.fallback.json`
 }
 
 async function resolveRecord(record: RpcDumpRecord | (() => Promise<RpcDumpRecord>)): Promise<RpcDumpRecord> {
@@ -87,11 +80,8 @@ export async function collectStaticRpcDump(
     if (!(definition.name in store.definitions))
       continue
 
-    const indexPath = makeQueryIndexPath(definition.name)
-    const index: {
-      records: Record<string, string>
-      fallback?: string
-    } = {
+    const queryEntry: StaticRpcDumpManifestQueryEntry = {
+      type: 'query',
       records: {},
     }
 
@@ -107,23 +97,19 @@ export async function collectStaticRpcDump(
       if (key === 'fallback') {
         const path = makeQueryFallbackPath(definition.name)
         files[path] = record
-        index.fallback = path
+        queryEntry.fallback = path
       }
       else {
         const path = makeQueryRecordPath(definition.name, key)
         files[path] = record
-        index.records[key] = path
+        queryEntry.records[key] = path
       }
     }
 
-    if (!Object.keys(index.records).length && !index.fallback)
+    if (!Object.keys(queryEntry.records).length && !queryEntry.fallback)
       continue
 
-    files[indexPath] = index
-    manifest[definition.name] = {
-      type: 'query',
-      index: indexPath,
-    }
+    manifest[definition.name] = queryEntry
   }
 
   return {

packages/kit/src/client/static-rpc.test.ts

@@ -1,19 +1,12 @@
 import { hash } from 'ohash'
 import { describe, expect, it } from 'vitest'
-import {
-  DEVTOOLS_RPC_DUMP_QUERY_DIR,
-  DEVTOOLS_RPC_DUMP_QUERY_FALLBACK_FILENAME,
-  DEVTOOLS_RPC_DUMP_QUERY_INDEX_FILENAME,
-  DEVTOOLS_RPC_DUMP_QUERY_RECORDS_DIRNAME,
-  DEVTOOLS_RPC_DUMP_STATIC_DIR,
-} from '../constants'
+import { DEVTOOLS_RPC_DUMP_DIRNAME } from '../constants'
 import { createStaticRpcCaller } from './static-rpc'
 
-const DEMO_STATIC_VERSION_PATH = `${DEVTOOLS_RPC_DUMP_STATIC_DIR}/demo%3Aversion.json`
-const DEMO_QUERY_BASE_PATH = `${DEVTOOLS_RPC_DUMP_QUERY_DIR}/demo%3Aget-item`
-const DEMO_QUERY_INDEX_PATH = `${DEMO_QUERY_BASE_PATH}/${DEVTOOLS_RPC_DUMP_QUERY_INDEX_FILENAME}`
-const DEMO_QUERY_RECORDS_PATH = `${DEMO_QUERY_BASE_PATH}/${DEVTOOLS_RPC_DUMP_QUERY_RECORDS_DIRNAME}`
-const DEMO_QUERY_FALLBACK_PATH = `${DEMO_QUERY_BASE_PATH}/${DEVTOOLS_RPC_DUMP_QUERY_FALLBACK_FILENAME}`
+const DEMO_STATIC_VERSION_PATH = `${DEVTOOLS_RPC_DUMP_DIRNAME}/demo~version.static.json`
+const DEMO_QUERY_BASE_PATH = `${DEVTOOLS_RPC_DUMP_DIRNAME}/demo~get-item`
+const DEMO_QUERY_RECORDS_PATH = `${DEMO_QUERY_BASE_PATH}.record`
+const DEMO_QUERY_FALLBACK_PATH = `${DEMO_QUERY_BASE_PATH}.fallback.json`
 
 describe('createStaticRpcCaller', () => {
   it('loads static rpc shards lazily and caches by file path', async () => {
@@ -41,26 +34,21 @@ describe('createStaticRpcCaller', () => {
       {
         'demo:get-item': {
           type: 'query',
-          index: DEMO_QUERY_INDEX_PATH,
+          records: {
+            [hash(['a'])]: `${DEMO_QUERY_RECORDS_PATH}.ok.json`,
+            [hash(['boom'])]: `${DEMO_QUERY_RECORDS_PATH}.error.json`,
+          },
+          fallback: DEMO_QUERY_FALLBACK_PATH,
         },
       },
       async (path) => {
-        if (path === DEMO_QUERY_INDEX_PATH) {
-          return {
-            records: {
-              [hash(['a'])]: `${DEMO_QUERY_RECORDS_PATH}/ok.json`,
-              [hash(['boom'])]: `${DEMO_QUERY_RECORDS_PATH}/error.json`,
-            },
-            fallback: DEMO_QUERY_FALLBACK_PATH,
-          }
-        }
-        if (path.endsWith('/ok.json')) {
+        if (path.endsWith('.ok.json')) {
           return {
             inputs: ['a'],
             output: { id: 'a' },
           }
         }
-        if (path.endsWith('/error.json')) {
+        if (path.endsWith('.error.json')) {
           return {
             inputs: ['boom'],
             error: {
@@ -69,7 +57,7 @@ describe('createStaticRpcCaller', () => {
             },
           }
         }
-        if (path.endsWith('/fallback.json')) {
+        if (path.endsWith('.fallback.json')) {
           return {
             inputs: [],
             output: null,

packages/kit/src/client/static-rpc.ts

@@ -7,7 +7,8 @@ export interface StaticRpcManifestStaticEntry {
 
 export interface StaticRpcManifestQueryEntry {
   type: 'query'
-  index: string
+  records: Record<string, string>
+  fallback?: string
 }
 
 export type StaticRpcManifestEntry
@@ -26,11 +27,6 @@ export interface StaticRpcRecord {
   }
 }
 
-export interface StaticRpcQueryIndex {
-  records: Record<string, string>
-  fallback?: string
-}
-
 function isStaticEntry(value: unknown): value is StaticRpcManifestStaticEntry {
   return typeof value === 'object'
     && value !== null
@@ -42,7 +38,8 @@ function isQueryEntry(value: unknown): value is StaticRpcManifestQueryEntry {
   return typeof value === 'object'
     && value !== null
     && (value as any).type === 'query'
-    && typeof (value as any).index === 'string'
+    && typeof (value as any).records === 'object'
+    && (value as any).records !== null
 }
 
 function isRecord(value: unknown): value is StaticRpcRecord {
@@ -65,7 +62,6 @@ export function createStaticRpcCaller(
   fetchJson: (path: string) => Promise<any>,
 ) {
   const staticCache = new Map<string, Promise<any>>()
-  const queryIndexCache = new Map<string, Promise<StaticRpcQueryIndex>>()
   const queryRecordCache = new Map<string, Promise<StaticRpcRecord>>()
 
   async function loadStatic(entry: StaticRpcManifestStaticEntry): Promise<any> {
@@ -79,13 +75,6 @@ export function createStaticRpcCaller(
     return data
   }
 
-  async function loadQueryIndex(entry: StaticRpcManifestQueryEntry): Promise<StaticRpcQueryIndex> {
-    if (!queryIndexCache.has(entry.index)) {
-      queryIndexCache.set(entry.index, fetchJson(entry.index))
-    }
-    return await queryIndexCache.get(entry.index)!
-  }
-
   async function loadQueryRecord(path: string): Promise<StaticRpcRecord> {
     if (!queryRecordCache.has(path)) {
       queryRecordCache.set(path, fetchJson(path))
@@ -109,17 +98,16 @@ export function createStaticRpcCaller(
     }
 
     if (isQueryEntry(entry)) {
-      const index = await loadQueryIndex(entry)
       const argsHash = hash(args)
-      const recordPath = index.records[argsHash]
+      const recordPath = entry.records[argsHash]
 
       if (recordPath) {
         const record = await loadQueryRecord(recordPath)
         return resolveRecordOutput(record)
       }
 
-      if (index.fallback) {
-        const fallback = await loadQueryRecord(index.fallback)
+      if (entry.fallback) {
+        const fallback = await loadQueryRecord(entry.fallback)
         return resolveRecordOutput(fallback)
       }
 

packages/kit/src/constants.ts

@@ -5,17 +5,11 @@ export const DEVTOOLS_MOUNT_PATH = '/.devtools/'
 export const DEVTOOLS_MOUNT_PATH_NO_TRAILING_SLASH = '/.devtools'
 export const DEVTOOLS_DIRNAME = '.devtools'
 
-export const DEVTOOLS_CONNECTION_META_FILENAME = '.vdt-connection.json'
-export const DEVTOOLS_RPC_DUMP_MANIFEST_FILENAME = '.vdt-rpc-dump.json'
-export const DEVTOOLS_DOCK_IMPORTS_FILENAME = '.devtools-imports.js'
-export const DEVTOOLS_DOCK_IMPORTS_VIRTUAL_ID = '/.devtools-imports'
-export const DEVTOOLS_RPC_DUMP_API_DIRNAME = 'api'
-
-export const DEVTOOLS_RPC_DUMP_STATIC_DIR = 'api/rpc/static'
-export const DEVTOOLS_RPC_DUMP_QUERY_DIR = 'api/rpc/query'
-export const DEVTOOLS_RPC_DUMP_QUERY_RECORDS_DIRNAME = 'records'
-export const DEVTOOLS_RPC_DUMP_QUERY_INDEX_FILENAME = 'index.json'
-export const DEVTOOLS_RPC_DUMP_QUERY_FALLBACK_FILENAME = 'fallback.json'
+export const DEVTOOLS_CONNECTION_META_FILENAME = '.connection.json'
+export const DEVTOOLS_RPC_DUMP_MANIFEST_FILENAME = '.rpc-dump/index.json'
+export const DEVTOOLS_DOCK_IMPORTS_FILENAME = '.client-imports.js'
+export const DEVTOOLS_DOCK_IMPORTS_VIRTUAL_ID = '/.devtools/client-imports'
+export const DEVTOOLS_RPC_DUMP_DIRNAME = '.rpc-dump'
 
 export const DEFAULT_CATEGORIES_ORDER: Record<string, number> = {
   '~viteplus': -1000,