postcss 8.3.9 → 8.4.31

package/lib/postcss.d.ts

@@ -1,168 +1,59 @@
-import { SourceMapGenerator, RawSourceMap } from 'source-map-js'
+import { RawSourceMap, SourceMapGenerator } from 'source-map-js'
 
+import AtRule, { AtRuleProps } from './at-rule.js'
+import Comment, { CommentProps } from './comment.js'
+import Container, { ContainerProps } from './container.js'
+import CssSyntaxError from './css-syntax-error.js'
+import Declaration, { DeclarationProps } from './declaration.js'
+import Document, { DocumentProps } from './document.js'
+import Input, { FilePosition } from './input.js'
+import LazyResult from './lazy-result.js'
+import list from './list.js'
 import Node, {
-  Position,
-  Source,
+  AnyNode,
   ChildNode,
+  ChildProps,
   NodeErrorOptions,
   NodeProps,
-  ChildProps,
-  AnyNode
+  Position,
+  Source
 } from './node.js'
-import Declaration, { DeclarationProps } from './declaration.js'
-import Root, { RootProps } from './root.js'
-import Document, { DocumentProps } from './document.js'
-import Comment, { CommentProps } from './comment.js'
-import AtRule, { AtRuleProps } from './at-rule.js'
+import Processor from './processor.js'
 import Result, { Message } from './result.js'
-import LazyResult from './lazy-result.js'
+import Root, { RootProps } from './root.js'
 import Rule, { RuleProps } from './rule.js'
-import Container, { ContainerProps } from './container.js'
 import Warning, { WarningOptions } from './warning.js'
-import Input, { FilePosition } from './input.js'
-import CssSyntaxError from './css-syntax-error.js'
-import list, { List } from './list.js'
-import Processor from './processor.js'
-
-export {
-  WarningOptions,
-  FilePosition,
-  Position,
-  Source,
-  ChildNode,
-  AnyNode,
-  Message,
-  NodeErrorOptions,
-  NodeProps,
-  DeclarationProps,
-  ContainerProps,
-  CommentProps,
-  RuleProps,
-  ChildProps,
-  AtRuleProps,
-  RootProps,
-  DocumentProps,
-  Warning,
-  CssSyntaxError,
-  Node,
-  Container,
-  list,
-  Declaration,
-  Comment,
-  AtRule,
-  Rule,
-  Root,
-  Document,
-  Result,
-  LazyResult,
-  Input
-}
-
-export type SourceMap = SourceMapGenerator & {
-  toJSON(): RawSourceMap
-}
-
-export type Helpers = { result: Result; postcss: Postcss } & Postcss
 
 type DocumentProcessor = (
   document: Document,
-  helper: Helpers
+  helper: postcss.Helpers
 ) => Promise<void> | void
-type RootProcessor = (root: Root, helper: Helpers) => Promise<void> | void
+type RootProcessor = (root: Root, helper: postcss.Helpers) => Promise<void> | void
 type DeclarationProcessor = (
   decl: Declaration,
-  helper: Helpers
+  helper: postcss.Helpers
 ) => Promise<void> | void
