| 1 | export * from '@stencil/core/internal';
|
| 2 | export interface PluginOptions {
|
| 3 | /**
|
| 4 | * Path to a file to compile.
|
| 5 | */
|
| 6 | file?: string;
|
| 7 | /**
|
| 8 | * A string to pass to compile.
|
| 9 | *
|
| 10 | * It is recommended that you use `includePaths` in conjunction with this so that sass can find files when using the @import directive.
|
| 11 | */
|
| 12 | data?: string;
|
| 13 | /**
|
| 14 | * Handles when the @import directive is encountered.
|
| 15 | *
|
| 16 | * A custom importer allows extension of the sass engine in both a synchronous and asynchronous manner.
|
| 17 | */
|
| 18 | importer?: Importer | Importer[];
|
| 19 | /**
|
| 20 | * Holds a collection of custom functions that may be invoked by the sass files being compiled.
|
| 21 | */
|
| 22 | functions?: {
|
| 23 | [key: string]: (...args: any[]) => any;
|
| 24 | };
|
| 25 | /**
|
| 26 | * An array of paths that should be looked in to attempt to resolve your @import declarations.
|
| 27 | * When using `data`, it is recommended that you use this.
|
| 28 | */
|
| 29 | includePaths?: string[];
|
| 30 | /**
|
| 31 | * Used for Sass variables, mixins and functions files that do not contain any CSS.
|
| 32 | * This config is custom to `@stencil/sass`.
|
| 33 | */
|
| 34 | injectGlobalPaths?: string[];
|
| 35 | /**
|
| 36 | * Enable Sass Indented Syntax for parsing the data string or file.
|
| 37 | */
|
| 38 | indentedSyntax?: boolean;
|
| 39 | /**
|
| 40 | * Used to determine whether to use space or tab character for indentation.
|
| 41 | */
|
| 42 | indentType?: 'space' | 'tab';
|
| 43 | /**
|
| 44 | * Used to determine the number of spaces or tabs to be used for indentation.
|
| 45 | */
|
| 46 | indentWidth?: number;
|
| 47 | /**
|
| 48 | * Used to determine which sequence to use for line breaks.
|
| 49 | */
|
| 50 | linefeed?: 'cr' | 'crlf' | 'lf' | 'lfcr';
|
| 51 | /**
|
| 52 | * Disable the inclusion of source map information in the output file.
|
| 53 | */
|
| 54 | omitSourceMapUrl?: boolean;
|
| 55 | /**
|
| 56 | * Specify the intended location of the output file.
|
| 57 | * Strongly recommended when outputting source maps so that they can properly refer back to their intended files.
|
| 58 | */
|
| 59 | outFile?: string;
|
| 60 | /**
|
| 61 | * Determines the output format of the final CSS style.
|
| 62 | */
|
| 63 | outputStyle?: 'compressed' | 'expanded';
|
| 64 | /**
|
| 65 | * Enables the outputting of a source map.
|
| 66 | */
|
| 67 | sourceMap?: boolean | string;
|
| 68 | /**
|
| 69 | * Includes the contents in the source map information.
|
| 70 | */
|
| 71 | sourceMapContents?: boolean;
|
| 72 | /**
|
| 73 | * Embeds the source map as a data URI.
|
| 74 | */
|
| 75 | sourceMapEmbed?: boolean;
|
| 76 | /**
|
| 77 | * The value will be emitted as `sourceRoot` in the source map information.
|
| 78 | */
|
| 79 | sourceMapRoot?: string;
|
| 80 | }
|
| 81 | export declare type ImporterReturnType = {
|
| 82 | file: string;
|
| 83 | } | {
|
| 84 | contents: string;
|
| 85 | } | Error | null;
|
| 86 | export declare type Importer = (url: string, prev: string, done: (data: ImporterReturnType) => void) => ImporterReturnType | void;
|