vite-plugin-debugger 0.0.5 → 0.0.7

package/dist/index.d.ts

@@ -2,15 +2,19 @@ import { Plugin } from 'vite';
 import { InitOptions } from 'eruda';
 import { VConsoleOptions } from 'core/options.interface';
 
+declare type CDN = 'jsdelivr' | 'unpkg' | 'cdnjs';
+
 declare type ErudaPlugin = 'fps' | 'features' | 'timing' | 'memory' | 'code' | 'benchmark' | 'geolocation' | 'dom' | 'orientation' | 'touches';
-interface ErudaOptions extends CommonOptions {
+interface ErudaConfig extends CommonConfig {
     /**
      * eruda options
+     *
      * see also https://github.com/liriliri/eruda/blob/master/doc/API.md
      */
     options?: InitOptions;
     /**
      * eruda plugins
+     *
      * see also https://github.com/liriliri/eruda#plugins
      */
     plugins?: ErudaPlugin[] | {
@@ -19,44 +23,63 @@ interface ErudaOptions extends CommonOptions {
     }[];
 }
 
-interface vConsoleOptions extends CommonOptions {
+interface VConsoleConfig extends CommonConfig {
+    /**
+     * vConsole options
+     *
+     * see also https://github.com/Tencent/vConsole/blob/dev/doc/public_properties_methods.md#vconsoleoption
+     */
     options?: VConsoleOptions;
 }
 
-declare type CDN = 'jsdelivr' | 'unpkg' | 'cdnjs';
+interface CommonConfig {
+  /**
+   * cdn services
+   */
+  cdn?: CDN
+  /**
+   * custom cdn url
+   */
+  src?: string
+}
 
-interface CommonOptions {
-    /**
-     * cdn services
-     */
-    cdn?: CDN;
-    /**
-     * custom cdn url
-     */
-    src?: string;
-}
-interface DebuggerOptions {
-    /**
-     * debug or not
-     */
-    debug?: boolean;
-    /**
-     * use node_modules
-     */
-    local?: boolean;
-    /**
-     * if local is true, use this to specify the path
-     */
-    entry?: string | string[];
-    /**
-     * eruda options
-     */
-    eruda?: ErudaOptions;
-    /**
-     * vConsole options
-     */
-    vConsole?: vConsoleOptions;
-}
-declare const _default: (options: DebuggerOptions) => Plugin;
+interface ActiveConfig {
+  /**
+   * use url or storage
+   */
+  mode: 'url' | 'storage'
+  /**
+   * parameter name
+   */
+  param?: string
+}
+interface DebuggerOptions {
+  /**
+   * debug or not
+   */
+  debug?: boolean
+  /**
+   * active debugger
+   */
+  active?: ActiveConfig
+  /**
+   * use node_modules
+   */
+  local?: boolean
+  /**
+   * if local is true, use this to specify the path
+   */
+  entry?: string | string[]
+  /**
+   * eruda config
+   */
+  eruda?: ErudaConfig
+  /**
+   * vConsole config
+   */
+  vConsole?: VConsoleConfig
+}
+
+declare const vDebugger: (options: DebuggerOptions) => Plugin;
 
-export { CommonOptions, DebuggerOptions, _default as default };
+export { vDebugger as default, vDebugger };

package/dist/index.js

@@ -19,19 +19,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  default: () => src_default
+  default: () => src_default,
+  vDebugger: () => vDebugger
 });
 module.exports = __toCommonJS(src_exports);
-
-// node_modules/.pnpm/slash@4.0.0/node_modules/slash/index.js
-function slash(path) {
-  const isExtendedLengthPath = /^\\\\\?\\/.test(path);
-  const hasNonAscii = /[^\u0000-\u0080]+/.test(path);
-  if (isExtendedLengthPath || hasNonAscii) {
-    return path;
-  }
-  return path.replace(/\\/g, "/");
-}
+var import_vite = require("vite");
 
 // src/helpers/index.ts
 var capitalize = (str) => str.charAt(0).toUpperCase() + str.slice(1);
@@ -48,7 +40,7 @@ var transformCDN = (pkg, cdn) => {
   if (cdn === "cdnjs") {
     if (!Array.isArray(pkg)) {
       if (pkg === "eruda") {
-        return "https://cdnjs.cloudflare.com/ajax/libs/eruda/2.4.1/eruda.min.js";
+        return "https://cdnjs.cloudflare.com/ajax/libs/eruda/2.5.0/eruda.min.js";
       }
       throw new Error(`[vite-plugin-debugger]: ${cdn} only support eruda without its plugins.`);
     }
@@ -56,10 +48,26 @@ var transformCDN = (pkg, cdn) => {
   }
   return "";
 };
+var debugInit = (debug, active) => {
+  return `
+    let showDebug=${debug};
+    let storageStr = ''
+    if(${(active == null ? void 0 : active.mode) === "url"}){
+      let queryStr='';
+      const result = (window.location.href || '').match(new RegExp('[?&]${(active == null ? void 0 : active.param) || "debugwhatever"}=([^&]+)', 'i'));
+      if (Array.isArray(result) && result.length > 1) queryStr= result[1];
+      if (queryStr === 'true') localStorage.setItem('${(active == null ? void 0 : active.param) || "debugwhatever"}', 'true');
+    }
+    if(${(active == null ? void 0 : active.mode) === "url" || (active == null ? void 0 : active.mode) === "storage"})
+      storageStr = localStorage.getItem('${(active == null ? void 0 : active.param) || "debugwhatever"}')
+    if (storageStr === 'true'){ showDebug=true };
+  `;
+};
 
 // src/plugins/eruda.ts
+var import_meta = {};
 var transformErudaOptions = (html, opts) => {
-  const { debug } = opts;
+  const { debug, active } = opts;
   const { options, plugins, cdn = "jsdelivr", src } = opts.eruda;
   const tags = [];
   tags.push({
@@ -69,14 +77,13 @@ var transformErudaOptions = (html, opts) => {
     },
     injectTo: "head"
   });
-  let erudaScript = `eruda.init(${JSON.stringify(options)});
-`;
+  let erudaScript = `eruda.init(${JSON.stringify(options || {})});`;
   if (plugins && plugins.length > 0) {
     if (cdn === "jsdelivr") {
       tags.push({
         tag: "script",
         attrs: {
-          src: transformCDN(plugins.map((plugin) => `eruda-${plugin}`))
+          src: transformCDN(plugins.map((plugin) => `eruda-${plugin}`), cdn)
         },
         injectTo: "head"
       });
@@ -98,19 +105,17 @@ var transformErudaOptions = (html, opts) => {
   }
   tags.push({
     tag: "script",
-    children: erudaScript,
+    children: `${debugInit(debug, active)}
+ if(showDebug===true){ ${erudaScript}}`,
     injectTo: "head"
   });
-  if (debug === true) {
+  if (debug === true || debug === false) {
     return {
       html,
       tags
     };
   }
-  if (debug === false) {
-    return html;
-  }
-  if (process.env.NODE_ENV !== "production") {
+  if (!import_meta.env.PROD) {
     return {
       html,
       tags
@@ -118,7 +123,7 @@ var transformErudaOptions = (html, opts) => {
   }
 };
 var transformErudaImport = (code, opts) => {
-  const { debug } = opts;
+  const { debug, active } = opts;
   const { options = {}, plugins } = opts.eruda;
   let importCode = "import eruda from 'eruda';";
   let erudaScript = `eruda.init(${JSON.stringify(options)});`;
@@ -129,14 +134,19 @@ var transformErudaImport = (code, opts) => {
     });
   }
   return {
-    code: debug ? `/* eslint-disable */;${importCode}${erudaScript}/* eslint-enable */${code}` : code,
+    code: `/* eslint-disable */;
+${importCode}
+ ${debugInit(debug, active)}if(showDebug===true){${erudaScript}}
+/* eslint-enable */
+${code}`,
     map: null
   };
 };
 
 // src/plugins/vConsole.ts
+var import_meta2 = {};
 var transformVConsoleOptions = (html, opts) => {
-  const { debug } = opts;
+  const { debug, active } = opts;
   const { options, cdn = "jsdelivr", src } = opts.vConsole;
   const tags = [];
   tags.push({
@@ -148,19 +158,17 @@ var transformVConsoleOptions = (html, opts) => {
   });
   tags.push({
     tag: "script",
-    children: `var vConsole = new VConsole(${JSON.stringify(options)});`,
+    children: `${debugInit(debug, active)}
+ if(showDebug===true){var vConsole = new VConsole(${JSON.stringify(options || {})})};`,
     injectTo: "head"
   });
-  if (debug === true) {
+  if (debug === true || debug === false) {
     return {
       html,
       tags
     };
   }
-  if (debug === false) {
-    return html;
-  }
-  if (process.env.NODE_ENV !== "production") {
+  if (!import_meta2.env.PROD) {
     return {
       html,
       tags
@@ -168,21 +176,25 @@ var transformVConsoleOptions = (html, opts) => {
   }
 };
 var transformVConsoleImport = (code, opts) => {
-  const { debug } = opts;
+  const { debug, active } = opts;
   const { options = {} } = opts.vConsole;
   return {
-    code: debug ? `/* eslint-disable */;import VConsole from 'vconsole';new VConsole(${JSON.stringify(options)});/* eslint-enable */${code}` : code,
+    code: `/* eslint-disable */;import VConsole from 'vconsole'; ${debugInit(debug, active)}
+ if(showDebug===true){new VConsole(${JSON.stringify(options)})};/* eslint-enable */${code}`,
     map: null
   };
 };
 
 // src/index.ts
-var src_default = (options) => {
+var vDebugger = (options) => {
   const { eruda, vConsole, local, entry } = options;
-  const entryPath = entry ? (Array.isArray(entry) ? entry : [entry]).map((path) => slash(path)) : [];
+  const entryPath = entry ? (Array.isArray(entry) ? entry : [entry]).map((path) => (0, import_vite.normalizePath)(path)) : [];
   if (eruda && vConsole) {
     throw new Error("[vite-plugin-debugger]: You'd better use only one debugger tool at a time.");
   }
+  if (!eruda && !vConsole) {
+    throw new Error("[vite-plugin-debugger]: Which one do you prefer? eruda or vConsole?");
+  }
   return {
     name: "vite-plugin-debugger",
     transformIndexHtml(html) {
@@ -209,5 +221,8 @@ var src_default = (options) => {
     }
   };
 };
+var src_default = vDebugger;
 // Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {});
+0 && (module.exports = {
+  vDebugger
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-debugger",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "A vite plugin provide the debugger tools for mobile devices.",
   "author": "jade-gjz",
   "license": "MIT",
@@ -24,7 +24,7 @@
   "peerDependencies": {
     "eruda": "^2.4.0",
     "vconsole": "^3.14.0",
-    "vite": "^2.0.0"
+    "vite": "^2.0.0 || ^3.0.0"
   },
   "peerDependenciesMeta": {
     "eruda": {
@@ -34,18 +34,6 @@
       "optional": true
     }
   },
-  "devDependencies": {
-    "@jhqn/eslint-config-ts": "^0.0.30",
-    "bumpp": "^8.2.1",
-    "conventional-changelog-cli": "^2.2.2",
-    "eruda": "https://github.com/liriliri/eruda.git",
-    "eslint": "^8.19.0",
-    "slash": "^4.0.0",
-    "tsup": "^6.1.3",
-    "typescript": "^4.7.4",
-    "vconsole": "^3.14.6",
-    "vite": "^2.9.13"
-  },
   "scripts": {
     "dev": "tsup src/index.ts --dts --watch",
     "build": "tsup src/index.ts --dts",

package/README.md

@@ -1,209 +0,0 @@
-
-
-# vite-plugin-debugger
-
-A vite plugin provide the debugger tools for mobile devices.
-
-**English** | [中文](./README.zh_CN.md)
-
-## Install
-
-**node version:** >=14.0.0
-
-**vite version:** >=2.0.0
-
-
-```bash
-pnpm add vite-plugin-debugger -D
-# or
-yarn add vite-plugin-debugger -D
-# or
-npm i vite-plugin-debugger -D
-```
-
-## Usage
-
-### For [eruda](https://github.com/liriliri/eruda)
-
-we use eruda with CDN by default since it's unpacked size is 2.38 MB.
-
-```typescript
-import { fileURLToPath } from 'url'
-import vDebugger from 'vite-plugin-debugger'
-
-const resolve = (dir: string) => fileURLToPath(new URL(dir, import.meta.url))
-
-export default defineConfig(({ command, mode }) => ({
-  plugins: [
-    vDebugger({
-      debug: mode !== 'production',
-      eruda: {
-     // cdn: 'jsdelivr', // 'jsdelivr' | 'unpkg' | 'cdnjs'
-     // src: 'custom CDN URL', 
-        options: {
-          tool: ['console', 'elements'],
-          useShadowDom: true,
-          autoScale: true,
-          defaults: {
-            displaySize: 50,
-            transparency: 0.8,
-            theme: 'Dark',
-          },
-        },
-        plugins: [
-          'fps',
-          'features',
-          'timing',
-          'memory',
-          'code',
-          'benchmark',
-          'dom',
-          'orientation',
-          'touches',
-          // 'geolocation',
-        ],
-      },
-    })
-  ]
-})
-```
-
-
-
-⚠ cdnjs don't provide eruda related plugins so you can specify every plugin's CDN source like:
-
-```
-        plugins: [
-          {
-            name: 'fps',
-            src: 'https://cdn.jsdelivr.net/npm/eruda-fps',
-          },
-       // ...
-        ],
-```
-
-
-
-For more details about eruda options, please check out [eruda API](https://github.com/liriliri/eruda/blob/master/doc/API.md).
-
-If you prefer use eruda locally, you should install eruda and it's plugins first.
-
-```typescript
-pnpm add eruda -D
-# or
-yarn add eruda -D
-# or
-npm i eruda -D
-
-# And some optional plugins
-pnpm[yarn|npm] add eruda-fps eruda-features eruda-timing eruda-memory eruda-code eruda-benchmark eruda-dom eruda-orientation eruda-touches eruda-geolocation -D
-```
-
-```typescript
-import { fileURLToPath } from 'url'
-import vDebugger from 'vite-plugin-debugger'
-
-const resolve = (dir: string) => fileURLToPath(new URL(dir, import.meta.url))
-
-export default defineConfig(({ command, mode })=>({
-  plugins:[
-    vDebugger({
-      debug: mode !== 'production',
-      local: true,
-      entry: resolve('src/main.ts'),// vue or src/main.tsx for react
-      eruda: {
-        options: {
-          tool: ['console', 'elements'],
-          useShadowDom: true,
-          autoScale: true,
-          defaults: {
-            displaySize: 50,
-            transparency: 0.8,
-            theme: 'Dark',
-          },
-        },
-        plugins: [
-          'fps',
-          'features',
-          'timing',
-          'memory',
-          'code',
-          'benchmark',
-          'dom',
-          'orientation',
-          'touches',
-          // 'geolocation',
-        ],
-    })
-  ]
-})
-```
-
-### For [vConsole](https://github.com/Tencent/vConsole)
-
-we use vConsole with CDN by default since it's unpacked size is 344 kB.
-
-```typescript
-import { fileURLToPath } from 'url'
-import vDebugger from 'vite-plugin-debugger'
-
-const resolve = (dir: string) => fileURLToPath(new URL(dir, import.meta.url))
-
-export default defineConfig(({ command, mode })=>({
-  plugins:[
-    vDebugger({
-      debug: mode !== 'production',
-      vConsole: {
-        options: {
-          theme: 'dark',
-        },
-      },
-    })
-  ]
-})
-```
-
-
-
-For more details about vConsole options, please check out [vConsole API](https://github.com/Tencent/vConsole/blob/dev/doc/public_properties_methods.md).
-
-If you prefer use vConsole locally, you should install vConsole first.
-
-```bash
-pnpm add vconsole -D
-# or
-yarn add vconsole -D
-# or
-npm i vconsole -D
-```
-
-
-
-```typescript
-import { fileURLToPath } from 'url'
-import vDebugger from 'vite-plugin-debugger'
-
-const resolve = (dir: string) => fileURLToPath(new URL(dir, import.meta.url))
-
-export default defineConfig(({ command, mode })=>({
-  plugins:[
-    vDebugger({
-      debug: mode !== 'production',
-      local: true,
-      entry: resolve('src/main.ts'),// vue or src/main.tsx for react
-      vConsole: {
-        options: {
-          theme: 'dark',
-        },
-      },
-    })
-  ]
-})
-```
-
-
-
-
-## License
-
-[MIT](LICENSE)