---
url: /reference/packages/regex/src.md
---
# packages/regex/src

@cssdoc/regex

Type-safe, ArkRegex-based pattern library for cssdoc.
Centralizes CSS, grammar-driven, and cssdoc-specific regex patterns with modern named capture groups.

## Overview

This package provides a unified library of regex patterns used throughout cssdoc:

* **Tier 1 (W3C CSS)**: Standard CSS patterns from W3C formal grammar
  * Identifiers, keywords, colors, functions, properties, units
* **Tier 2 (CssDoc Grammar)**: Patterns from CssDoc.grammarkdown specification
  * Record names, modifiers, tags, structure references, cardinality
* **Tier 3 (cssdoc-Specific)**: Local implementation patterns
  * BEM conventions, ARIA attributes, configuration globbing

## Benefits

* **Type Safety**: All patterns use named capture groups with TypeScript inference
* **IDE Completion**: Auto-complete shows all available capture groups
* **Single Source of Truth**: Each pattern defined once, used everywhere
* **Maintainability**: Patterns traceable to specs and documentation
* **Security**: ArkRegex prevents ReDoS vulnerabilities
* **Zero Runtime Overhead**: Types-only, compile-time inference only

## Usage

```typescript
import { CssPatterns, CssDocPatterns, ModifierPatterns } from "@cssdoc/regex";

// Tier 1: W3C CSS patterns
const colorMatch = CssPatterns.CSS_HASH_COLOR.exec("#ffffff");
const color = colorMatch?.groups?.color; // "ffffff"

// Tier 2: Grammar patterns
const tagMatch = CssDocPatterns.CSSDOC_TAG.exec("@component");
const tag = tagMatch?.groups?.tag; // "component"

// Tier 3: cssdoc-specific patterns
const bemMatch = ModifierPatterns.BEM_MODIFIER.exec(".button--primary");
const { base, mod } = bemMatch?.groups ?? {}; // "button", "primary"
```

## Namespaces

* [CssDocGrammarPatterns](namespaces/CssDocGrammarPatterns/index.md)
* [CssdocLocalPatterns](namespaces/CssdocLocalPatterns/index.md)
* [CssSpecPatterns](namespaces/CssSpecPatterns/index.md)
* [regex](namespaces/regex/index.md)

## Interfaces

* [AttributeCapture](interfaces/AttributeCapture.md)
* [BemCapture](interfaces/BemCapture.md)
* [CardinalityCapture](interfaces/CardinalityCapture.md)
* [CombinatorCapture](interfaces/CombinatorCapture.md)
* [CssDimensionCapture](interfaces/CssDimensionCapture.md)
* [CssIdentifierCapture](interfaces/CssIdentifierCapture.md)
* [CssNumberCapture](interfaces/CssNumberCapture.md)
* [ModifierCapture](interfaces/ModifierCapture.md)
* [PseudoCapture](interfaces/PseudoCapture.md)
* [Regex](interfaces/Regex.md)
* [TagCapture](interfaces/TagCapture.md)

## Type Aliases

* [PatternTypes](type-aliases/PatternTypes.md)
* [regex](type-aliases/regex.md)

## Variables

* [regex](variables/regex.md)

## References

### ARIA_STATE

Re-exports [ARIA_STATE](namespaces/CssdocLocalPatterns/variables/ARIA_STATE.md)

***

### ATTRIBUTE_SELECTOR

Re-exports [ATTRIBUTE_SELECTOR](namespaces/CssdocLocalPatterns/variables/ATTRIBUTE_SELECTOR.md)

***

### BEM_BLOCK

Re-exports [BEM_BLOCK](namespaces/CssdocLocalPatterns/variables/BEM_BLOCK.md)

***

### BEM_ELEMENT

Re-exports [BEM_ELEMENT](namespaces/CssdocLocalPatterns/variables/BEM_ELEMENT.md)

***

### BEM_MODIFIER

Re-exports [BEM_MODIFIER](namespaces/CssdocLocalPatterns/variables/BEM_MODIFIER.md)

***

### CLASS_REF

Re-exports [CLASS_REF](namespaces/CssdocLocalPatterns/variables/CLASS_REF.md)

***

### COMBINATOR

Re-exports [COMBINATOR](namespaces/CssdocLocalPatterns/variables/COMBINATOR.md)

***

### CSS_DIMENSION

Re-exports [CSS_DIMENSION](namespaces/CssSpecPatterns/variables/CSS_DIMENSION.md)

***

### CSS_FUNCTION

Re-exports [CSS_FUNCTION](namespaces/CssSpecPatterns/variables/CSS_FUNCTION.md)

***

### CSS_HASH_COLOR

Re-exports [CSS_HASH_COLOR](namespaces/CssSpecPatterns/variables/CSS_HASH_COLOR.md)

***

### CSS_IDENTIFIER

Re-exports [CSS_IDENTIFIER](namespaces/CssSpecPatterns/variables/CSS_IDENTIFIER.md)

***

### CSS_KEYWORD

Re-exports [CSS_KEYWORD](namespaces/CssSpecPatterns/variables/CSS_KEYWORD.md)

