Merge pull request #18 from vadxq/dev

feat: custom hide

Author: vadxq

README.md

@@ -17,15 +17,17 @@
 **vite version:** >=2.0.0
 
 ```bash
-yarn add vconsole
-# or
+# npm
+npm i vite-plugin-vconsole -D
 npm i  vconsole -S
-```
 
-```bash
+# yarn
+yarn add vconsole
 yarn add vite-plugin-vconsole -D
-# or
-npm i vite-plugin-vconsole -D
+
+# pnpm
+pnpm add vconsole
+pnpm add -D vite-plugin-vconsole
 ```
 
 ## Example
@@ -57,6 +59,7 @@ yarn dev
 - **Vue** sample config
 
 ```ts
+// tips: If the reference path hint does not exist, you can import the @types/node package
 import { defineConfig } from 'vite';
 import vue from '@vitejs/plugin-vue';
 import { viteVConsole } from 'vite-plugin-vconsole';
@@ -226,6 +229,23 @@ viteVConsole({
 }
 ```
 
+- A custom rule that triggers destruction, see the question request: [How to judge page userAgent to choose whether to load vconsole](https://github.com/vadxq/vite-plugin-vconsole/issues/12)
+
+```javascript
+// customHide: A piece of executable code, used to start some APIs on the browser side.
+viteVConsole({
+  entry: path.resolve('src/main.ts'),
+  enabled: true,
+  customHide: `/chrome\\/([\\d\\.]+)/.test(navigator.userAgent.toLowerCase())`,
+  config: {
+    theme: 'dark',
+    onReady() {
+      console.log(23333);
+    }
+  },
+})
+```
+
 ## Options
 
 ### entry
@@ -260,6 +280,10 @@ must support. Supports multiple entries when it is an array.
 }[]
 ```
 
+### customHide
+
+**type:**: String
+
 ## Typescript
 
 Add a reference to `vconsole`
@@ -288,9 +312,9 @@ Update to V1.3.0+ version, can support VConsole Functions Configuration.
 
 Many thanks to [@KeJunMao](https://github.com/KeJunMao) for support!
 
-## Support VConsole Plugin Configuration
+## Support VConsole Plugin Configuration.Support custom destruction
 
-Update to V2.0.0+ version, can support VConsole Plugin Configuration.
+Update to V2.0.0+ version, can support VConsole Plugin Configuration.Also supports custom destruction.
 
 ## License
 

README.zh_CN.md

@@ -17,15 +17,17 @@
 **vite version:** >=2.0.0
 
 ```bash
-yarn add vconsole
-# or
+# npm
+npm i vite-plugin-vconsole -D
 npm i  vconsole -S
-```
 
-```bash
+# yarn
+yarn add vconsole
 yarn add vite-plugin-vconsole -D
-# or
-npm i vite-plugin-vconsole -D
+
+# pnpm
+pnpm add vconsole
+pnpm add -D vite-plugin-vconsole
 ```
 
 ## 示例
@@ -59,6 +61,7 @@ yarn dev
 - **Vue** 简单配置
 
 ```ts
+// tips: 如果引用path提示不存在，可以引入@types/node包
 import { defineConfig } from 'vite';
 import vue from '@vitejs/plugin-vue';
 import { viteVConsole } from 'vite-plugin-vconsole';
@@ -207,6 +210,23 @@ viteVConsole({
 })
 ```
 
+- 自定义规则使其触发销毁，见issue需求：[如何判断页面userAgent来选择是否加载vconsole](https://github.com/vadxq/vite-plugin-vconsole/issues/12)
+
+```javascript
+// customHide: 一段可运行代码段，用于出发在浏览器端的一些api
+viteVConsole({
+  entry: path.resolve('src/main.ts'),
+  enabled: true,
+  customHide: `/chrome\\/([\\d\\.]+)/.test(navigator.userAgent.toLowerCase())`,
+  config: {
+    theme: 'dark',
+    onReady() {
+      console.log(23333);
+    }
+  },
+})
+```
+
 ## 配置
 
 ### entry
@@ -241,6 +261,10 @@ viteVConsole({
 }[]
 ```
 
+### customHide
+
+**type:**: String
+
 ## Typescript
 
 添加 `vconsole` 的引用
@@ -269,9 +293,9 @@ viteVConsole({
 
 非常感谢[@KeJunMao](https://github.com/KeJunMao)的支持！
 
-## 支持VConsole自定义插件和配置参数调整
+## 支持VConsole自定义插件和配置参数调整，支持自定义销毁
 
-更新至V2.0.0+版本，可以配置VConsole定义插件啦～
+更新至V2.0.0+版本，可以配置VConsole定义插件啦～同时支持自定义销毁
 
 ## License
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-vconsole",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "vite plugin vconsole",
   "main": "dist/main.js",
   "exports": {

playground/vite.config.ts

@@ -8,6 +8,7 @@ export default defineConfig({
     viteVConsole({
       entry: path.resolve('src/main.ts'),
       enabled: true,
+      customHide: `/chrome\\/([\\d\\.]+)/.test(navigator.userAgent.toLowerCase())`,
       config: {
         theme: 'dark',
         onReady() {

src/main.ts

@@ -34,7 +34,13 @@ const getEventItems = (
 };
 
 export function viteVConsole(opt: viteVConsoleOptions): Plugin {
-  const { entry, enabled = true, config = {}, plugin } = opt;
+  const {
+    entry,
+    enabled = true,
+    config = {},
+    plugin,
+    customHide = false
+  } = opt;
 
   // Compatible to solve the windows path problem
   let entryPath = Array.isArray(entry) ? entry : [entry];
@@ -67,6 +73,9 @@ export function viteVConsole(opt: viteVConsoleOptions): Plugin {
         )}});
         window.vConsole = vConsole;
         ${plugins}
+        if (${customHide}) {
+          vConsole.destroy()
+        }
         /* eslint-enable */${_source}`;
 
         return {

src/types.ts

@@ -6,6 +6,7 @@ export interface viteVConsoleOptions {
   localEnabled?: boolean; // serve dev enabled
   enabled?: boolean; // enabled
   config?: VConsoleOptions; // vconsole option
+  customHide?: string; // custom hide rule code string
   plugin?: {
     id: string;
     name: string;