@simple-code-inspector/core 1.6.1

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@simple-code-inspector/core",
+  "version": "1.6.1",
+  "main": "dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "types/index.d.ts",
+  "files": [
+    "dist",
+    "types"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "repository": "git@github.com:lakphy/simple-code-inspector.git",
+  "author": "lakphy",
+  "license": "MIT",
+  "homepage": "https://inspector.fe-dev.cn/en",
+  "description": "Click the dom on the page, it will copy the source code location of the dom to your clipboard.",
+  "keywords": [
+    "webpack",
+    "vite",
+    "plugin",
+    "vue",
+    "clipboard",
+    "inspector",
+    "inspect"
+  ],
+  "bugs": {
+    "url": "https://github.com/lakphy/simple-code-inspector/issues"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build:server": "vite build",
+    "build:client": " vite build --config ./vite.client.config.ts",
+    "build:client:watch": " vite build --config ./vite.client.config.ts --watch",
+    "clear": "rimraf ./dist && rimraf ./types",
+    "build": "pnpm clear && tsc && pnpm build:server && pnpm build:client",
+    "pub": "pnpm publish",
+    "pub:beta": "pnpm publish --tag beta"
+  },
+  "dependencies": {
+    "@vue/compiler-dom": "^3.5.13",
+    "chalk": "^4.1.1",
+    "dotenv": "^16.1.4",
+    "portfinder": "^1.0.28"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.3",
+    "@babel/plugin-proposal-decorators": "^7.22.7",
+    "@babel/plugin-syntax-import-meta": "^7.10.4",
+    "@babel/plugin-transform-typescript": "^7.21.3",
+    "@types/node": "^18.14.1",
+    "@vue/babel-plugin-jsx": "^1.1.1",
+    "@vue/compiler-sfc": "^3.3.4",
+    "lit": "^2.6.1",
+    "magic-string": "^0.30.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "svelte": "^4.2.7",
+    "typescript": "^4.9.3",
+    "vite": "^4.3.9",
+    "vite-plugin-node-stdlib-browser": "^0.2.1",
+    "volar-service-pug": "^0.0.63"
+  }
+}

package/types/client/index.d.ts

