@sveltejs/vite-plugin-svelte 1.0.0-next.42 → 1.0.0-next.45

package/dist/index.d.ts

@@ -8,7 +8,7 @@ interface Options {
     /**
      * Path to a svelte config file, either absolute or relative to Vite root
      *
-     * set to `false` to skip reading config from a file
+     * set to `false` to ignore the svelte config file
      *
      * @see https://vitejs.dev/config/#root
      */
@@ -46,11 +46,13 @@ interface Options {
      */
     emitCss?: boolean;
     /**
-     * The options to be passed to the Svelte compiler
+     * The options to be passed to the Svelte compiler. A few options are set by default,
+     * including `dev` and `css`. However, some options are non-configurable, like
+     * `filename`, `format`, `generate`, and `cssHash` (in dev).
      *
      * @see https://svelte.dev/docs#svelte_compile
      */
-    compilerOptions?: CompileOptions;
+    compilerOptions?: Omit<CompileOptions, 'filename' | 'format' | 'generate'>;
     /**
      * Handles warning emitted from the Svelte compiler
      */
@@ -150,11 +152,54 @@ interface ExperimentalOptions {
         code: string;
         compileOptions: Partial<CompileOptions>;
     }) => Promise<Partial<CompileOptions> | void> | Partial<CompileOptions> | void;
+    /**
+     * enable svelte inspector
+     */
+    inspector?: InspectorOptions | boolean;
+}
+interface InspectorOptions {
+    /**
+     * define a key combo to toggle inspector,
+     * @default 'control-shift' on windows, 'meta-shift' on other os
+     *
+     * any number of modifiers `control` `shift` `alt` `meta` followed by zero or one regular key, separated by -
+     * examples: control-shift, control-o, control-alt-s  meta-x control-meta
+     * Some keys have native behavior (e.g. alt-s opens history menu on firefox).
+     * To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended.
+     */
+    toggleKeyCombo?: string;
+    /**
+     * inspector is automatically disabled when releasing toggleKeyCombo after holding it for a longpress
+     * @default false
+     */
+    holdMode?: boolean;
+    /**
+     * when to show the toggle button
+     * @default 'active'
+     */
+    showToggleButton?: 'always' | 'active' | 'never';
+    /**
+     * where to display the toggle button
+     * @default top-right
+     */
+    toggleButtonPos?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
+    /**
+     * inject custom styles when inspector is active
+     */
+    customStyles?: boolean;
+    /**
+     * append an import to the module id ending with `appendTo` instead of adding a script into body
+     * useful for frameworks that do not support trannsformIndexHtml hook
+     *
+     * WARNING: only set this if you know exactly what it does.
+     * Regular users of vite-plugin-svelte or SvelteKit do not need it
+     */
+    appendTo?: string;
 }
 declare type ModuleFormat = NonNullable<CompileOptions['format']>;
 declare type CssHashGetter = NonNullable<CompileOptions['cssHash']>;
 declare type Arrayable<T> = T | T[];
 
-declare function svelte(inlineOptions?: Partial<Options>): Plugin;
+declare function svelte(inlineOptions?: Partial<Options>): Plugin[];
 
 export { Arrayable, CssHashGetter, ModuleFormat, Options, svelte };