typescript-plugin-css-modules/dist/options.d.ts

CSS modules support for TypeScript

import { Options as SassOptions } from 'sass';
import type tsModule from 'typescript/lib/tsserverlibrary';
import { DotenvConfigOptions } from 'dotenv';
import { CSSExports } from 'icss-utils';
import stylus from 'stylus';
import { Logger } from './helpers/logger';
import type { RawSourceMap } from 'source-map-js';
type StylusRenderOptions = Parameters<typeof stylus>[1];
export interface PostcssOptions {
    excludePlugins?: string[];
    useConfig?: boolean;
}
export interface RendererOptions {
    less?: Partial<Less.Options>;
    sass?: Partial<SassOptions<'sync'>>;
    stylus?: Partial<StylusRenderOptions>;
}
export interface Options {
    additionalData?: string;
    allowUnknownClassnames?: boolean;
    classnameTransform?: ClassnameTransformOptions;
    customMatcher?: string;
    customRenderer?: string;
    customTemplate?: string;
    dotenvOptions?: Omit<DotenvConfigOptions, 'path'> & {
        path?: string;
    };
    goToDefinition?: boolean;
    namedExports?: boolean;
    noUncheckedIndexedAccess?: boolean;
    postcssOptions?: PostcssOptions;
    /** @deprecated To align with naming in other projects. */
    postCssOptions?: PostcssOptions;
    rendererOptions?: RendererOptions;
    caching?: CachingOptions;
}
export type CachingOptions = 'always' | 'never';
export type ClassnameTransformOptions = 'asIs' | 'camelCase' | 'camelCaseOnly' | 'dashes' | 'dashesOnly';
export interface CustomRendererOptions {
    fileName: string;
    logger: Logger;
    compilerOptions: tsModule.CompilerOptions;
}
export type CustomRenderer = (css: string, options: CustomRendererOptions) => string | {
    css: string;
    sourceMap?: RawSourceMap;
};
export interface CustomTemplateOptions {
    classes: CSSExports;
    fileName: string;
    logger: Logger;
}
export type CustomTemplate = (dts: string, options: CustomTemplateOptions) => string;
export {};