@adguard/aglint
Version:
Universal adblock filter list linter.
99 lines (98 loc) • 3.85 kB
TypeScript
/**
* @file Helper file for CSSTree to provide better compatibility with TypeScript.
*
* @see {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/62536}
*/
import { type Atrule as AtruleNode, type AtrulePrelude as AtrulePreludeNode, type Block as BlockNode, type CssLocation, type CssNodeCommon, type DeclarationList as DeclarationListNode, type Declaration as DeclarationNode, type MediaQueryList as MediaQueryListNode, type MediaQuery as MediaQueryNode, type Rule as RuleNode, type SelectorList as SelectorListNode, type Selector as SelectorNode, type StyleSheet as StyleSheetNode, type Value as ValueNode } from '@adguard/ecss-tree';
/**
* CSS tree node with location.
* Its just a small helper as in the AGLint context we always had the location.
*/
export type CssNodeWithLocation<T extends CssNodeCommon> = T & {
loc: CssLocation;
};
/**
* CSSTree node types.
*
* @see {@link https://github.com/csstree/csstree/blob/master/docs/ast.md#node-types}
*/
export declare enum CssTreeNodeType {
AnPlusB = "AnPlusB",
Atrule = "Atrule",
AtrulePrelude = "AtrulePrelude",
AttributeSelector = "AttributeSelector",
Block = "Block",
Brackets = "Brackets",
CDC = "CDC",
CDO = "CDO",
ClassSelector = "ClassSelector",
Combinator = "Combinator",
Comment = "Comment",
Declaration = "Declaration",
DeclarationList = "DeclarationList",
Dimension = "Dimension",
Function = "Function",
Hash = "Hash",
Identifier = "Identifier",
IdSelector = "IdSelector",
MediaFeature = "MediaFeature",
MediaQuery = "MediaQuery",
MediaQueryList = "MediaQueryList",
NestingSelector = "NestingSelector",
Nth = "Nth",
Number = "Number",
Operator = "Operator",
Parentheses = "Parentheses",
Percentage = "Percentage",
PseudoClassSelector = "PseudoClassSelector",
PseudoElementSelector = "PseudoElementSelector",
Ratio = "Ratio",
Raw = "Raw",
Rule = "Rule",
Selector = "Selector",
SelectorList = "SelectorList",
String = "String",
StyleSheet = "StyleSheet",
TypeSelector = "TypeSelector",
UnicodeRange = "UnicodeRange",
Url = "Url",
Value = "Value",
WhiteSpace = "WhiteSpace"
}
/**
* Parsing context for CSS tree.
*
* @see {@link https://github.com/csstree/csstree/blob/master/docs/parsing.md#context}
*/
export declare enum CssTreeParsingContext {
Stylesheet = "stylesheet",
Atrule = "atrule",
AtrulePrelude = "atrulePrelude",
MediaQueryList = "mediaQueryList",
MediaQuery = "mediaQuery",
Rule = "rule",
SelectorList = "selectorList",
Selector = "selector",
Block = "block",
DeclarationList = "declarationList",
Declaration = "declaration",
Value = "value"
}
/**
* Mapping of parsing context to CSS tree node.
* This helps us to provide better types for CSS node getters.
*/
export type CssTreeParsingContextToNode = {
[CssTreeParsingContext.Stylesheet]: CssNodeWithLocation<StyleSheetNode>;
[CssTreeParsingContext.Atrule]: CssNodeWithLocation<AtruleNode>;
[CssTreeParsingContext.AtrulePrelude]: CssNodeWithLocation<AtrulePreludeNode>;
[CssTreeParsingContext.MediaQueryList]: CssNodeWithLocation<MediaQueryListNode>;
[CssTreeParsingContext.MediaQuery]: CssNodeWithLocation<MediaQueryNode>;
[CssTreeParsingContext.Rule]: CssNodeWithLocation<RuleNode>;
[CssTreeParsingContext.SelectorList]: CssNodeWithLocation<SelectorListNode>;
[CssTreeParsingContext.Selector]: CssNodeWithLocation<SelectorNode>;
[CssTreeParsingContext.Block]: CssNodeWithLocation<BlockNode>;
[CssTreeParsingContext.DeclarationList]: CssNodeWithLocation<DeclarationListNode>;
[CssTreeParsingContext.Declaration]: CssNodeWithLocation<DeclarationNode>;
[CssTreeParsingContext.Value]: CssNodeWithLocation<ValueNode>;
};