@open-editor/vite/dist/index.d.ts

🚀 A vite plugin for fast find source code.

import { ViteDevServer } from 'vite';

/**
 * 插件配置选项 | Plugin Configuration Options
 */
interface Options {
    /**
     * 源代码根目录路径 | Source code root directory path
     *
     * @default `process.cwd()`
     *
     * @example
     * ```ts
     * rootDir: path.resolve(__dirname, 'src')
     * ```
     */
    rootDir?: string;
    /**
     * 在浏览器显示切换按钮 | Display toggle button in browser
     *
     * @default `true`
     *
     * @remarks
     * 控制是否在页面右下角显示调试开关 | Controls whether to show debug toggle at bottom-right corner
     */
    displayToggle?: boolean;
    /**
     * 禁用 CSS 悬停效果 | Disable CSS hover effects
     *
     * @default `true`
     *
     * @remarks
     * 当检查器启用时禁用元素悬停高亮 | Disable element highlighting on hover when inspector is active
     */
    disableHoverCSS?: boolean;
    /**
     * 忽略指定目录的组件 | Ignore components in specified directories
     *
     * @default `'\/**\/node_modules\/**\/*'`
     *
     * @see [Glob Pattern Syntax](https://en.wikipedia.org/wiki/Glob_(programming))
     *
     * @remarks
     * 使用 glob 模式匹配需要忽略的路径 | Use glob patterns to match ignored paths
     */
    ignoreComponents?: string | string[];
    /**
     * 单次检查模式 | Single-inspection mode
     *
     * @default `true`
     *
     * @remarks
     * 打开编辑器或组件树后自动退出检查状态 | Automatically exit inspection after opening editor or component tree
     */
    once?: boolean;
    /**
     * 跨 iframe 交互支持 | Cross-iframe interaction
     *
     * @default `true`
     *
     * @remarks
     * 允许在子 iframe 中提升操作到父窗口（仅限同源）| Enable elevating operations from child iframes to parent window (same-origin only)
     */
    crossIframe?: boolean;
    /**
     * 自定义编辑器打开处理器 | Custom editor opening handler
     *
     * @default `内置的 launch-editor 实现 | Built-in launch-editor implementation`
     *
     * @remarks
     * 覆盖默认的文件打开逻辑 | Override default file opening behavior
     */
    onOpenEditor?(file: string, errorCallback: (errorMessage: string) => void): void;
}
/**
 * Vite 插件：开发环境下启用组件源码定位功能 | Vite Plugin: Enable component source code location in development
 *
 * @param options - 插件配置选项 | Plugin configuration options
 *
 * @returns Vite 插件对象 | Vite plugin instance
 *
 * @remarks
 * 技术实现要点 | Technical highlights:
 * - 虚拟模块处理客户端配置注入 | Virtual module handling for client config injection
 * - 中间件处理编辑器打开请求 | Middleware handling editor opening requests
 * - 开发环境专属优化 | Development environment optimizations
 */
declare function OpenEditorPlugin(options?: Options): {
    name: string;
    apply?: undefined;
    /**
     * 开发服务器配置 | Dev server configuration
     *
     * @remarks
     * 注册中间件处理编辑器打开请求 | Register middleware to handle editor opening requests
     */
    configureServer?: undefined;
    /**
     * 模块解析逻辑 | Module resolution logic
     *
     * @remarks
     * 处理客户端模块的虚拟路径映射 | Handle virtual path mapping for client module
     */
    resolveId?: undefined;
    /**
     * 代码转换逻辑 | Code transformation
     *
     * @remarks
     * 向客户端注入运行时配置 | Inject runtime configuration into client code
     */
    transform?: undefined;
} | {
    name: string;
    apply: "serve";
    /**
     * 开发服务器配置 | Dev server configuration
     *
     * @remarks
     * 注册中间件处理编辑器打开请求 | Register middleware to handle editor opening requests
     */
    configureServer(server: Pick<ViteDevServer, 'middlewares'>): void;
    /**
     * 模块解析逻辑 | Module resolution logic
     *
     * @remarks
     * 处理客户端模块的虚拟路径映射 | Handle virtual path mapping for client module
     */
    resolveId(id: any): string | undefined;
    /**
     * 代码转换逻辑 | Code transformation
     *
     * @remarks
     * 向客户端注入运行时配置 | Inject runtime configuration into client code
     */
    transform(code: string, id: string): string | undefined;
};

export { Options, OpenEditorPlugin as default };