-type RuleProcessor = (rule: Rule, helper: Helpers) => Promise<void> | void
-type AtRuleProcessor = (atRule: AtRule, helper: Helpers) => Promise<void> | void
+type RuleProcessor = (rule: Rule, helper: postcss.Helpers) => Promise<void> | void
+type AtRuleProcessor = (atRule: AtRule, helper: postcss.Helpers) => Promise<void> | void
 type CommentProcessor = (
   comment: Comment,
-  helper: Helpers
+  helper: postcss.Helpers
 ) => Promise<void> | void
 
 interface Processors {
-  /**
-   * Will be called on `Document` node.
-   *
-   * Will be called again on children changes.
-   */
-  Document?: DocumentProcessor
-
-  /**
-   * Will be called on `Document` node, when all children will be processed.
-   *
-   * Will be called again on children changes.
-   */
-  DocumentExit?: DocumentProcessor
-
-  /**
-   * Will be called on `Root` node once.
-   */
-  Once?: RootProcessor
-
-  /**
-   * Will be called on `Root` node once, when all children will be processed.
-   */
-  OnceExit?: RootProcessor
-
-  /**
-   * Will be called on `Root` node.
-   *
-   * Will be called again on children changes.
-   */
-  Root?: RootProcessor
-
-  /**
-   * Will be called on `Root` node, when all children will be processed.
-   *
-   * Will be called again on children changes.
-   */
-  RootExit?: RootProcessor
-
-  /**
-   * Will be called on all `Declaration` nodes after listeners
-   * for `Declaration` event.
-   *
-   * Will be called again on node or children changes.
-   */
-  Declaration?: DeclarationProcessor | { [prop: string]: DeclarationProcessor }
-
-  /**
-   * Will be called on all `Declaration` nodes.
-   *
-   * Will be called again on node or children changes.
-   */
-  DeclarationExit?:
-    | DeclarationProcessor
-    | { [prop: string]: DeclarationProcessor }
-
-  /**
-   * Will be called on all `Rule` nodes.
-   *
-   * Will be called again on node or children changes.
-   */
-  Rule?: RuleProcessor
-
-  /**
-   * Will be called on all `Rule` nodes, when all children will be processed.
-   *
-   * Will be called again on node or children changes.
-   */
-  RuleExit?: RuleProcessor
-
   /**
    * Will be called on all`AtRule` nodes.
    *
    * Will be called again on node or children changes.
    */
-  AtRule?: AtRuleProcessor | { [name: string]: AtRuleProcessor }
+  AtRule?: { [name: string]: AtRuleProcessor } | AtRuleProcessor
 
   /**
    * Will be called on all `AtRule` nodes, when all children will be processed.
    *
    * Will be called again on node or children changes.
    */
-  AtRuleExit?: AtRuleProcessor | { [name: string]: AtRuleProcessor }
+  AtRuleExit?: { [name: string]: AtRuleProcessor } | AtRuleProcessor
 
   /**
    * Will be called on all `Comment` nodes.
@@ -180,192 +71,279 @@ interface Processors {
   CommentExit?: CommentProcessor
 
   /**
-   * Will be called when all other listeners processed the document.
+   * Will be called on all `Declaration` nodes after listeners
+   * for `Declaration` event.
    *
-   * This listener will not be called again.
-   */
-  Exit?: RootProcessor
-}
-
-export interface Plugin extends Processors {
-  postcssPlugin: string
-  prepare?: (result: Result) => Processors
-}
-
-export interface PluginCreator<PluginOptions> {
-  (opts?: PluginOptions): Plugin | Processor
-  postcss: true
-}
-
-export interface Transformer extends TransformCallback {
-  postcssPlugin: string
-  postcssVersion: string
-}
-
-export interface TransformCallback {
-  (root: Root, result: Result): Promise<void> | void
-}
-
-export interface OldPlugin<T> extends Transformer {
-  (opts?: T): Transformer
-  postcss: Transformer
-}
-
-export type AcceptedPlugin =
-  | Plugin
-  | PluginCreator<any>
-  | OldPlugin<any>
-  | TransformCallback
-  | {
-      postcss: TransformCallback | Processor
-    }
-  | Processor
-
-export interface Parser<RootNode = Root> {
-  (
-    css: string | { toString(): string },
-    opts?: Pick<ProcessOptions, 'map' | 'from'>
-  ): RootNode
-}
-
-export interface Builder {
-  (part: string, node?: AnyNode, type?: 'start' | 'end'): void
-}
-
-export interface Stringifier {
-  (node: AnyNode, builder: Builder): void
-}
-
-export interface JSONHydrator {
-  (data: object[]): Node[]
-  (data: object): Node
-}
-
-export interface Syntax {
-  /**
-   * Function to generate AST by string.
-   */
-  parse?: Parser<Root | Document>
-
-  /**
-   * Class to generate string by AST.
+   * Will be called again on node or children changes.
    */
-  stringify?: Stringifier
-}
+  Declaration?: { [prop: string]: DeclarationProcessor } | DeclarationProcessor
 
