@sveltejs/vite-plugin-svelte 1.0.0-next.9 → 1.0.2

package/dist/index.d.ts

@@ -1,214 +1,231 @@
-import { Plugin as Plugin_2 } from 'vite';
-
-export declare type Arrayable<T> = T | T[];
-
-export declare interface CompileOptions {
-    format?: ModuleFormat;
-    name?: string;
-    filename?: string;
-    generate?: 'dom' | 'ssr' | false;
-    sourcemap?: object | string;
-    outputFilename?: string;
-    cssOutputFilename?: string;
-    sveltePath?: string;
-    dev?: boolean;
-    accessors?: boolean;
-    immutable?: boolean;
-    hydratable?: boolean;
-    legacy?: boolean;
-    customElement?: boolean;
-    tag?: string;
-    css?: boolean;
-    loopGuardTimeout?: number;
-    namespace?: string;
-    preserveComments?: boolean;
-    preserveWhitespace?: boolean;
-    cssHash?: CssHashGetter;
-}
-
-export declare type CssHashGetter = (args: {
-    name: string;
-    filename: string | undefined;
-    css: string;
-    hash: (input: string) => string;
-}) => string;
-
-export declare type MarkupPreprocessor = (options: {
-    content: string;
-    filename: string;
-}) => Processed | Promise<Processed>;
-
-export declare type ModuleFormat = 'esm' | 'cjs';
-
-export declare interface Options {
-    /** path to svelte config file, either absolute or relative to vite root*/
-    configFile?: string;
-    /** One or more minimatch patterns */
-    include?: Arrayable<string>;
-    /** One or more minimatch patterns */
-    exclude?: Arrayable<string>;
-    /**
-     * By default, all ".svelte" files are compiled
-     * @default ['.svelte']
-     */
-    extensions?: string[];
-    /**
-     * Optionally, preprocess components with svelte.preprocess:
-     * \@see https://svelte.dev/docs#svelte_preprocess
-     */
-    preprocess?: Arrayable<PreprocessorGroup>;
-    /** Emit Svelte styles as virtual CSS files for other plugins to process.
-     * @default true
-     */
-    emitCss?: boolean;
-    /** Options passed to `svelte.compile` method. */
-    compilerOptions: Partial<CompileOptions>;
-    onwarn?: undefined | false | ((warning: any, defaultHandler?: any) => void);
-    /**
-     * enable/disable hmr. You want this enabled.
-     *
-     * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-     * DO NOT CUSTOMIZE SVELTE-HMR OPTIONS UNLESS YOU KNOW EXACTLY WHAT YOU ARE DOING
-     *
-     *                             YOU HAVE BEEN WARNED
-     * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-     *
-     * @default true for development, always false for production
-     */
-    hot?: undefined | boolean | {
-        /**
-         * preserve all local state
-         * @default false
-         */
-        preserveLocalState?: boolean;
-        /**
-         * escape hatchs from preservation of local state
-         * disable preservation of state for this component
-         *
-         * @default ['\@hmr:reset', '\@!hmr']
-         */
-        noPreserveStateKey?: string[];
-        /**
-         * enable preservation of state for all variables in this component
-         *
-         * @default '\@hmr:keep-all'
-         */
-        preserveAllLocalStateKey?: string;
-        /**
-         * enable preservation of state for a given variable (must be inline or
-         * above the target variable or variables; can be repeated)
-         *
-         * @default '\@hmr:keep'
-         */
-        preserveLocalStateKey?: string;
-        /**
-         * don't reload on fatal error
-         *
-         * @default false
-         */
-        noReload?: boolean;
-        /**
-         * try to recover after runtime errors during component init
-         *
-         * @default true
-         */
-        optimistic?: boolean;
-        /**
-         * auto accept modules of components that have named exports (i.e. exports
-         * from context="module")
-         *
-         * @default true
-         */
-        acceptNamedExports?: boolean;
-        /**
-         * auto accept modules of components have accessors (either accessors compile
-         * option, or \<svelte:option accessors=\{true\} /\>) -- this means that if you
-         * set accessors compile option globally, you must also set this option to
-         * true, or no component will be hot reloaded (but there are a lot of edge
-         * cases that HMR can't support correctly with accessors)
-         *
-         * @default true
-         */
-        acceptAccessors?: boolean;
-        /**
-         * only inject CSS instead of recreating components when only CSS changes
-         *
-         * @default true, but vite-plugin-svelte configures this automatically according to emitCss requirements
-         */
-        injectCss?: boolean;
-        /**
-         * to mitigate FOUC between dispose (remove stylesheet) and accept
-         *
-         * note: has no effect when emitCss is true (vite-plugin-svelte default)
-         * @default 100
-         */
-        cssEjectDelay?: number;
-        /**
-         * Svelte Native mode
-         *
-         * @default false
-         */
-        native?: boolean;
-        /**
-         * name of the adapter import binding
-         *
-         * @default '___SVELTE_HMR_HOT_API_PROXY_ADAPTER'
-         */
-        importAdapterName?: string;
-        /**
-         * use absolute file paths to import runtime deps of svelte-hmr
-         * (see https://github.com/rixo/svelte-hmr/issues/11)
-         *
-         * @default true
-         */
-        absoluteImports?: boolean;
-        /**
-         * disable runtime error overlay
-         *
-         * @default false
-         */
-        noOverlay?: boolean;
-        /**
-         * custom import path for hotApi
-         */
-        hotApi?: string;
-        /**
-         * custom path for adapter
-         */
-        adapter?: string;
-    };
-    /**
-     * disable separate hmr update for css files via vite
-     * @default false
-     */
-    disableCssHmr?: boolean;
-    /**
-     * use vite as extra css preprocessor EXPERIMENTAL!
-     * @default false
-     */
-    useVitePreprocess?: boolean;
-}
-
-export declare type Preprocessor = (options: {
-    content: string;
-    attributes: Record<string, string | boolean>;
-    filename?: string;
-}) => Processed | Promise<Processed>;
-
-export declare interface PreprocessorGroup {
-    markup?: MarkupPreprocessor;
-    style?: Preprocessor;
-    script?: Preprocessor;
-}
-
-export declare interface Processed {
-    code: string;
-    map?: string | object;
-    dependencies?: string[];
-    toString?: () => string;
-}
-
-declare function vitePluginSvelte(inlineOptions?: Partial<Options>): Plugin_2;
-export default vitePluginSvelte;
-
-export { }
+import { UserConfig, Plugin } from 'vite';
+import { CompileOptions, Warning } from 'svelte/types/compiler/interfaces';
+export { CompileOptions, Warning } from 'svelte/types/compiler/interfaces';
+import { PreprocessorGroup } from 'svelte/types/compiler/preprocess';
+export { MarkupPreprocessor, Preprocessor, PreprocessorGroup, Processed } from 'svelte/types/compiler/preprocess';
+
+declare type Options = Omit<SvelteOptions, 'vitePlugin'> & PluginOptionsInline;
+interface PluginOptionsInline extends PluginOptions {
+    /**
+     * Path to a svelte config file, either absolute or relative to Vite root
+     *
+     * set to `false` to ignore the svelte config file
+     *
+     * @see https://vitejs.dev/config/#root
+     */
+    configFile?: string | false;
+}
+interface PluginOptions {
+    /**
+     * A `picomatch` pattern, or array of patterns, which specifies the files the plugin should
+     * operate on. By default, all svelte files are included.
+     *
+     * @see https://github.com/micromatch/picomatch
+     */
+    include?: Arrayable<string>;
+    /**
+     * A `picomatch` pattern, or array of patterns, which specifies the files to be ignored by the
+     * plugin. By default, no files are ignored.
+     *
+     * @see https://github.com/micromatch/picomatch
+     */
+    exclude?: Arrayable<string>;
+    /**
+     * Emit Svelte styles as virtual CSS files for Vite and other plugins to process
+     *
+     * @default true
+     */
+    emitCss?: boolean;
+    /**
+     * Enable or disable Hot Module Replacement.
+     *
+     * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+     *
+     * DO NOT CUSTOMIZE SVELTE-HMR OPTIONS UNLESS YOU KNOW EXACTLY WHAT YOU ARE DOING
+     *
+     *                             YOU HAVE BEEN WARNED
+     *
+     * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+     *
+     * Set an object to pass custom options to svelte-hmr
+     *
+     * @see https://github.com/rixo/svelte-hmr#options
+     * @default true for development, always false for production
+     */
+    hot?: boolean | {
+        injectCss?: boolean;
+        [key: string]: any;
+    };
+    /**
+     * Some Vite plugins can contribute additional preprocessors by defining `api.sveltePreprocess`.
+     * If you don't want to use them, set this to true to ignore them all or use an array of strings
+     * with plugin names to specify which.
+     *
+     * @default false
+     */
+    ignorePluginPreprocessors?: boolean | string[];
+    /**
+     * vite-plugin-svelte automatically handles excluding svelte libraries and reinclusion of their dependencies
+     * in vite.optimizeDeps.
+     *
+     * `disableDependencyReinclusion: true` disables all reinclusions
+     * `disableDependencyReinclusion: ['foo','bar']` disables reinclusions for dependencies of foo and bar
+     *
+     * This should be used for hybrid packages that contain both node and browser dependencies, eg Routify
+     *
+     * @default false
+     */
+    disableDependencyReinclusion?: boolean | string[];
+    /**
+     * These options are considered experimental and breaking changes to them can occur in any release
+     */
+    experimental?: ExperimentalOptions;
+}
+interface SvelteOptions {
+    /**
+     * A list of file extensions to be compiled by Svelte
+     *
+     * @default ['.svelte']
+     */
+    extensions?: string[];
+    /**
+     * An array of preprocessors to transform the Svelte source code before compilation
+     *
+     * @see https://svelte.dev/docs#svelte_preprocess
+     */
+    preprocess?: Arrayable<PreprocessorGroup>;
+    /**
+     * 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?: Omit<CompileOptions, 'filename' | 'format' | 'generate'>;
+    /**
+     * Handles warning emitted from the Svelte compiler
+     */
+    onwarn?: (warning: Warning, defaultHandler?: (warning: Warning) => void) => void;
+    /**
+     * Options for vite-plugin-svelte
+     */
+    vitePlugin?: PluginOptions;
+}
+/**
+ * These options are considered experimental and breaking changes to them can occur in any release
+ */
+interface ExperimentalOptions {
+    /**
+     * Use extra preprocessors that delegate style and TypeScript preprocessing to native Vite plugins
+     *
+     * Do not use together with `svelte-preprocess`!
+     *
+     * @default false
+     */
+    useVitePreprocess?: boolean;
+    /**
+     * Force Vite to pre-bundle Svelte libraries
+     *
+     * @default false
+     */
+    prebundleSvelteLibraries?: boolean;
+    /**
+     * If a preprocessor does not provide a sourcemap, a best-effort fallback sourcemap will be provided.
+     * This option requires `diff-match-patch` to be installed as a peer dependency.
+     *
+     * @see https://github.com/google/diff-match-patch
+     * @default false
+     */
+    generateMissingPreprocessorSourcemaps?: boolean;
+    /**
+     * A function to update `compilerOptions` before compilation
+     *
+     * `data.filename` - The file to be compiled
+     * `data.code` - The preprocessed Svelte code
+     * `data.compileOptions` - The current compiler options
+     *
+     * To change part of the compiler options, return an object with the changes you need.
+     *
+     * @example
+     * ```
+     * ({ filename, compileOptions }) => {
+     *   // Dynamically set hydration per Svelte file
+     *   if (compileWithHydratable(filename) && !compileOptions.hydratable) {
+     *     return { hydratable: true };
+     *   }
+     * }
+     * ```
+     */
+    dynamicCompileOptions?: (data: {
+        filename: string;
+        code: string;
+        compileOptions: Partial<CompileOptions>;
+    }) => Promise<Partial<CompileOptions> | void> | Partial<CompileOptions> | void;
+    /**
+     * enable svelte inspector
+     */
+    inspector?: InspectorOptions | boolean;
+    /**
+     * send a websocket message with svelte compiler warnings during dev
+     *
+     */
+    sendWarningsToBrowser?: 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 loadSvelteConfig(viteConfig?: UserConfig, inlineOptions?: Partial<Options>): Promise<Partial<SvelteOptions> | undefined>;
+
+declare type SvelteWarningsMessage = {
+    id: string;
+    filename: string;
+    normalizedFilename: string;
+    timestamp: number;
+    warnings: Warning[];
+    allWarnings: Warning[];
+    rawWarnings: Warning[];
+};
+
+declare function svelte(inlineOptions?: Partial<Options>): Plugin[];
+
+export { Arrayable, CssHashGetter, ModuleFormat, Options, PluginOptions, SvelteOptions, SvelteWarningsMessage, loadSvelteConfig, svelte };