Skip to main content

Crate oak_dockerfile

Crate oak_dockerfile 

Source
Expand description

ยง๐Ÿ› ๏ธ Developer Guide

Dockerfile support for the Oak language framework.

This directory contains the core logic implementation of the project. Below are instructions for a quick start.

ยง๐Ÿšฆ Quick Start

ยงCore API Usage

// Example: Basic calling workflow
fn main() {
    // 1. Initialization
    // 2. Execute core logic
    // 3. Handle returned results
}

ยง๐Ÿ” Module Description

  • lib.rs: Exports public interfaces and core traits.
  • parser/ (if exists): Implements specific syntax parsing logic.
  • ast/ (if exists): Defines the syntax tree structure.

ยง๐Ÿ—๏ธ Architecture Design

The project follows the general architectural specifications of the Oak ecosystem, emphasizing:

  1. Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
  2. Fault Tolerance: Core logic is highly inclusive of erroneous input.
  3. Scalability: Convenient for downstream tools to perform secondary development.

Re-exportsยง

pub use crate::ast::DockerfileRoot;
pub use crate::builder::DockerfileBuilder;
pub use crate::language::DockerfileLanguage;

Modulesยง

ast
Root node of the Dockerfile AST.
builder
Builder for the Dockerfile AST.
language
Language configuration for Dockerfile.
lsp
Dockerfile Lsp

Structsยง

DockerfileLexer
Lexer for Dockerfile files.
DockerfileParser
Parser for Dockerfile.

Enumsยง

DockerfileElementType
Element types for the Dockerfile parser.
DockerfileTokenType
Token types for the Dockerfile lexer.