chore: release

hemengke1997 · Apr 24, 2024 · d0794b8 · d0794b8
1 parent ed8f0e4
commit d0794b8
Show file tree

Hide file tree

Showing 14 changed files with 72 additions and 20 deletions.
diff --git a/packages/istanbul-widget/CHANGELOG.md b/packages/istanbul-widget/CHANGELOG.md
@@ -1,5 +1,11 @@
 # istanbul-widget
 
+## 1.3.3
+
+### Patch Changes
+
+- fix: float type
+
 ## 1.3.2
 
 ### Patch Changes

diff --git a/packages/istanbul-widget/README.md b/packages/istanbul-widget/README.md
@@ -16,12 +16,30 @@ npm install istanbul-widget
 import { IstanbulWidget } from 'istanbul-widget'
 
 const istanbulWidget = new IstanbulWidget({
-  report: {
-    onAction: async (coverage, config) => {
-      console.log('上报', coverage, config)
-      // 在这里你可以调用上报接口
-      // 如果接口报错，请在此抛出错误: throw new Error("你的错误信息")
+  defaultPosition: {
+    x: 0,
+    y: 100,
+  },
+  plugin: {
+    // 上报按钮
+    report: {
+      onReport(coverage) {
+        console.log('上报', coverage)
+        // throw new Error('上报失败') // 你可以控制失败的逻辑
+      },
+    },
+    // 设置插件
+    setting: {
+      requireReporter: true,
     },
+    buttonGroup: [
+      {
+        text: '自定义按钮',
+        onClick(...args) {
+          console.log(...args)
+        },
+      },
+    ],
   },
 })
 ```
@@ -36,7 +54,6 @@ const istanbulWidget = new IstanbulWidget({
 </script>
 ```
 
-
 ## 配置项
 
 ```ts
@@ -53,10 +70,11 @@ interface IstanbulWidgetOptions {
   target?: string | HTMLElement
   /**
    * 按钮悬浮
+   * @description false 则关闭悬浮
    */
   float?: {
     offsetX?: number
-  }
+  } | false
   /**
    * 按钮默认位置
    * @default
@@ -103,3 +121,15 @@ interface IstanbulWidgetOptions {
   pluginOrder?: (PluginName | string)[]
 }
 ```
+
+
+## 截图
+
+### 入口按钮
+![入口](./screenshots/entry.png)
+
+### 深色主题
+![深色主题](./screenshots/dark.png)
+
+### 浅色主题
+![浅色主题](./screenshots/light.png)
diff --git a/packages/istanbul-widget/dev.tsx b/packages/istanbul-widget/dev.tsx
@@ -14,7 +14,7 @@ myPlugin.event.on('init', () => {
 
 const istanbulWidget = new IstanbulWidget({
   defaultPosition: {
-    x: -100,
+    x: 0,
     y: 100,
   },
   plugin: {

diff --git a/packages/istanbul-widget/package.json b/packages/istanbul-widget/package.json
@@ -1,18 +1,17 @@
 {
   "name": "istanbul-widget",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "type": "module",
   "files": [
     "**"
   ],
-  "main": "./dist/istanbul-widget.min.js",
+  "main": "./dist/istanbul-widget.esm.js",
   "module": "./dist/es/istanbul-widget.js",
   "types": "./dist/istanbul-widget.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "types": "./dist/istanbul-widget.d.ts",
-      "require": "./dist/istanbul-widget.min.js",
       "import": "./dist/es/istanbul-widget.js"
     },
     "./components": {

diff --git a/packages/istanbul-widget/screenshots/dark.png b/packages/istanbul-widget/screenshots/dark.png
diff --git a/packages/istanbul-widget/screenshots/entry.png b/packages/istanbul-widget/screenshots/entry.png
diff --git a/packages/istanbul-widget/screenshots/light.png b/packages/istanbul-widget/screenshots/light.png
diff --git a/packages/istanbul-widget/src/core/options.interface.ts b/packages/istanbul-widget/src/core/options.interface.ts
@@ -13,10 +13,17 @@ export interface IstanbulWidgetOptions {
   target?: string | HTMLElement
   /**
    * 按钮悬浮
+   * @description false 则关闭悬浮
+   * @default
+   * ```js
+   * { offsetX: 8 }
+   * ```
    */
-  float?: {
-    offsetX?: number
-  }
+  float?:
+    | {
+        offsetX?: number
+      }
+    | false
   /**
    * 按钮默认位置
    * @default
@@ -36,6 +43,8 @@ export interface IstanbulWidgetOptions {
 
   /**
    * 默认开启的插件
+   * @default
+   * ['setting', 'buttonGroup']
    */
   defaultPlugins?: ('setting' | 'buttonGroup')[]
 

diff --git a/packages/vite-plugin-istanbul-widget/CHANGELOG.md b/packages/vite-plugin-istanbul-widget/CHANGELOG.md
@@ -1,5 +1,12 @@
 # vite-plugin-istanbul-widget
 
+## 1.3.3
+
+### Patch Changes
+
+- Updated dependencies
+  - istanbul-widget@1.3.3
+
 ## 1.3.2
 
 ### Patch Changes

diff --git a/packages/vite-plugin-istanbul-widget/package.json b/packages/vite-plugin-istanbul-widget/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-istanbul-widget",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

diff --git a/playground/react-app/report.ts b/playground/react-app/report.ts
@@ -1,7 +1,6 @@
-async function report(coverage: any, ...args: any[]) {
+async function report(coverage: any) {
   const reponame = 'react-app'
-  console.log(args, 'args')
-  await fetch(`http://localhost:3000/${reponame}/coverage/client?v=temp_git_commit_id`, {
+  await fetch(`http://localhost:3000/${reponame}/coverage/client?v=${__GIT_COMMIT_ID__}`, {
     body: JSON.stringify(coverage),
     method: 'POST',
     headers: {

diff --git a/playground/react-app/vite.config.ts b/playground/react-app/vite.config.ts
@@ -23,7 +23,6 @@ export default defineConfig((env) => ({
             autoReport: false,
             onLeavePage: true,
             requireReporter: true,
-            text: '!设置文案!',
           },
           buttonGroup: [
             {

diff --git a/playground/vue-app/report.ts b/playground/vue-app/report.ts
@@ -1,6 +1,6 @@
 async function report(coverage: any) {
   const reponame = 'vue-app'
-  fetch(`http://localhost:3000/${reponame}/coverage/client`, {
+  await fetch(`http://localhost:3000/${reponame}/coverage/client?v=${__GIT_COMMIT_ID__}`, {
     body: JSON.stringify(coverage),
     method: 'POST',
     headers: {

diff --git a/playground/vue-app/tsconfig.json b/playground/vue-app/tsconfig.json
@@ -1,4 +1,7 @@
 {
   "extends": "@minko-fe/tsconfig/tsconfig.app.json",
+  "compilerOptions": {
+    "types": ["vite-plugin-istanbul-widget/client"]
+  },
   "exclude": ["dist"]
 }