cddl

CDDL AST Parser Documentation

This documentation describes the Abstract Syntax Tree (AST) generated by the CDDL (Concise Data Definition Language) parser in this project. The CDDL format is defined in the RFC 8610 specification.

Overview

The parser transforms CDDL files into an Abstract Syntax Tree (AST) representation that can be further processed to generate other formats like TypeScript type definitions. This documentation explains the structure of the AST and its components.

Documentation Structure

• AST Structure - Overview of the AST structure
• Basic Types - Core types in the AST
• Groups - Group definitions
• Arrays - Array definitions
• Variables - Variable assignments
• Properties - Property definitions
• Comments - Comment handling
• Ranges - Range representations
• Operators - Available operators
• References - Property reference types

Example Usage

import Parser from '../src/parser.js'

// Create a new parser instance with the path to a CDDL file
const parser = new Parser('./example.cddl')

// Parse the file and get the AST
const ast = parser.parse()

// Now you can work with the AST to generate other formats
console.log(JSON.stringify(ast, null, 2))

AST Format

The AST generated by the parser consists of a series of Assignment nodes, which can be one of:

• Group definitions
• Array definitions
• Variable assignments

Each of these contains properties and references that form a tree structure representing the CDDL document.

See the individual documentation files for detailed information on each component of the AST.

This site is open source. Improve this page.