@smile-design/inspector-plugin
v0.2.0
Published
Vite plugin + browser runtime for smile-design DOM Inspector — injects data-smile-src into JSX and auto-installs the inspector runtime in dev preview iframes.
Maintainers
Readme
@smile-design/inspector-plugin
Vite plugin + browser runtime for smile-design DOM Inspector — injects data-smile-src into JSX and auto-installs the inspector runtime inside dev preview iframes.
Use this plugin when you want smile-design to edit your own project(BYOP — Bring Your Own Project)instead of a scaffolded one.
Install
pnpm add -D @smile-design/inspector-pluginUse (Vite)
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import { smileSrc } from '@smile-design/inspector-plugin';
export default defineConfig({
plugins: [smileSrc(), react()],
});smileSrc() returns two plugins as an array:
smile-design:smile-src— addsdata-smile-src="<file>:<line>:<col>"to every JSX opening tag in dev mode (ignored in production build)smile-design:inspector-runtime— injects a<script type="module">into<head>that loads the browser runtime
Need finer control? Use them individually:
import {
smileSrcVitePlugin,
smileInspectorRuntimeVitePlugin,
} from '@smile-design/inspector-plugin';
export default defineConfig({
plugins: [smileSrcVitePlugin(), /* no runtime */ react()],
});Options
smileSrc({
includeComponents: false, // default: false — skip uppercase component tags
pathMode: 'absolute', // default: 'absolute'
cwd: process.cwd(), // used when pathMode === 'relative'
});Requirements
- Vite ≥ 5
- Browser runtime assumes
window/document— the plugin is dev-only (apply: 'serve')
Changelog
0.2.0
- Fix: iframe runtime now accepts
inspector:set-styleandinspector:reset-stylemessages, so live style edits performed in the smile-design Web UI (or any host driving the runtime) are applied / reverted on the inspected element. Without this fix, BYOP users reported that style tweaks made in the inspector panel had no effect on the preview — seepitfalls/inspector-plugin-npm-version-stale.mdfor the full history. - No public API changes; existing
smileSrc()/smileSrcVitePlugin()/smileInspectorRuntimeVitePlugin()exports are unchanged. Safe drop-in upgrade.
0.1.0
- Initial public release:
smileSrc()Vite plugin pair (source-map injection + iframe runtime auto-install) plus standalonesmileSrcVitePlugin()/smileInspectorRuntimeVitePlugin()exports.
License
MIT
