Search

Search something to see results

BenchmarkDocsPlaygroundGitHub

TransformOptions

Transform options

interface TransformOptions {
    beautify?: boolean;
    computeCalcExpression?: boolean;
    computeShorthand?: boolean;
    computeTransform?: boolean;
    convertColor?: any;
    cwd?: string;
    expandIfSyntax?: boolean;
    expandNestingRules?: boolean;
    indent?: string;
    inlineCssVariables?: boolean;
    lenient?: boolean;
    load?: (
        url: string | { absolute: string; relative: string },
        currentDirectory: string,
        responseType?: boolean | ResponseType,
    ) => Promise<
        string
        | ArrayBuffer
        | ReadableStream<Uint8Array<ArrayBufferLike>>,
    >;
    minify?: boolean;
    module?:
        | boolean
        | ModuleCaseTransformEnum
        | ModuleScopeEnumOptions
        | ModuleOptions;
    nestingRules?: boolean;
    newLine?: string;
    output?: string;
    parseColor?: boolean;
    pass?: number;
    preserveLicense?: boolean;
    removeCharset?: boolean;
    removeComments?: boolean;
    removeDuplicateDeclarations?: string
    | boolean
    | string[];
    removeEmpty?: boolean;
    removePrefix?: boolean;
    resolve?: (
        url: string,
        currentUrl: string,
        currentWorkingDirectory?: string,
    ) => { absolute: string; relative: string };
    resolveImport?: boolean;
    resolveUrls?: boolean;
    signal?: AbortSignal;
    sourcemap?: boolean | "inline";
    src?: string;
    validation?: boolean | ValidationLevel;
    visitor?: VisitorNodeMap | VisitorNodeMap[];
    withParents?: boolean;
}

Hierarchy (View Summary)

Index

Properties

node.TransformOptions.beautifynode.TransformOptions.computeCalcExpressionnode.TransformOptions.computeShorthandnode.TransformOptions.computeTransformnode.TransformOptions.convertColornode.TransformOptions.cwdnode.TransformOptions.expandIfSyntaxnode.TransformOptions.expandNestingRulesnode.TransformOptions.indentnode.TransformOptions.inlineCssVariablesnode.TransformOptions.lenientnode.TransformOptions.loadnode.TransformOptions.minifynode.TransformOptions.modulenode.TransformOptions.nestingRulesnode.TransformOptions.newLinenode.TransformOptions.outputnode.TransformOptions.parseColornode.TransformOptions.passnode.TransformOptions.preserveLicensenode.TransformOptions.removeCharsetnode.TransformOptions.removeCommentsnode.TransformOptions.removeDuplicateDeclarationsnode.TransformOptions.removeEmptynode.TransformOptions.removePrefixnode.TransformOptions.resolvenode.TransformOptions.resolveImportnode.TransformOptions.resolveUrlsnode.TransformOptions.signalnode.TransformOptions.sourcemapnode.TransformOptions.srcnode.TransformOptions.validationnode.TransformOptions.visitornode.TransformOptions.withParents
beautify?: boolean

Pretty print css

const result = await transform(css, {beautify: true});
computeCalcExpression?: boolean

Compute css math functions

computeShorthand?: boolean

Compute shorthand properties

computeTransform?: boolean

Compute css transform functions

convertColor?: any

Convert color to the specified color space. 'true' will convert to HEX

cwd?: string

Current working directory

expandIfSyntax?: boolean

Experimental, convert css if() function into legacy syntax.

expandNestingRules?: boolean

Expand nested rules

indent?: string

Indention string

inlineCssVariables?: boolean

Inline css variables

lenient?: boolean

Lenient validation. retain nodes that failed validation

load?: (
    url: string | { absolute: string; relative: string },
    currentDirectory: string,
    responseType?: boolean | ResponseType,
) => Promise<
    string
    | ArrayBuffer
    | ReadableStream<Uint8Array<ArrayBufferLike>>,
>

Custom URL and file loader.

minify?: boolean

Enable minification

module?:
    | boolean
    | ModuleCaseTransformEnum
    | ModuleScopeEnumOptions
    | ModuleOptions

CSS modules options

nestingRules?: boolean

Generate nested rules

newLine?: string

New line string

output?: string

Output file. Used for url resolution

parseColor?: boolean

Parse color tokens

pass?: number

Define minification passes.

preserveLicense?: boolean

Preserve license comments. License comments are comments that start with '/*!'

removeCharset?: boolean

Remove at-rule charset

removeComments?: boolean

Remove comments

removeDuplicateDeclarations?: string | boolean | string[]

Remove duplicate declarations from the same rule. if passed as a string array, duplicated declarations are removed, except for those in the array


import {transform} from '@tbela99/css-parser';

const css = `

.table {

    width: 100%;
    width: calc(100% + 40px);
    margin-left: 20px;
    margin-left: min(100% , 20px)
}

`;
const result = await transform(css, {

    beautify: true,
    validation: true,
    removeDuplicateDeclarations: ['width']
}
);

console.log(result.code);
removeEmpty?: boolean

Remove empty ast nodes

removePrefix?: boolean

Remove css prefix

resolve?: (
    url: string,
    currentUrl: string,
    currentWorkingDirectory?: string,
) => { absolute: string; relative: string }

Url and path resolver

resolveImport?: boolean

Resolve import

resolveUrls?: boolean

Resolve urls

signal?: AbortSignal

Abort signal

Example: abort after 10 seconds


const result = await parse(cssString, {
    signal: AbortSignal.timeout(10000)
});
sourcemap?: boolean | "inline"

Include sourcemap in the ast. Sourcemap info is always generated

src?: string

Source file to be used for sourcemap

validation?: boolean | ValidationLevel

Enable CSS validation. Using ValidationLevel as value is deprecated and will be removed

see ValidationLevel

visitor?: VisitorNodeMap | VisitorNodeMap[]

Node visitor VisitorNodeMap[]

withParents?: boolean

Render the node along with its parents