@tomjs/vite-plugin-vscode 2.5.3 → 2.5.4

package/README.md

@@ -1,6 +1,6 @@
 # @tomjs/vite-plugin-vscode
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-vscode)](https://www.npmjs.com/package/@tomjs/vite-plugin-vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-vscode)
+[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-vscode)](https://www.npmjs.com/package/@tomjs/vite-plugin-vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-vscode) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vite-plugin-vscode/dist/index.d.ts)
 
 **English** | [中文](./README.zh_CN.md)
 

package/README.zh_CN.md

@@ -1,6 +1,6 @@
 # @tomjs/vite-plugin-vscode
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-vscode)](https://www.npmjs.com/package/@tomjs/vite-plugin-vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-vscode)
+[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-vscode)](https://www.npmjs.com/package/@tomjs/vite-plugin-vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-vscode) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vite-plugin-vscode/dist/index.d.ts)
 
 [English](./README.md) | **中文**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/vite-plugin-vscode",
-  "version": "2.5.3",
+  "version": "2.5.4",
   "description": "Use vue/react to develop 'vscode extension webview', supporting esm/cjs",
   "keywords": [
     "vite",

package/dist/client.global.js

@@ -1,98 +0,0 @@
-"use strict";
-(() => {
-  var __getOwnPropNames = Object.getOwnPropertyNames;
-  var __commonJS = (cb, mod) => function __require() {
-    return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
-  };
-
-  // src/webview/client.ts
-  var require_client = __commonJS({
-    "src/webview/client.ts"() {
-      if (window.top === window.self) {
-        return;
-      }
-      var TAG = "[@tomjs:vscode:client] ";
-      patchAcquireVsCodeApi();
-      function onDomReady(callback) {
-        if (document.readyState === "interactive" || document.readyState === "complete") {
-          callback();
-        } else {
-          document.addEventListener("DOMContentLoaded", callback);
-        }
-      }
-      function patchInitData(data) {
-        onDomReady(() => {
-          console.log(TAG, "patch client style");
-          const { style, body, root } = data;
-          document.documentElement.style.cssText = root.cssText;
-          document.body.className = body.className;
-          Object.keys(body.dataset).forEach((key) => {
-            document.body.dataset[key] = body.dataset[key];
-          });
-          const defaultStyles = document.createElement("style");
-          defaultStyles.id = "_defaultStyles";
-          defaultStyles.textContent = style;
-          document.head.appendChild(defaultStyles);
-        });
-      }
-      var GET_STATE_TYPE = "[vscode:client]:getState";
-      var SET_STATE_TYPE = "[vscode:client]:setState";
-      var POST_MESSAGE_TYPE = "[vscode:client]:postMessage";
-      function patchAcquireVsCodeApi() {
-        class AcquireVsCodeApi {
-          postMessage(message) {
-            console.log(TAG, "mock acquireVsCodeApi.postMessage:", message);
-            window.parent.postMessage({ type: POST_MESSAGE_TYPE, data: message }, "*");
-          }
-          getState() {
-            console.log(TAG, "mock acquireVsCodeApi.getState");
-            return new Promise((resolve, reject) => {
-              function post() {
-                window.parent.postMessage({ type: GET_STATE_TYPE }, "*");
-              }
-              const timeoutId = setTimeout(() => {
-                window.removeEventListener("message", receive);
-                reject(new Error("Timeout"));
-              }, 2e3);
-              function receive(e) {
-                var _a, _b;
-                console.log(e);
-                if (!e.origin.startsWith("vscode-webview://") || ((_a = e.data) == null ? void 0 : _a.type) !== GET_STATE_TYPE) {
-                  return;
-                }
-                window.removeEventListener("message", receive);
-                clearTimeout(timeoutId);
-                resolve((_b = e.data) == null ? void 0 : _b.data);
-              }
-              window.addEventListener("message", receive);
-              post();
-            });
-          }
-          setState(newState) {
-            console.log(TAG, "mock acquireVsCodeApi.setState:", newState);
-            window.parent.postMessage({ type: SET_STATE_TYPE, data: newState }, "*");
-          }
-        }
-        console.log(TAG, "patch acquireVsCodeApi");
-        let api;
-        window.acquireVsCodeApi = () => {
-          if (!api) {
-            api = new AcquireVsCodeApi();
-            return api;
-          } else {
-            return api;
-          }
-        };
-      }
-      var INIT_TYPE = "[vscode:extension]:init";
-      window.addEventListener("message", (e) => {
-        const { type, data } = e.data || {};
-        if (!e.origin.startsWith("vscode-webview://") || type !== INIT_TYPE) {
-          return;
-        }
-        patchInitData(data);
-      });
-    }
-  });
-  require_client();
-})();

package/dist/index.d.mts

@@ -1,95 +0,0 @@
-import { Plugin } from 'vite';
-import { Options } from 'tsup';
-
-/**
- * vscode extension options. See [tsup](https://tsup.egoist.dev/) and [API Doc](https://paka.dev/npm/tsup) for more information.
- */
-interface ExtensionOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess' | 'skipNodeModulesBundle'> {
-    /**
-     * The extension entry file.
-     * @default "extension/index.ts"
-     */
-    entry?: string;
-    /**
-     * The output directory for the extension files. Default is `dist-extension`.
-     * @default "dist-extension"
-     */
-    outDir?: string;
-    /**
-     * The bundle format. Currently only supports cjs.
-     */
-    format?: 'cjs';
-    /**
-     * Skip dependencies and peerDependencies bundle. Default is false.
-     */
-    skipNodeModulesBundle?: boolean;
-    /**
-     * A function that will be executed after the build succeeds.
-     */
-    onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
-}
-/**
- * vscode webview options.
- */
-interface WebviewOption {
-    /**
-     * The method name to inject. Default is '__getWebviewHtml__'
-     */
-    name?: string;
-    /**
-     * The CSP meta for the webview. Default is `<meta http-equiv="Content-Security-Policy" content="default-src 'none'; style-src {{cspSource}} 'unsafe-inline'; script-src 'nonce-{{nonce}}' 'unsafe-eval';">`
-     */
-    csp?: string;
-}
-/**
- * vite plugin options.
- */
-interface PluginOptions {
-    /**
-     * Recommended switch. Default is true.
-     * if true, will have the following default behavior:
-     * * will change the extension/webview outDir to be parallel outDir;
-     * eg. if vite build.outDir is 'dist', will change extension/webview to 'dist/extension' and 'dist/webview'
-     * @default true
-     */
-    recommended?: boolean;
-    /**
-     * Inject [@tomjs/vscode-extension-webview](https://github.com/tomjs/vscode-extension-webview) into vscode extension code and web client code, so that webview can support HMR during the development stage.
-     *
-     * * vite serve
-     *    * extension: Inject `import __getWebviewHtml__ from '@tomjs/vscode-extension-webview';` above the file that calls the `__getWebviewHtml__` method
-     *    * web: Add `<script>` tag to index.html and inject `@tomjs/vscode-extension-webview/client` code
-     * * vite build
-     *    * extension: Inject `import __getWebviewHtml__ from '@tomjs/vite-plugin-vscode-inject';` above the file that calls the `__getWebviewHtml__` method
-     *
-     * If is string, will set inject method name. Default is '__getWebviewHtml__'.
-     *
-     * @example
-     * extension file
-     * ```ts
-     *function setupHtml(webview: Webview, context: ExtensionContext) {
-     *  if (process.env.VITE_DEV_SERVER_URL) {
-     *    return __getWebviewHtml__(process.env.VITE_DEV_SERVER_URL);
-     *  }
-     *  return __getWebviewHtml__(webview, context);
-     *}
-     * ```
-     * webview client
-     * ```html
-     * <html>
-     *  <head>
-     *    <script>inject code</script>
-     *  </head>
-     * </html>
-     * ```
-     */
-    webview?: boolean | string | WebviewOption;
-    /**
-     * extension vite config.
-     */
-    extension?: ExtensionOptions;
-}
-
-declare function useVSCodePlugin(options?: PluginOptions): Plugin[];
-
-export { useVSCodePlugin as default, useVSCodePlugin };

package/dist/index.d.ts

@@ -1,95 +0,0 @@
-import { Plugin } from 'vite';
-import { Options } from 'tsup';
-
-/**
- * vscode extension options. See [tsup](https://tsup.egoist.dev/) and [API Doc](https://paka.dev/npm/tsup) for more information.
- */
-interface ExtensionOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess' | 'skipNodeModulesBundle'> {
-    /**
-     * The extension entry file.
-     * @default "extension/index.ts"
-     */
-    entry?: string;
-    /**
-     * The output directory for the extension files. Default is `dist-extension`.
-     * @default "dist-extension"
-     */
-    outDir?: string;
-    /**
-     * The bundle format. Currently only supports cjs.
-     */
-    format?: 'cjs';
-    /**
-     * Skip dependencies and peerDependencies bundle. Default is false.
-     */
-    skipNodeModulesBundle?: boolean;
-    /**
-     * A function that will be executed after the build succeeds.
-     */
-    onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
-}
-/**
- * vscode webview options.
- */
-interface WebviewOption {
-    /**
-     * The method name to inject. Default is '__getWebviewHtml__'
-     */
-    name?: string;
-    /**
-     * The CSP meta for the webview. Default is `<meta http-equiv="Content-Security-Policy" content="default-src 'none'; style-src {{cspSource}} 'unsafe-inline'; script-src 'nonce-{{nonce}}' 'unsafe-eval';">`
-     */
-    csp?: string;
-}
-/**
- * vite plugin options.
- */
-interface PluginOptions {
-    /**
-     * Recommended switch. Default is true.
-     * if true, will have the following default behavior:
-     * * will change the extension/webview outDir to be parallel outDir;
-     * eg. if vite build.outDir is 'dist', will change extension/webview to 'dist/extension' and 'dist/webview'
-     * @default true
-     */
-    recommended?: boolean;
-    /**
-     * Inject [@tomjs/vscode-extension-webview](https://github.com/tomjs/vscode-extension-webview) into vscode extension code and web client code, so that webview can support HMR during the development stage.
-     *
-     * * vite serve
-     *    * extension: Inject `import __getWebviewHtml__ from '@tomjs/vscode-extension-webview';` above the file that calls the `__getWebviewHtml__` method
-     *    * web: Add `<script>` tag to index.html and inject `@tomjs/vscode-extension-webview/client` code
-     * * vite build
-     *    * extension: Inject `import __getWebviewHtml__ from '@tomjs/vite-plugin-vscode-inject';` above the file that calls the `__getWebviewHtml__` method
-     *
-     * If is string, will set inject method name. Default is '__getWebviewHtml__'.
-     *
-     * @example
-     * extension file
-     * ```ts
-     *function setupHtml(webview: Webview, context: ExtensionContext) {
-     *  if (process.env.VITE_DEV_SERVER_URL) {
-     *    return __getWebviewHtml__(process.env.VITE_DEV_SERVER_URL);
-     *  }
-     *  return __getWebviewHtml__(webview, context);
-     *}
-     * ```
-     * webview client
-     * ```html
-     * <html>
-     *  <head>
-     *    <script>inject code</script>
-     *  </head>
-     * </html>
-     * ```
-     */
-    webview?: boolean | string | WebviewOption;
-    /**
-     * extension vite config.
-     */
-    extension?: ExtensionOptions;
-}
-
-declare function useVSCodePlugin(options?: PluginOptions): Plugin[];
-
-export { useVSCodePlugin as default, useVSCodePlugin };