-export interface SourceMapOptions {
   /**
-   * Indicates that the source map should be embedded in the output CSS
-   * as a Base64-encoded comment. By default, it is `true`.
-   * But if all previous maps are external, not inline, PostCSS will not embed
-   * the map even if you do not set this option.
+   * Will be called on all `Declaration` nodes.
    *
-   * If you have an inline source map, the result.map property will be empty,
-   * as the source map will be contained within the text of `result.css`.
+   * Will be called again on node or children changes.
    */
-  inline?: boolean
+  DeclarationExit?:
+    | { [prop: string]: DeclarationProcessor }
+    | DeclarationProcessor
 
   /**
-   * Source map content from a previous processing step (e.g., Sass).
-   *
-   * PostCSS will try to read the previous source map
-   * automatically (based on comments within the source CSS), but you can use
-   * this option to identify it manually.
+   * Will be called on `Document` node.
    *
-   * If desired, you can omit the previous map with prev: `false`.
-   */
-  prev?: string | boolean | object | ((file: string) => string)
-
-  /**
-   * Indicates that PostCSS should set the origin content (e.g., Sass source)
-   * of the source map. By default, it is true. But if all previous maps do not
-   * contain sources content, PostCSS will also leave it out even if you
-   * do not set this option.
+   * Will be called again on children changes.
    */
-  sourcesContent?: boolean
+  Document?: DocumentProcessor
 
   /**
-   * Indicates that PostCSS should add annotation comments to the CSS.
-   * By default, PostCSS will always add a comment with a path
-   * to the source map. PostCSS will not add annotations to CSS files
-   * that do not contain any comments.
-   *
-   * By default, PostCSS presumes that you want to save the source map as
-   * `opts.to + '.map'` and will use this path in the annotation comment.
-   * A different path can be set by providing a string value for annotation.
+   * Will be called on `Document` node, when all children will be processed.
    *
-   * If you have set `inline: true`, annotation cannot be disabled.
-   */
-  annotation?: string | boolean | ((file: string, root: Root) => string)
-
-  /**
-   * Override `from` in map’s sources.
-   */
-  from?: string
-
-  /**
-   * Use absolute path in generated source map.
+   * Will be called again on children changes.
    */
-  absolute?: boolean
-}
+  DocumentExit?: DocumentProcessor
 
-export interface ProcessOptions {
   /**
-   * The path of the CSS source file. You should always set `from`,
-   * because it is used in source map generation and syntax error messages.
+   * Will be called on `Root` node once.
    */
-  from?: string
+  Once?: RootProcessor
 
   /**
-   * The path where you'll put the output CSS file. You should always set `to`
-   * to generate correct source maps.
+   * Will be called on `Root` node once, when all children will be processed.
    */
-  to?: string
+  OnceExit?: RootProcessor
 
   /**
-   * Function to generate AST by string.
+   * Will be called on `Root` node.
+   *
+   * Will be called again on children changes.
    */
-  parser?: Syntax | Parser
+  Root?: RootProcessor
 
   /**
-   * Class to generate string by AST.
+   * Will be called on `Root` node, when all children will be processed.
+   *
+   * Will be called again on children changes.
    */
-  stringifier?: Syntax | Stringifier
+  RootExit?: RootProcessor
 
   /**
-   * Object with parse and stringify.
+   * Will be called on all `Rule` nodes.
+   *
+   * Will be called again on node or children changes.
    */
-  syntax?: Syntax
+  Rule?: RuleProcessor
 
   /**
-   * Source map options
+   * Will be called on all `Rule` nodes, when all children will be processed.
+   *
+   * Will be called again on node or children changes.
    */
-  map?: SourceMapOptions | boolean
+  RuleExit?: RuleProcessor
 }
 