@@ -0,0 +1,173 @@
+import { LitElement, TemplateResult } from 'lit';
+interface Position {
+    left?: string;
+    right?: string;
+    top?: string;
+    bottom?: string;
+    transform?: string;
+    maxHeight?: string;
+}
+interface SourceInfo {
+    name: string;
+    path: string;
+    line: number;
+    column: number;
+}
+interface ElementTipStyle {
+    vertical: string;
+    horizon: string;
+    visibility: string;
+    additionStyle?: {
+        transform: string;
+    };
+}
+interface TreeNode extends SourceInfo {
+    children: TreeNode[];
+    element: HTMLElement;
+    depth: number;
+}
+interface ActiveNode {
+    top?: string;
+    bottom?: string;
+    left?: string;
+    width?: string;
+    content?: string;
+    visibility?: 'visible' | 'hidden';
+    class?: 'tooltip-top' | 'tooltip-bottom';
+}
+export declare class CodeInspectorComponent extends LitElement {
+    hotKeys: string;
+    port: number;
+    showSwitch: boolean;
+    autoToggle: boolean;
+    hideConsole: boolean;
+    targetNode: HTMLElement | null;
+    ip: string;
+    serverEnabled: boolean;
+    private wheelThrottling;
+    position: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+        padding: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        border: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        margin: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+    };
+    element: {
+        name: string;
+        line: number;
+        column: number;
+        path: string;
+    };
+    elementTipStyle: ElementTipStyle;
+    show: boolean;
+    showNodeTree: boolean;
+    nodeTreePosition: Position;
+    nodeTree: TreeNode | null;
+    dragging: boolean;
+    mousePosition: {
+        baseX: number;
+        baseY: number;
+        moveX: number;
+        moveY: number;
+    };
+    draggingTarget: 'switch' | 'nodeTree';
+    open: boolean;
+    moved: boolean;
+    hoverSwitch: boolean;
+    preUserSelect: string;
+    sendType: 'xhr' | 'img';
+    activeNode: ActiveNode;
+    inspectorSwitchRef: HTMLDivElement;
+    codeInspectorContainerRef: HTMLDivElement;
+    elementInfoRef: HTMLDivElement;
+    nodeTreeRef: HTMLDivElement;
+    nodeTreeTitleRef: HTMLDivElement;
+    nodeTreeTooltipRef: HTMLDivElement;
+    private eventListeners;
+    isTracking: (e: any) => boolean | "";
+    getDomPropertyValue: (target: HTMLElement, property: string) => number;
+    calculateElementInfoPosition: (target: HTMLElement) => Promise<{
+        vertical: string;
+        horizon: string;
+        top: number;
+        left: number;
+        isExternal: boolean;
+        additionStyle?: undefined;
+    } | {
+        vertical: string;
+        horizon: string;
+        top: number;
+        left: number;
+        isExternal: boolean;
+        additionStyle: {
+            transform: string;
+        };
+    }>;
+    renderCover: (target: HTMLElement) => Promise<void>;
+    getSourceInfo: (target: HTMLElement) => SourceInfo | null;
+    removeCover: (force?: boolean | MouseEvent) => void;
+    renderLayerPanel: (nodeTree: TreeNode, { x, y }: {
+        x: number;
+        y: number;
+    }) => void;
+    removeLayerPanel: () => void;
+    addGlobalCursorStyle: () => void;
+    removeGlobalCursorStyle: () => void;
+    buildRequestUrl: () => string;
+    sendXHR: () => void;
+    sendImg: () => void;
+    trackCode: () => void;
+    showNotification(message: string, type?: 'success' | 'error'): void;
+    handleDrag: (e: MouseEvent | TouchEvent) => void;
+    getValidNodeList: (nodePath: HTMLElement[]) => HTMLElement[];
+    isSamePositionNode: (node1: HTMLElement, node2: HTMLElement) => boolean;
+    handleMouseMove: (e: MouseEvent | TouchEvent) => Promise<void>;
+    handleWheel: (e: WheelEvent) => void;
+    handleMouseClick: (e: MouseEvent | TouchEvent) => void;
+    handleContextMenu: (e: MouseEvent) => void;
+    generateNodeTree: (nodePath: HTMLElement[]) => TreeNode;
+    handlePointerDown: (e: PointerEvent) => void;
+    handleKeyUp: (e: KeyboardEvent) => void;
+    printTip: () => void;
+    getMousePosition: (e: MouseEvent | TouchEvent) => {
+        x: number;
+        y: number;
+    };
+    recordMousePosition: (e: MouseEvent | TouchEvent, target: 'switch' | 'nodeTree') => void;
+    handleMouseUp: (e: MouseEvent | TouchEvent) => void;
+    switch: (e: Event) => void;
+    handleClickTreeNode: (node: TreeNode) => void;
+    handleMouseEnterNode: (e: MouseEvent, node: TreeNode) => Promise<void>;
+    handleMouseLeaveNode: () => void;
+    /**
+     * Attach all event listeners
+     */
+    private attachEventListeners;
+    /**
+     * Detach all event listeners
+     */
+    private detachEventListeners;
+    protected firstUpdated(): void;
+    disconnectedCallback(): void;
+    renderNodeTree: (node: TreeNode) => TemplateResult;
+    render(): TemplateResult<1>;
+    static styles: import("lit").CSSResult;
+}
+export {};

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export { parse as parseSFC } from '@vue/compiler-sfc';
+export * from './server';
+export * from './shared';

package/types/server/clipboard.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 将文本复制到系统剪贴板。
+ * 失败时仅打印警告（如 linux 未安装 xclip/xsel/wl-copy），不会向调用方抛错。
+ */
+export declare function copyToClipboard(text: string): Promise<boolean>;

package/types/server/index.d.ts

@@ -0,0 +1,3 @@
+export { transformCode } from './transform';
+export * from './use-client';
+export * from './server';

package/types/server/server.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import http from 'http';
+import type { PathType, CodeOptions, RecordInfo } from '../shared';
+export declare const ProjectRootPath: string;
+export declare function getRelativePath(filePath: string): string;
+export declare function getRelativeOrAbsolutePath(filePath: string, pathType?: PathType): string;
+export declare function createServer(callback: (port: number) => any, options?: CodeOptions, _record?: RecordInfo): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+export declare function startServer(options: CodeOptions, record: RecordInfo): Promise<void>;