***

### CSS_NAME

Re-exports [CSS_NAME](namespaces/CssSpecPatterns/variables/CSS_NAME.md)

***

### CSS_NUMBER

Re-exports [CSS_NUMBER](namespaces/CssSpecPatterns/variables/CSS_NUMBER.md)

***

### CSS_PERCENTAGE

Re-exports [CSS_PERCENTAGE](namespaces/CssSpecPatterns/variables/CSS_PERCENTAGE.md)

***

### CSS_PROPERTY_NAME

Re-exports [CSS_PROPERTY_NAME](namespaces/CssSpecPatterns/variables/CSS_PROPERTY_NAME.md)

***

### CSS_UNICODE_RANGE

Re-exports [CSS_UNICODE_RANGE](namespaces/CssSpecPatterns/variables/CSS_UNICODE_RANGE.md)

***

### CSSDOC_CARDINALITY

Re-exports [CSSDOC_CARDINALITY](namespaces/CssDocGrammarPatterns/variables/CSSDOC_CARDINALITY.md)

***

### CSSDOC_CUSTOM_PROPERTY

Re-exports [CSSDOC_CUSTOM_PROPERTY](namespaces/CssDocGrammarPatterns/variables/CSSDOC_CUSTOM_PROPERTY.md)

***

### CSSDOC_IDENTIFIER

Re-exports [CSSDOC_IDENTIFIER](namespaces/CssDocGrammarPatterns/variables/CSSDOC_IDENTIFIER.md)

***

### CSSDOC_INLINE_REF

Re-exports [CSSDOC_INLINE_REF](namespaces/CssDocGrammarPatterns/variables/CSSDOC_INLINE_REF.md)

***

### CSSDOC_MODIFIER_ATTRIBUTE

Re-exports [CSSDOC_MODIFIER_ATTRIBUTE](namespaces/CssDocGrammarPatterns/variables/CSSDOC_MODIFIER_ATTRIBUTE.md)

***

### CSSDOC_MODIFIER_CHAINED

Re-exports [CSSDOC_MODIFIER_CHAINED](namespaces/CssDocGrammarPatterns/variables/CSSDOC_MODIFIER_CHAINED.md)

***

### CSSDOC_MODIFIER_SUFFIX

Re-exports [CSSDOC_MODIFIER_SUFFIX](namespaces/CssDocGrammarPatterns/variables/CSSDOC_MODIFIER_SUFFIX.md)

***

### CSSDOC_RECORD_NAME

Re-exports [CSSDOC_RECORD_NAME](namespaces/CssDocGrammarPatterns/variables/CSSDOC_RECORD_NAME.md)

***

### CSSDOC_STRUCTURE_REF

Re-exports [CSSDOC_STRUCTURE_REF](namespaces/CssDocGrammarPatterns/variables/CSSDOC_STRUCTURE_REF.md)

***

### CSSDOC_TAG

Re-exports [CSSDOC_TAG](namespaces/CssDocGrammarPatterns/variables/CSSDOC_TAG.md)

***

### CSSDOC_TAG_ARG

Re-exports [CSSDOC_TAG_ARG](namespaces/CssDocGrammarPatterns/variables/CSSDOC_TAG_ARG.md)

***

### GLOB_PATTERN

Re-exports [GLOB_PATTERN](namespaces/CssdocLocalPatterns/variables/GLOB_PATTERN.md)

***

### MODIFIER_CHAIN

Re-exports [MODIFIER_CHAIN](namespaces/CssdocLocalPatterns/variables/MODIFIER_CHAIN.md)

***

### PSEUDO_CLASS

Re-exports [PSEUDO_CLASS](namespaces/CssdocLocalPatterns/variables/PSEUDO_CLASS.md)

***

### PSEUDO_ELEMENT

Re-exports [PSEUDO_ELEMENT](namespaces/CssdocLocalPatterns/variables/PSEUDO_ELEMENT.md)

***

### RSCSS_COMPONENT

Re-exports [RSCSS_COMPONENT](namespaces/CssdocLocalPatterns/variables/RSCSS_COMPONENT.md)

***

### RSCSS_ELEMENT

Re-exports [RSCSS_ELEMENT](namespaces/CssdocLocalPatterns/variables/RSCSS_ELEMENT.md)

***

### RSCSS_HELPER

Re-exports [RSCSS_HELPER](namespaces/CssdocLocalPatterns/variables/RSCSS_HELPER.md)

***

### RSCSS_VARIANT

Re-exports [RSCSS_VARIANT](namespaces/CssdocLocalPatterns/variables/RSCSS_VARIANT.md)

***

### SCOPE_PRELUDE_BASE

Re-exports [SCOPE_PRELUDE_BASE](namespaces/CssdocLocalPatterns/variables/SCOPE_PRELUDE_BASE.md)

***

### SINGLE_CLASS

Re-exports [SINGLE_CLASS](namespaces/CssdocLocalPatterns/variables/SINGLE_CLASS.md)

***

### VAR_REFERENCE

Re-exports [VAR_REFERENCE](namespaces/CssdocLocalPatterns/variables/VAR_REFERENCE.md)