-export interface Postcss {
-  /**
-   * Create a new `Processor` instance that will apply `plugins`
-   * as CSS processors.
-   *
-   * ```js
-   * let postcss = require('postcss')
-   *
-   * postcss(plugins).process(css, { from, to }).then(result => {
-   *   console.log(result.css)
-   * })
-   * ```
-   *
-   * @param plugins PostCSS plugins.
-   * @return Processor to process multiple CSS.
-   */
-  (plugins?: AcceptedPlugin[]): Processor
-  (...plugins: AcceptedPlugin[]): Processor
+declare namespace postcss {
+  export {
+    AnyNode,
+    AtRule,
+    AtRuleProps,
+    ChildNode,
+    ChildProps,
+    Comment,
+    CommentProps,
+    Container,
+    ContainerProps,
+    CssSyntaxError,
+    Declaration,
+    DeclarationProps,
+    Document,
+    DocumentProps,
+    FilePosition,
+    Input,
+    LazyResult,
+    list,
+    Message,
+    Node,
+    NodeErrorOptions,
+    NodeProps,
+    Position,
+    Processor,
+    Result,
+    Root,
+    RootProps,
+    Rule,
+    RuleProps,
+    Source,
+    Warning,
+    WarningOptions
+  }
+
+  export type SourceMap = SourceMapGenerator & {
+    toJSON(): RawSourceMap
+  }
+
+  export type Helpers = { postcss: Postcss; result: Result } & Postcss
+
+  export interface Plugin extends Processors {
+    postcssPlugin: string
+    prepare?: (result: Result) => Processors
+  }
+
+  export interface PluginCreator<PluginOptions> {
+    (opts?: PluginOptions): Plugin | Processor
+    postcss: true
+  }
+
+  export interface Transformer extends TransformCallback {
+    postcssPlugin: string
+    postcssVersion: string
+  }
+
+  export interface TransformCallback {
+    (root: Root, result: Result): Promise<void> | void
+  }
+
+  export interface OldPlugin<T> extends Transformer {
+    (opts?: T): Transformer
+    postcss: Transformer
+  }
+
+  export type AcceptedPlugin =
+    | {
+        postcss: Processor | TransformCallback
+      }
+    | OldPlugin<any>
+    | Plugin
+    | PluginCreator<any>
+    | Processor
+    | TransformCallback
+
+  export interface Parser<RootNode = Document | Root> {
+    (
+      css: { toString(): string } | string,
+      opts?: Pick<ProcessOptions, 'from' | 'map'>
+    ): RootNode
+  }
+
+  export interface Builder {
+    (part: string, node?: AnyNode, type?: 'end' | 'start'): void
+  }
+
+  export interface Stringifier {
+    (node: AnyNode, builder: Builder): void
+  }
+
+  export interface JSONHydrator {
+    (data: object): Node
+    (data: object[]): Node[]
+  }
+
+  export interface Syntax<RootNode = Document | Root> {
+    /**
+     * Function to generate AST by string.
+     */
+    parse?: Parser<RootNode>
+
+    /**
+     * Class to generate string by AST.
+     */
+    stringify?: Stringifier
+  }
+
+  export interface SourceMapOptions {
+    /**
+     * Use absolute path in generated source map.
+     */
+    absolute?: boolean
+
+    /**
+     * Indicates that PostCSS should add annotation comments to the CSS.
+     * By default, PostCSS will always add a comment with a path
+     * to the source map. PostCSS will not add annotations to CSS files
+     * that do not contain any comments.
+     *
+     * By default, PostCSS presumes that you want to save the source map as
+     * `opts.to + '.map'` and will use this path in the annotation comment.
+     * A different path can be set by providing a string value for annotation.
+     *
+     * If you have set `inline: true`, annotation cannot be disabled.
+     */
+    annotation?: ((file: string, root: Root) => string) | boolean | string
+
+    /**
+     * Override `from` in map’s sources.
+     */
+    from?: string
+
+    /**
+     * Indicates that the source map should be embedded in the output CSS
+     * as a Base64-encoded comment. By default, it is `true`.
+     * But if all previous maps are external, not inline, PostCSS will not embed
+     * the map even if you do not set this option.
+     *
+     * If you have an inline source map, the result.map property will be empty,
+     * as the source map will be contained within the text of `result.css`.
+     */
+    inline?: boolean
+
+    /**
+     * Source map content from a previous processing step (e.g., Sass).
+     *
+     * PostCSS will try to read the previous source map
+     * automatically (based on comments within the source CSS), but you can use
+     * this option to identify it manually.
+     *
+     * If desired, you can omit the previous map with prev: `false`.
+     */
+    prev?: ((file: string) => string) | boolean | object | string
+
+    /**
+     * Indicates that PostCSS should set the origin content (e.g., Sass source)
+     * of the source map. By default, it is true. But if all previous maps do not
+     * contain sources content, PostCSS will also leave it out even if you
+     * do not set this option.
+     */
+    sourcesContent?: boolean
+  }
+
+  export interface ProcessOptions<RootNode = Document | Root> {
+    /**
+     * The path of the CSS source file. You should always set `from`,
+     * because it is used in source map generation and syntax error messages.
+     */
+    from?: string
+
+    /**
+     * Source map options
+     */
+    map?: boolean | SourceMapOptions
+
+    /**
+     * Function to generate AST by string.
+     */
+    parser?: Parser<RootNode> | Syntax<RootNode>
+
+    /**
+     * Class to generate string by AST.
+     */
+    stringifier?: Stringifier | Syntax<RootNode>
+
+    /**
+     * Object with parse and stringify.
+     */
+    syntax?: Syntax<RootNode>
+
+    /**
+     * The path where you'll put the output CSS file. You should always set `to`
+     * to generate correct source maps.
+     */
+    to?: string
+  }
+
+  export type Postcss = typeof postcss
 
   /**
    * Default function to convert a node tree into a CSS string.
    */
-  stringify: Stringifier
+  export let stringify: Stringifier
 
   /**
    * Parses source css and returns a new `Root` or `Document` node,
@@ -378,7 +356,7 @@ export interface Postcss {
    * root1.append(root2).toResult().css
    * ```
    */
-  parse: Parser
+  export let parse: Parser<Root>
 
   /**
    * Rehydrate a JSON AST (from `Node#toJSON`) back into the AST classes.
@@ -389,12 +367,7 @@ export interface Postcss {
    * const root2  = postcss.fromJSON(json)
    * ```
    */
-  fromJSON: JSONHydrator
-
-  /**
-   * Contains the `list` module.
-   */
-  list: List
+  export let fromJSON: JSONHydrator
 
   /**
    * Creates a new `Comment` node.
@@ -402,7 +375,7 @@ export interface Postcss {
    * @param defaults Properties for the new node.
    * @return New comment node
    */
-  comment(defaults?: CommentProps): Comment
+  export function comment(defaults?: CommentProps): Comment
 
   /**
    * Creates a new `AtRule` node.
@@ -410,7 +383,7 @@ export interface Postcss {
    * @param defaults Properties for the new node.
    * @return New at-rule node.
    */
-  atRule(defaults?: AtRuleProps): AtRule
+  export function atRule(defaults?: AtRuleProps): AtRule
 
   /**
    * Creates a new `Declaration` node.
@@ -418,7 +391,7 @@ export interface Postcss {
    * @param defaults Properties for the new node.
    * @return New declaration node.
    */
-  decl(defaults?: DeclarationProps): Declaration
+  export function decl(defaults?: DeclarationProps): Declaration
 
   /**
    * Creates a new `Rule` node.
@@ -426,7 +399,7 @@ export interface Postcss {
    * @param default Properties for the new node.
    * @return New rule node.
    */
-  rule(defaults?: RuleProps): Rule
+  export function rule(defaults?: RuleProps): Rule
 
   /**
    * Creates a new `Root` node.
@@ -434,7 +407,7 @@ export interface Postcss {
    * @param defaults Properties for the new node.
    * @return New root node.
    */
-  root(defaults?: RootProps): Root
+  export function root(defaults?: RootProps): Root
 
   /**
    * Creates a new `Document` node.
@@ -442,31 +415,27 @@ export interface Postcss {
    * @param defaults Properties for the new node.
    * @return New document node.
    */
-  document(defaults?: DocumentProps): Document
-
-  CssSyntaxError: typeof CssSyntaxError
-  Declaration: typeof Declaration
-  Container: typeof Container
-  Comment: typeof Comment
-  Warning: typeof Warning
-  AtRule: typeof AtRule
-  Result: typeof Result
-  Input: typeof Input
-  Rule: typeof Rule
-  Root: typeof Root
-  Node: typeof Node
-}
-
-export const stringify: Stringifier
-export const parse: Parser
-export const fromJSON: JSONHydrator
+  export function document(defaults?: DocumentProps): Document
 
-export const comment: Postcss['comment']
-export const atRule: Postcss['atRule']
-export const decl: Postcss['decl']
-export const rule: Postcss['rule']
-export const root: Postcss['root']
-
-declare const postcss: Postcss
+  export { postcss as default }
+}
 
-export default postcss
+/**
+ * Create a new `Processor` instance that will apply `plugins`
+ * as CSS processors.
+ *
+ * ```js
+ * let postcss = require('postcss')
+ *
+ * postcss(plugins).process(css, { from, to }).then(result => {
+ *   console.log(result.css)
+ * })
+ * ```
+ *
+ * @param plugins PostCSS plugins.
+ * @return Processor to process multiple CSS.
+ */
+declare function postcss(plugins?: postcss.AcceptedPlugin[]): Processor
+declare function postcss(...plugins: postcss.AcceptedPlugin[]): Processor
+
+export = postcss