package/types/server/transform/index.d.ts

@@ -0,0 +1,12 @@
+import { EscapeTags, PathType } from '../../shared';
+type FileType = 'vue' | 'jsx' | 'svelte' | 'astro' | 'mdx' | unknown;
+type TransformCodeParams = {
+    content: string;
+    filePath: string;
+    fileType: FileType;
+    escapeTags: EscapeTags;
+    pathType: PathType;
+    mdx?: boolean;
+};
+export declare function transformCode(params: TransformCodeParams): Promise<string>;
+export {};

package/types/server/transform/scan-html-tag.d.ts

@@ -0,0 +1,5 @@
+export declare function isScannableDomTag(name: string): boolean;
+export declare function shouldSkipScannedTagChildren(name: string): boolean;
+export declare function isNonInjectableScannedTag(name: string): boolean;
+export declare function isLikelyTypeScriptGeneric(content: string, tagStart: number): boolean;
+export declare function isWellFormedScannedTag(content: string, insertPosition: number, name: string): boolean;

package/types/server/transform/transform-astro.d.ts

@@ -0,0 +1,2 @@
+import { EscapeTags } from '../../shared';
+export declare function transformAstro(content: string, filePath: string, escapeTags: EscapeTags, resolveFilePath?: string): Promise<string>;

package/types/server/transform/transform-jsx.d.ts

@@ -0,0 +1,35 @@
+import MagicString from 'magic-string';
+import { EscapeTags } from '../../shared';
+type RootTarget = {
+    type: 'jsx';
+    node: any;
+} | {
+    type: 'createElement';
+    node: any;
+};
+export declare function transformJsx(content: string, filePath: string, escapeTags: EscapeTags): string;
+declare function hasExportDefaultAncestor(path: any): boolean;
+declare function getPropagatedPathExpression(path: any, s: MagicString, content: string): string;
+declare function getObjectPatternPathBinding(param: any): string;
+declare function getObjectPropertyName(node: any): string;
+declare function getEmptyParamsInsertPosition(node: any, content: string): any;
+declare function collectRootTargets(node: any, scope: any, visitedBindings?: Set<string>): RootTarget[];
+declare function shouldPropagatePathToExpression(node: any, scope: any, visitedBindings?: Set<string>): boolean;
+declare function estimateRootCount(node: any, scope: any, visitedBindings: Set<string>): number;
+export declare function injectCreateElementPath(node: any, s: MagicString, content: string, pathExpression: string): void;
+export declare function getJsxNodeName(node: any): string;
+export declare function getCallExpressionName(node: any): string;
+export declare function getExpressionName(node: any): string;
+declare function isEscapedJsxTag(escapeTags: EscapeTags, nodeName: string): boolean;
+export declare const __TEST__: {
+    hasExportDefaultAncestor: typeof hasExportDefaultAncestor;
+    getPropagatedPathExpression: typeof getPropagatedPathExpression;
+    getObjectPatternPathBinding: typeof getObjectPatternPathBinding;
+    getObjectPropertyName: typeof getObjectPropertyName;
+    getEmptyParamsInsertPosition: typeof getEmptyParamsInsertPosition;
+    shouldPropagatePathToExpression: typeof shouldPropagatePathToExpression;
+    estimateRootCount: typeof estimateRootCount;
+    collectRootTargets: typeof collectRootTargets;
+    isEscapedJsxTag: typeof isEscapedJsxTag;
+};
+export {};

package/types/server/transform/transform-mdx.d.ts

@@ -0,0 +1,2 @@
+import { EscapeTags } from '../../shared';
+export declare function transformMdx(content: string, filePath: string, escapeTags: EscapeTags, resolveFilePath?: string): Promise<string>;

package/types/server/transform/transform-svelte.d.ts

@@ -0,0 +1,2 @@
+import { EscapeTags } from '../../shared';
+export declare function transformSvelte(content: string, filePath: string, escapeTags: EscapeTags): string;

package/types/server/transform/transform-vue-pug.d.ts

