@sssx/config/dist/types.d.ts

Configuration parser for SSSX

import type { CompileOptions } from 'svelte/types/compiler';
export interface Config extends Record<string, unknown> {
    /**
     * Domain + protocol of where your website will be hosted.
     * @example https://www.example.com
     */
    origin: string;
    /**
     * Destination directory
     * @default ".sssx"
     */
    distDir: string;
    /**
     * Destination directory
     * @default "dist"
     */
    outDir: string;
    /**
     * Public directory
     * @default "public"
     */
    publicDir: string;
    /**
     * Destination directory for JS code
     * @default "__SSSX__"
     */
    appDir: string;
    /**
     * Deploy a SSSX website under a sub-path of a domain
     * @default ""
     */
    basePath: string;
    /**
     * Where do you put your routes
     * @default "routes"
     */
    routesPath: string;
    /**
     * Name of the typescript file with the route's data functons
     * @default 'route'
     */
    routeName: string;
    /**
     * Where do you put your components
     * @default "components"
     */
    componentsPath: string;
    /**
     * Where do you put your styles
     * @default "styles"
     */
    stylesPath: string;
    /**
     * Compiler options passed down to Svelte compiler
     */
    compilerOptions?: CompileOptions;
    /**
     * Name of the plugin's NPM package and its configuration
     */
    plugins: Record<string, unknown>;
    /**
     * Directory where all routes and components are.
     * @default 'src'
     */
    sourceRoot: string;
    /**
     * Directory where all SSR generated files are stored.
     * @default 'ssr'
     */
    ssrRoot: string;
    /**
     * Directory where all compiled TS and Svelte files are stored.
     * @default 'compiled'
     */
    compiledRoot: string;
    /**
     * This prefix will be added to each generated file.
     * @default 'sssx'
     */
    filenamesPrefix: string;
    /**
     * Copy directories with all the files recursively
     */
    copyFiles: Array<{
        from: string;
        to?: string;
    }>;
}
//# sourceMappingURL=types.d.ts.map