@fullhuman/postcss-purgecss

  • Version 6.0.0
  • Published
  • 12.6 kB
  • 1 dependency
  • MIT license

Install

npm i @fullhuman/postcss-purgecss
yarn add @fullhuman/postcss-purgecss
pnpm add @fullhuman/postcss-purgecss

Overview

PostCSS Plugin for PurgeCSS

Most bundlers and frameworks to build websites are using PostCSS. The easiest way to configure PurgeCSS is with its PostCSS plugin.

Index

Variables

variable purgeCSSPlugin

const purgeCSSPlugin: postcss.PluginCreator<UserDefinedOptions>;
  • PostCSS Plugin for PurgeCSS

    Parameter opts

    PurgeCSS Options

    Returns

    the postCSS plugin

    Modifiers

    • @public

Interfaces

interface ExtractorResultDetailed

interface ExtractorResultDetailed {}
  • Modifiers

    • @public

property attributes

attributes: {
names: string[];
values: string[];
};

    property classes

    classes: string[];

      property ids

      ids: string[];

        property tags

        tags: string[];

          property undetermined

          undetermined: string[];

            interface Extractors

            interface Extractors {}
            • Modifiers

              • @public

            property extensions

            extensions: string[];

              property extractor

              extractor: ExtractorFunction;

                interface PurgeCSSUserDefinedOptions

                interface PurgeCSSUserDefinedOptions {}
                • Options used by PurgeCSS to remove unused CSS

                  Modifiers

                  • @public

                property blocklist

                blocklist?: StringRegExpArray;

                property content

                content: Array<string | RawContent>;

                property css

                css: Array<string | RawCSS>;

                property defaultExtractor

                defaultExtractor?: ExtractorFunction;

                property dynamicAttributes

                dynamicAttributes?: string[];

                property extractors

                extractors?: Array<Extractors>;

                property fontFace

                fontFace?: boolean;

                property keyframes

                keyframes?: boolean;

                property output

                output?: string;

                property rejected

                rejected?: boolean;

                property rejectedCss

                rejectedCss?: boolean;

                property safelist

                safelist?: UserDefinedSafelist;

                property skippedContentGlobs

                skippedContentGlobs?: Array<string>;

                property sourceMap

                sourceMap?: boolean | (postcss.SourceMapOptions & { to?: string });

                property stdin

                stdin?: boolean;

                property stdout

                stdout?: boolean;

                property variables

                variables?: boolean;

                interface RawContent

                interface RawContent<T = string> {}
                • Modifiers

                  • @public

                property extension

                extension: string;

                  property raw

                  raw: T;

                    interface RawCSS

                    interface RawCSS {}
                    • Modifiers

                      • @public

                    property name

                    name?: string;

                      property raw

                      raw: string;

                        interface UserDefinedOptions

                        interface UserDefinedOptions
                        extends Omit<PurgeCSSUserDefinedOptions, 'content' | 'css'> {}

                        property content

                        content?: PurgeCSSUserDefinedOptions['content'];

                          property contentFunction

                          contentFunction?: (sourceFile: string) => Array<string | RawContent>;

                            Type Aliases

                            type ComplexSafelist

                            type ComplexSafelist = {
                            standard?: StringRegExpArray;
                            /**
                            * You can safelist selectors and their children based on a regular
                            * expression with `safelist.deep`
                            *
                            * @example
                            *
                            * ```ts
                            * const purgecss = await new PurgeCSS().purge({
                            * content: [],
                            * css: [],
                            * safelist: {
                            * deep: [/red$/]
                            * }
                            * })
                            * ```
                            *
                            * In this example, selectors such as `.bg-red .child-of-bg` will be left
                            * in the final CSS, even if `child-of-bg` is not found.
                            *
                            */
                            deep?: RegExp[];
                            greedy?: RegExp[];
                            variables?: StringRegExpArray;
                            keyframes?: StringRegExpArray;
                            };
                            • Modifiers

                              • @public

                            type ExtractorFunction

                            type ExtractorFunction<T = string> = (content: T) => ExtractorResult;
                            • Modifiers

                              • @public

                            type ExtractorResult

                            type ExtractorResult = ExtractorResultDetailed | string[];
                            • Modifiers

                              • @public

                            type StringRegExpArray

                            type StringRegExpArray = Array<RegExp | string>;
                            • Modifiers

                              • @public

                            type UserDefinedSafelist

                            type UserDefinedSafelist = StringRegExpArray | ComplexSafelist;
                            • Modifiers

                              • @public

                            Package Files (1)

                            Dependencies (1)

                            Dev Dependencies (1)

                            Peer Dependencies (1)

                            Badge

                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@fullhuman/postcss-purgecss.

                            • Markdown
                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@fullhuman/postcss-purgecss)
                            • HTML
                              <a href="https://www.jsdocs.io/package/@fullhuman/postcss-purgecss"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>