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

🚀 A webpack plugin for fast find source code.

import webpack from 'webpack';

/**
 * 插件配置选项 | 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;
    /**
     * 服务端配置 | Server Configuration
     */
    server?: {
        /**
         * HTTPS 安全传输层配置 | HTTPS Secure Transport Layer Configuration
         *
         * @see [TLS Context Options](https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions)
         *
         * @example
         * {
         *   key: '/path/to/private.key',
         *   cert: '/path/to/certificate.pem'
         * }
         */
        https?: {
            /**
             * PEM 格式的 SSL 私钥文件路径 | Path to PEM formatted SSL private key file
             *
             * @fileMustExist 文件必须存在且可读 | File must exist and be readable
             */
            key: string;
            /**
             * PEM 格式的 SSL 证书文件路径 | Path to PEM formatted SSL certificate file
             *
             * @fileMustExist 文件必须存在且可读 | File must exist and be readable
             */
            cert: string;
        };
    };
    /**
     * 自定义编辑器打开处理器 | 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;
}
/**
 * 开发环境专用的 Webpack 插件 | Webpack plugin dedicated for development environment
 *
 * @remarks 该插件用于在开发环境下提供组件调试能力，自动注入调试客户端并启动调试服务器
 *
 * @description Provides component debugging capabilities in dev environment,
 *              auto-injects debug client and starts debug server
 */
declare class OpenEditorPlugin {
    /**
     * 构造函数 | Constructor
     *
     * @param options 插件配置选项 | Plugin configuration options
     */
    constructor(options?: Options);
    /**
     * Webpack 插件入口方法 | Webpack plugin entry method
     *
     * @param compiler Webpack 编译器实例 | Webpack compiler instance
     *
     * @workflow
     * 1. 配置模块解析规则 | Configure module resolution rules
     * 2. 设置客户端模块别名 | Set client module alias
     * 3. 启动调试服务器 | Start debug server
     */
    apply(compiler: webpack.Compiler): void;
}

export { Options, OpenEditorPlugin as default };