UNPKG

one

Version:

One is a new React Framework that makes Vite serve both native and web.

359 lines (296 loc) 11.9 kB
import { spawn } from 'node:child_process' import { existsSync } from 'node:fs' import path from 'node:path' import { parse } from 'oxc-parser' import type { Plugin, ViteDevServer } from 'vite' import { normalizePath } from 'vite' import type { WebSocket } from 'ws' interface JsxLocation { /** Position right after the tag name where we insert the attribute */ insertOffset: number /** Line number for editor navigation */ line: number /** Column number for editor navigation */ column: number } /** * Parse code with oxc and find all JSX opening elements. */ // lowercase jsx tags are host elements. on the web only real html and svg // tags accept a data attribute; other lowercase tags belong to a custom // reconciler (react-three-fiber's <mesh>, <group>, <instancedMesh>...) which // applies props to plain objects and throws on the dashed attribute. const DOM_TAGS = new Set( ( 'a abbr address area article aside audio b base bdi bdo blockquote body br button canvas caption cite code col colgroup data datalist dd del details dfn dialog div dl dt em embed fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header hgroup hr html i iframe img input ins kbd label legend li link main map mark menu meta meter nav noscript object ol optgroup option output p picture pre progress q rp rt ruby s samp script search section select slot small source span strong style sub summary sup table tbody td template textarea tfoot th thead time title tr track u ul var video wbr ' + 'svg animate animateMotion animateTransform circle clipPath defs desc ellipse feBlend feColorMatrix feComponentTransfer feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap feDistantLight feDropShadow feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur feImage feMerge feMergeNode feMorphology feOffset fePointLight feSpecularLighting feSpotLight feTile feTurbulence filter foreignObject g image line linearGradient marker mask metadata mpath path pattern polygon polyline radialGradient rect set stop switch symbol text textPath tspan use view' ).split(' ') ) function isHostTag(tagName: string): boolean { const first = tagName.charCodeAt(0) return first >= 97 && first <= 122 && !tagName.includes('.') } async function findJsxElements(code: string, filename: string): Promise<JsxLocation[]> { const result = await parse(filename, code) if (result.errors.length > 0) { return [] } const locations: JsxLocation[] = [] function getJsxName(node: any): string | null { if (!node) return null if (node.type === 'JSXIdentifier') return node.name if (node.type === 'JSXMemberExpression') { const obj = getJsxName(node.object) return obj ? `${obj}.${node.property?.name}` : null } return null } function getLocation(offset: number): { line: number; column: number } { const before = code.slice(0, offset) const lines = before.split('\n') return { line: lines.length, column: lines[lines.length - 1]!.length + 1, } } function walk(node: any): void { if (!node || typeof node !== 'object') return if (node.type === 'JSXOpeningElement' && node.name) { const tagName = getJsxName(node.name) // skip Fragment, non-dom host elements, and already-tagged elements if ( tagName && tagName !== 'Fragment' && !tagName.endsWith('.Fragment') && (!isHostTag(tagName) || DOM_TAGS.has(tagName)) ) { const hasSourceAttr = node.attributes?.some( (attr: any) => attr.type === 'JSXAttribute' && attr.name?.name === 'data-one-source' ) if (!hasSourceAttr) { const nameEnd = node.name.end const loc = getLocation(node.start) locations.push({ insertOffset: nameEnd, line: loc.line, column: loc.column, }) } } } for (const key of Object.keys(node)) { if (key === 'parent') continue const value = node[key] if (Array.isArray(value)) { for (const child of value) { walk(child) } } else if (value && typeof value === 'object') { walk(value) } } } walk(result.program) return locations.sort((a, b) => b.insertOffset - a.insertOffset) } type TransformOut = { code: string; map?: null } | undefined export function getSourceInspectorPath(filePath: string, cwd = process.cwd()): string { const normalizedFilePath = normalizePath(filePath) const normalizedCwd = normalizePath(cwd) if (normalizedFilePath === normalizedCwd) { return '/' } if (normalizedFilePath.startsWith(`${normalizedCwd}/`)) { return normalizedFilePath.slice(normalizedCwd.length) } return normalizedFilePath } export function resolveEditorFilePath( filePath: string, cwd = process.cwd(), fileExists: (path: string) => boolean = existsSync ): string { // mirror sibling getSourceInspectorPath which already normalizes const projectPath = normalizePath(path.join(cwd, filePath)) // data-one-source uses "/foo.tsx" for project-relative paths, but files outside // cwd are stored as absolute paths and must not be re-joined onto cwd. return fileExists(projectPath) ? projectPath : filePath } /** * Transforms JSX to inject data-one-source attributes using oxc-parser. */ export async function injectSourceToJsx(code: string, id: string): Promise<TransformOut> { const [filePath] = id.split('?') if (!filePath) return const location = getSourceInspectorPath(filePath) // Quick check - skip if no JSX-like content if (!code.includes('<') || !code.includes('>')) { return } const jsxLocations = await findJsxElements(code, filePath) if (jsxLocations.length === 0) { return } let result = code // Insert from end to start to preserve offsets for (const jsx of jsxLocations) { const sourceAttr = ` data-one-source="${location}:${jsx.line}:${jsx.column}"` result = result.slice(0, jsx.insertOffset) + sourceAttr + result.slice(jsx.insertOffset) } return { code: result, map: null } } let editorWarned = false // editor cli → args builder const editorArgs: Record<string, (file: string, line: string, col: string) => string[]> = { code: (f, l, c) => ['-g', `${f}:${l}:${c}`], cursor: (f, l, c) => ['-g', `${f}:${l}:${c}`], codium: (f, l, c) => ['-g', `${f}:${l}:${c}`], vscodium: (f, l, c) => ['-g', `${f}:${l}:${c}`], zed: (f, l, c) => [`${f}:${l}:${c}`], subl: (f, l, c) => [`${f}:${l}:${c}`], webstorm: (f, l, c) => ['--line', l, '--column', c, f], idea: (f, l, c) => ['--line', l, '--column', c, f], vim: (f, l) => [`+${l}`, f], nvim: (f, l) => [`+${l}`, f], emacs: (f, l, c) => [`+${l}:${c}`, f], } function openInEditor( editor: string | undefined, filePath: string, line?: string, column?: string ): void { const resolved = editor || process.env.LAUNCH_EDITOR || process.env.EDITOR if (!resolved) { if (!editorWarned) { editorWarned = true console.warn( `[one] Set devtools.editor in your one config or LAUNCH_EDITOR env var to open files from the inspector (e.g. 'cursor', 'code', 'zed')` ) } return } const fullPath = resolveEditorFilePath(filePath) const l = line || '1' const c = column || '1' const buildArgs = editorArgs[resolved] const args = buildArgs ? buildArgs(fullPath, l, c) : [fullPath] const child = spawn(resolved, args, { stdio: 'ignore', detached: true }) child.unref() child.on('error', (err) => { console.warn( `[one:source-inspector] Failed to open editor '${resolved}': ${err.message}` ) }) } // track connected vscode clients and browser clients const vscodeClients = new Set<WebSocket>() export function sourceInspectorPlugin(opts?: { editor?: string }): Plugin[] { const cache = new Map<string, TransformOut>() return [ // Transform plugin - injects data-one-source attributes { name: 'one:source-inspector-transform', enforce: 'pre', apply: 'serve', transform: { // must run before clientTreeShakePlugin which also uses order: 'pre' // (within same order, plugin array position determines precedence) order: 'pre', async handler(code, id) { const envName = this.environment?.name // skip native environments only - transform both client and SSR for consistency if (envName === 'ios' || envName === 'android') return if ( id.includes('node_modules') || id.includes('?raw') || id.includes('dist') || id.includes('build') ) { return } if (!id.endsWith('.jsx') && !id.endsWith('.tsx')) return if (cache.has(code)) { return cache.get(code) } const out = await injectSourceToJsx(code, id) cache.set(code, out) if (cache.size > 100) { cache.clear() } return out }, }, }, // Note: Inspector UI script is now injected via DevHead.tsx for SSR compatibility // Server plugin - handles open-source requests and cursor WebSocket { name: 'one:source-inspector-server', apply: 'serve', configureServer(server: ViteDevServer) { // set up websocket server for vscode cursor position let wss: InstanceType<typeof import('ws').WebSocketServer> | null = null import('ws').then(({ WebSocketServer }) => { wss = new WebSocketServer({ noServer: true }) server.httpServer?.on('upgrade', (req, socket, head) => { if (req.url !== '/__one/cursor') return wss!.handleUpgrade(req, socket, head, (ws) => { vscodeClients.add(ws) ws.on('message', (data) => { try { const message = JSON.parse(data.toString()) // broadcast cursor position to browser via HMR if (message.type === 'cursor-position') { server.hot.send('one:cursor-highlight', { file: message.file, line: message.line, column: message.column, }) } else if (message.type === 'cursor-clear') { server.hot.send('one:cursor-highlight', { clear: true }) } } catch { // ignore parse errors } }) ws.on('close', () => { vscodeClients.delete(ws) // clear highlight when vscode disconnects server.hot.send('one:cursor-highlight', { clear: true }) }) }) }) }) server.middlewares.use(async (req, res, next) => { if (!req.url?.startsWith('/__one/open-source')) { return next() } try { const url = new URL(req.url, 'http://localhost') const source = url.searchParams.get('source') if (!source) { res.statusCode = 400 res.end('Missing source parameter') return } // Parse the source - format is "filePath:line:column" const parts = source.split(':') const column = parts.pop()! const line = parts.pop()! const filePath = parts.join(':') openInEditor(opts?.editor, filePath, line, column) res.statusCode = 200 res.end('OK') } catch (err) { console.error('[one:source-inspector] Error:', err) res.statusCode = 500 res.end('Internal server error') } }) }, }, ] }