@@ -0,0 +1,44 @@
+import MagicString from 'magic-string';
+import { EscapeTags } from '../../shared';
+import type { ElementNode } from '@vue/compiler-dom';
+import * as pug from 'volar-service-pug/lib/languageService';
+interface AstLocation {
+    column: number;
+    line: number;
+}
+export interface PugFileInfo {
+    content: string;
+    offsets: number[];
+}
+export declare const pugMap: Map<string, PugFileInfo>;
+export declare function belongTemplate(target: AstLocation, start: AstLocation, end: AstLocation): boolean;
+interface TransformPugParams {
+    node: pug.Node | null | undefined;
+    templateNode: ElementNode;
+    s: MagicString;
+    escapeTags: EscapeTags;
+    filePath: string;
+}
+export declare function transformPugAst(params: TransformPugParams): void;
+/**
+ * Check if a template node uses Pug syntax
+ * @param templateNode - The template element node to check
+ * @returns true if the template uses Pug, false otherwise
+ */
+export declare function isPugTemplate(templateNode: ElementNode | undefined): boolean;
+/**
+ * Calculate line offsets for content
+ * @param content - The file content
+ * @returns Array of line offsets
+ */
+export declare function calculateLineOffsets(content: string): number[];
+/**
+ * Transform Pug template in Vue SFC
+ * @param content - The file content
+ * @param filePath - The file path
+ * @param templateNode - The template element node
+ * @param escapeTags - Tags to escape from transformation
+ * @param s - MagicString instance for code transformation
+ */
+export declare function transformPugTemplate(content: string, filePath: string, templateNode: ElementNode, escapeTags: EscapeTags, s: MagicString): void;
+export {};

package/types/server/transform/transform-vue.d.ts

@@ -0,0 +1,5 @@
+import { EscapeTags } from '../../shared';
+type VueCompilerDom = Pick<typeof import('@vue/compiler-dom'), 'parse' | 'transform'>;
+export declare function resolveVueCompilerDom(mod: any): VueCompilerDom;
+export declare function transformVue(content: string, filePath: string, escapeTags: EscapeTags): Promise<string>;
+export {};

package/types/server/use-client.d.ts

@@ -0,0 +1,16 @@
+import type { CodeOptions, RecordInfo } from '../shared';
+export declare const clientJsPath: string;
+export declare function getInjectedCode(options: CodeOptions, port: number, isNextjs: boolean): string;
+export declare function getWebComponentCode(options: CodeOptions, port: number): string;
+export declare function getEliminateWarningCode(): string;
+export declare function getHidePathAttrCode(): string;
+export declare function getCodeWithWebComponent({ options, record, file, code, inject, server, }: {
+    options: CodeOptions;
+    record: RecordInfo;
+    file: string;
+    code: string;
+    inject?: boolean;
+    server?: boolean;
+}): Promise<string>;
+export declare function isNextjsProject(basedir?: string): boolean;
+export declare function isNextGET16(basedir?: string): boolean;

package/types/shared/constant.d.ts

@@ -0,0 +1,8 @@
+export declare const LineName = "data-insp-row";
+export declare const ColumnName = "data-insp-col";
+export declare const PathName = "data-insp-path";
+export declare const NodeName = "data-insp-node";
+export declare const DefaultPort = 5678;
+export declare const DefaultCopyFormat = "{file}:{line}:{column} <{tag}>";
+export declare const JsFileExtList: string[];
+export declare const AstroToolbarFile = "\0astro:dev-toolbar";

package/types/shared/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constant';
+export * from './utils';
+export * from './type';
+export * from './record-cache';

package/types/shared/record-cache.d.ts

@@ -0,0 +1,5 @@
+import type { RecordInfo } from './type';
+export declare const resetFileRecord: (output: string) => void;
+export declare const getProjectRecord: (record: RecordInfo) => Partial<RecordInfo>;
+export declare const setProjectRecord: (record: RecordInfo, key: keyof RecordInfo, value: RecordInfo[keyof RecordInfo]) => void;
+export declare const findPort: (record: RecordInfo) => Promise<number>;

package/types/shared/type.d.ts

