code-inspector-plugin 0.1.0 → 0.1.2

package/README.md

@@ -89,16 +89,7 @@ pnpm add code-inspector-plugin -D
   });
   ```
 
-### 2. 使用代码审查
-
-目前使用代码审查功能的方式有两种:
-
-1. 【推荐】同时持续按住组合键进行代码审查。 (Mac 系统默认组合键是 `Option + Shift`；Window 的默认组合键是 `Alt + Shift`)
-2. 点击页面上的 Code Inspector 开关按钮。当开关的颜色变成彩色时，表示代码审查模式打开 <img src="https://github.com/zh-lx/code-inspector/assets/73059627/842c3e88-dca7-4743-854c-d61093d3d34f" width="20" />；当开关颜色变成黑白时，表示代码审查模式关闭 <img src="https://user-images.githubusercontent.com/73059627/230129864-e2813188-8d49-4a8e-a6bc-dda19c79b491.png" width="20" />。（Code Inspector 开关按钮 <img src="https://github.com/zh-lx/code-inspector/assets/73059627/842c3e88-dca7-4743-854c-d61093d3d34f" width="20" /> 默认隐藏，需要配置 `showSwitch: true` 才会在页面显示。）
-
-当代码审查模式打开时，点击页面上的元素，将自动打开你的代码编辑器并将光标定位到元素对应的代码位置。
-
-### 3. 配置命令行工具(仅当 Mac + Vscode 需要配置此步)
+### 2. 配置命令行工具(仅当 Mac + Vscode 需要配置此步)
 
 如果你的编辑器是 VSCode 且系统为 MacOS，需要进行如下配置:
 
@@ -110,6 +101,16 @@ pnpm add code-inspector-plugin -D
 
   <img src="https://s3.bmp.ovh/imgs/2021/08/c3d00a8efbb20feb.png" width="40%" />
 
+### 3. 使用代码审查
+
+目前使用代码审查功能的方式有两种:
+
+1. 【推荐】按住组合键时，即可进行代码审查。 (Mac 系统默认组合键是 `Option + Shift`；Window 的默认组合键是 `Alt + Shift`，浏览器控制台会输出相关提示)
+   ![image](https://github.com/zh-lx/code-inspector/assets/73059627/9b47c40f-6380-40d0-b0ec-4283d35a1f2d)
+2. 点击页面上的 Code Inspector 开关按钮。当开关的颜色变成彩色时，表示代码审查模式打开 <img src="https://github.com/zh-lx/code-inspector/assets/73059627/842c3e88-dca7-4743-854c-d61093d3d34f" width="20" />；当开关颜色变成黑白时，表示代码审查模式关闭 <img src="https://user-images.githubusercontent.com/73059627/230129864-e2813188-8d49-4a8e-a6bc-dda19c79b491.png" width="20" />。（Code Inspector 开关按钮 <img src="https://github.com/zh-lx/code-inspector/assets/73059627/842c3e88-dca7-4743-854c-d61093d3d34f" width="20" /> 默认隐藏，需要配置 `showSwitch: true` 才会在页面显示。）
+
+当代码审查模式打开时，点击页面上的元素，将自动打开你的代码编辑器并将光标定位到元素对应的代码位置。
+
 ## 🎨 可选配置
 
 | 参数       | 描述                                                       | 是否必传 | 类型                | 可选值                                                               | 默认值                   |

package/dist/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("vite-code-inspector-plugin");function u(e){if(!(e!=null&&e.bundler)){console.error("Please specify the bundler in the options of CodeInspectorPlugin.");return}if(e.bundler==="webpack"){const r=require("webpack-code-inspector-plugin");return new r(e)}else return n.ViteCodeInspectorPlugin(e)}exports.CodeInspectorPlugin=u;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("vite-code-inspector-plugin"),u=require("chalk");function c(e){if(!(e!=null&&e.bundler)){console.log(u.red("Please specify the bundler in the options of code-inspector-plugin."));return}if(e.bundler==="webpack"){const r=require("webpack-code-inspector-plugin");return new r(e)}else return n.ViteCodeInspectorPlugin(e)}exports.CodeInspectorPlugin=c;

package/dist/index.mjs

@@ -1,8 +1,11 @@
 import { ViteCodeInspectorPlugin as n } from "vite-code-inspector-plugin";
-function c(e) {
+import c from "chalk";
+function t(e) {
   if (!(e != null && e.bundler)) {
-    console.error(
-      "Please specify the bundler in the options of CodeInspectorPlugin."
+    console.log(
+      c.red(
+        "Please specify the bundler in the options of code-inspector-plugin."
+      )
     );
     return;
   }
@@ -13,5 +16,5 @@ function c(e) {
     return n(e);
 }
 export {
-  c as CodeInspectorPlugin
+  t as CodeInspectorPlugin
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-inspector-plugin",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "typings": "./types/index.d.ts",
@@ -38,9 +38,10 @@
     "url": "https://github.com/zh-lx/code-inspector/issues"
   },
   "dependencies": {
-    "vite-code-inspector-plugin": "0.1.0",
-    "code-inspector-core": "0.1.0",
-    "webpack-code-inspector-plugin": "0.1.0"
+    "chalk": "4.1.1",
+    "code-inspector-core": "0.1.2",
+    "vite-code-inspector-plugin": "0.1.2",
+    "webpack-code-inspector-plugin": "0.1.2"
   },
   "devDependencies": {
     "@types/node": "^16.0.1",

package/types/index.d.ts

@@ -1,15 +1,6 @@
-import type WebpackCodeInspectorPlugin from 'webpack-code-inspector-plugin/types/index';
-import { ViteCodeInspectorPlugin } from 'vite-code-inspector-plugin';
 import { CodeOptions } from 'code-inspector-core';
 export interface CodeInspectorPluginOptions extends CodeOptions {
-    framework?: 'vue';
     bundler: 'vite' | 'webpack';
+    catch?: boolean;
 }
-export interface CodeInspectorPluginVite extends CodeInspectorPluginOptions {
-    bundler: 'vite';
-}
-export interface CodeInspectorPluginWebpack extends CodeInspectorPluginOptions {
-    bundler: 'webpack';
-}
-export declare function CodeInspectorPlugin(options: CodeInspectorPluginVite): ReturnType<typeof ViteCodeInspectorPlugin>;
-export declare function CodeInspectorPlugin(options: CodeInspectorPluginWebpack): WebpackCodeInspectorPlugin;
+export declare function CodeInspectorPlugin(options: CodeInspectorPluginOptions): any;