@open-editor/client - npm Package Compare versions

Comparing version 0.9.3 to 0.9.4

dist/index.d.ts

@@ -0,44 +1,31 @@
+/**
+ * 调试器全局配置项
+ */
 interface Options {
     /**
-     * source rootDir path
+     * 源码根目录路径
      */
     rootDir: string;
     /**
-     * render the toggle into the browser
-     *
-     * @default true
+     * 是否在浏览器中显示调试开关
      */
     displayToggle?: boolean;
     /**
-     * Disable hover effect from CSS when inspector is enabled
-     *
-     * @default true
+     * 启用调试器时是否禁用 CSS 悬停效果
      */
     disableHoverCSS?: boolean;
     /**
-     * Ignoring components in some directories, using glob pattern syntax for match
-     *
-     * @see https://en.wikipedia.org/wiki/Glob_(programming)
-     *
-     * @default '\/**\/node_modules\/**\/*'
+     * 需要忽略的组件路径匹配规则
      */
     ignoreComponents?: string | string[];
     /**
-     * exit the check after opening the editor or component tree
-     *
-     * @default true
+     * 是否在打开编辑器或组件树后退出检查模式
      */
     once?: boolean;
     /**
-     * Enable interaction between multiple iframes to be promoted to the top-level window.
-     *
-     * It only takes effect when the top window and iframe window have the same origin.
-     *
-     * @default true
+     * 是否启用跨 iframe 调试
      */
     crossIframe?: boolean;
     /**
-     * internal server port
-     *
-     * relative address is used when this parameter is empty
+     * 调试服务器端口号
      */
@@ -48,4 +35,16 @@ port?: string;
 
+/**
+ * 初始化编辑器客户端
+ *
+ * @param opts - 编辑器配置对象，包含各子系统所需参数
+ *
+ * 功能说明：执行客户端环境检测、配置注入、模块初始化等启动流程
+ *
+ * 执行策略：
+ *   1. 采用单例模式避免重复初始化
+ *   2. 在 DOM 就绪后启动子系统
+ *   3. 严格的环境检测机制
+ */
 declare function setupClient(opts: Options): void;
 
 export { Options, setupClient };

package.json

 {
   "name": "@open-editor/client",
-  "version": "0.9.3",
+  "version": "0.9.4",
   "description": "internal utils shared across @open-editor packages",
@@ -28,6 +28,6 @@ "main": "./dist/index.js",
   },
-  "homepage": "https://github.com/zjxxxxxxxxx/open-editor/tree/main/packages/client#readme",
+  "homepage": "https://github.com/zjxxxxxxxxx/open-editor#readme",
   "dependencies": {
     "outmatch": "^1.0.0",
-    "@open-editor/shared": "0.9.3"
+    "@open-editor/shared": "0.9.4"
   },
@@ -34,0 +34,0 @@ "devDependencies": {

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

147226

34.12%

Lines of code

635

38.34%

Number of medium supply chain risk alerts

2

-33.33%

Worsened metrics

Number of low supply chain risk alerts

7

40%

Dependency changes

• + Added

  @open-editor/shared@0.9.4
  (transitive)

• - Removed

  @open-editor/shared@0.9.3
  (transitive)

• Updated

  @open-editor/shared@0.9.4