@@ -0,0 +1,165 @@
+/// <reference types="node" />
+import { Server } from 'http';
+export type HotKey = 'ctrlKey' | 'altKey' | 'metaKey' | 'shiftKey';
+export type RecordInfo = {
+    port: number;
+    entry: string;
+    output: string;
+    findPort?: Promise<number>;
+    inputs?: Promise<string[]>;
+    injectTo?: string[];
+    root?: string;
+    server?: Server;
+    previousPort?: number;
+};
+export type ImportClientWay = 'file' | 'code';
+export type PathType = 'relative' | 'absolute';
+type SourceInfo = {
+    file: string;
+    line: number;
+    column: number;
+};
+export type EscapeTags = (string | RegExp)[];
+export type Hooks = {
+    /**
+     * @zh server 端接收到 DOM 源代码定位请求后的钩子函数
+     * @en The hook triggered when the server receives a request to locate the DOM source code.
+     */
+    afterInspectRequest?: (options: CodeOptions, source: SourceInfo) => void;
+};
+export type Condition = string | RegExp | (string | RegExp)[];
+export type CodeOptions = {
+    /**
+     * @zh 指定项目的打包器
+     * @en specify the bundler of the project
+     */
+    bundler: 'vite' | 'webpack' | 'rspack' | 'esbuild' | 'turbopack' | 'mako';
+    /**
+     * @cn 触发 DOM 定位功能的组合键，ctrlKey/altKey/metaKey/shiftKey 中一个或多个组成的数组，默认值为 ['altKey', 'shiftKey]。即 Mac 系统默认是 Option + Shift；Window 默认是 Alt + Shift。
+     * @en The combination keys that triggers the DOM positioning function, it is an array of one or more from ctrlKey/altKey/metaKey/shiftKey, with default values of ['altKey', 'shiftKey']. The default for Mac systems is Option+Shift; and for Window is Alt+Shift.
+     */
+    hotKeys?: HotKey[] | false;
+    /**
+     * @cn 是否在页面展示功能开关按钮
+     * @en Whether show the switch button of this function on the page
+     */
+    showSwitch?: boolean;
+    /**
+     * @cn 是否隐藏在控制台的按键提示
+     * @en Whether hide the tips of combination keys on console.
+     */
+    hideConsole?: boolean;
+    /**
+     * @cn 打开功能开关的情况下，点击复制源码位置后是否自动关闭开关
+     * @en When opening the function switch, whether automatically close the switch after clicking to copy the source code location.
+     */
+    autoToggle?: boolean;
+    /**
+     * @cn 用于注入DOM 筛选和点击复制源码位置的相关代码的文件。必须为绝对路径且以 `.js/.ts/.mjs/.mts/.jsx/.tsx` 为结尾的文件
+     * @en The file to inject the relevant code for DOM filtering and click-to-copy source code location. Must be an absolute path and end with `.js/.ts/.mjs/.mts/.jsx/.tsx`.
+     */
+    injectTo?: string | string[];
+    /**
+     * @cn 是否在转换时添加 `enforce: 'pre'`，默认值为 `true`。（若因该插件引起了 `eslint-plugin` 校验错误，需要此项设置为 `false`）
+     * @en Whether to add `enforce: 'pre'` during the transformation, default value is `true`. (If this plugin causes `eslint-plugin` validation errors, set this option to `false`)
+     */
+    enforcePre?: boolean;
+    /**
+     * @cn 自定义 development 环境的判断
+     * @en Custom determination of the development environment.
+     */
+    dev?: boolean | (() => boolean);
+    /**
+     * @cn 对于 webpack/rspack 是否应用缓存策略，默认值为 `false`。(使用 cache 可能会导致)
+     * @en Whether to apply the caching strategy for webpack/rspack, the default value is `false`
+     */
+    cache?: boolean;
+    /**
+     * @cn 仅对符合 match 正则表达式的文件会进行源码定位编译(精确匹配文件类型以减少无用文件参与编译，提升性能)，默认为 /\.(vue|jsx|tsx|js|ts|mjs|mts)$/
+     * @en Only files that match the regular expression specified by `match` will undergo source code location compilation (precise matching of file types to reduce unnecessary files participating in compilation, improving performance); the default is /\.(vue|jsx|tsx|js|ts|mjs|mts)$/
+     */
+    match?: RegExp;
+    /**
+     * @cn 点击 DOM 时复制到剪贴板的文本格式，默认 "{file}:{line}:{column} <{tag}>"，其中 {xx} 为模版字符（支持 {file} / {line} / {column} / {tag}）
+     * @en The text format copied to clipboard when clicking the DOM. Default value is "{file}:{line}:{column} <{tag}>", where {xx} represents template characters (supports {file} / {line} / {column} / {tag}).
+     */
+    copyFormat?: string;
+    /**
+     * @zh 钩子函数
+     * @en hooks
+     */
+    hooks?: Hooks;
+    /**
+     * @zh 不注入 `data-insp-path` 的标签
+     * @en tags without injecting data-insp-path
+     */
+    escapeTags?: EscapeTags;
+    /**
+     * @zh 是否转换 MDX 文件以注入 `data-insp-path`，默认值为 `false`
+     * @en Whether to transform MDX files to inject `data-insp-path`, defaults to `false`
+     */
+    mdx?: boolean;
+    /**
+     * @zh 是否隐藏控制台中 dom 的 `data-insp-path` 属性
+     * @en Whether to hide the `data-insp-path` attribute of DOM in the console
+     */
+    hideDomPathAttr?: boolean;
+    /**
+     * @zh 点击 DOM 向 node server 发送请求时，是否使用 ip 代替 localhost。默认为 `false`
+     * @en When sending request node server by clicking on the DOM, whether to use IP instead of localhost. Default value is `false`
+     */
+    ip?: boolean | string;
+    /**
+     * @zh 引入客户端交互代码的方式: file 为通过文件引入交互代码; code 为直接将交互代码注入页面。`0.16.x` 及之后的版本值默认为 `code`, `0.15.x` 之前的版本默认值为 `file`.
+     * @en How to import client interaction code: `file` means import interaction code through a file; `code` means directly injecting the interaction code into the page. The default value for versions `0.16.x` and later is `code`, while for versions before `0.15.x`, the default value is `file`.
+     */
+    importClient?: ImportClientWay;
+    /**
+     * @zh 额外要参与编译的文件(用于让 node_modules 中的部分文件参与编译以注入 path 信息)
+     * @en Additional files to be compiled (used to make some files in `node_modules` participate in compilation to inject path information)
+     */
+    include?: Condition;
+    /**
+     * @zh 不参与编译的文件
+     * @en Files not to be compiled
+     */
+    exclude?: Condition;
+    /**
+     * @zh 用于映射文件路径，多用于将 node_modules 中的文件路径映射为项目中的文件路径
+     * @en Used to map file paths, often used to map the file path in `node_modules` to the file path in the project
+     */
+    mappings?: Record<string, string> | Array<{
+        find: string | RegExp;
+        replacement: string;
+    }>;
+    /**
+     * @zh 支持从指定端口开始寻找可用端口（默认从 5678 开始）
+     * @en Supports finding available ports starting from a specified port (default starts from 5678).
+     */
+    port?: number;
+    /**
+     * @zh 是否在控制台中打印 server 的启动信息
+     * @en Whether to print the server startup information in the console
+     */
+    printServer?: boolean;
+    /**
+     * @zh 注入在 DOM 上的路径类型，默认值为 `relative`，即相对于项目根目录的路径
+     * @en The type of path injected into the DOM. The default value is `relative`, which means relative to the project root directory
+     */
+    pathType?: PathType;
+    /**
+     * @zh 要跳过注入的代码片段：
+     * - console: 跳过注入 console.error 和 console.warn 的代码片段，nextjs 和 nuxt 项目不建议跳过此项
+     * - htmlScript: 跳过在 html 中注入 script 标签的代码片段，MPA 项目不建议跳过此项
+     * @en The code snippets to skip injecting
+     * - console: Skip injecting the code snippet that injects console.error and console.warn, it is not recommended to skip this item for nextjs and nuxt projects
+     * - htmlScript: Skip injecting the code snippet that injects script tags in html, it is not recommended to skip this item for MPA projects
+     */
+    skipSnippets?: ('console' | 'htmlScript')[];
+    /**
+     * @zh 是否启用 server 功能。默认值为 `open`，即启用 server 功能。使用代码定位功能时必须启用 server 功能，线上构建只看 dom 路径时可以关闭 server 功能。
+     * @en Whether to enable the server function. The default value is `open`, which means enabling the server function. The server function must be enabled when using the code location function, and it can be closed when building online only to view the dom path.
+     */
+    server?: 'open' | 'close';
+};
+export {};